163 DBMS_XDBRESOURCE

Using DBMS_XDBRESOURCE

• Overview

---

Overview

The DBMS_XDBRESOURCE package provides routines to get and set the resource's metadata and contents. To take advantage of the DOM traversal facility, provided in DBMS_XMLDOM package, an XDBResource instance could be converted to a DOMDocument type by using DBMS_XDBRESOURCE.MAKEDOCUMENT routine.

Summary of DBMS_XDBRESOURCE Subprograms

---

FREERESOURCE Procedure

This procedure frees any memory associated with an XDBResource.

Syntax

DBMS_XDBRESEROUCE.FREERESOURCE (
   res   IN    XDBResource) 
 RETURN VARCHAR2;

Parameters

---

GETACL Function

Given an XDBResource, this function returns its ACL as string.

Syntax

DBMS_XDBRESEROUCE.GETACL (
   res   IN    XDBResource) 
 RETURN VARCHAR2;

Parameters

---

GETACLDOCFROMRES Function

This function returns the ACL Document for the given resource as XMLType.

Syntax

DBMS_XDBRESEROUCE.GETACLDOCFROMRES (
   res   IN    XDBResource) 
 RETURN SYS.XMLTYPE;

Parameters

---

GETAUTHOR Function

Given an XDBResource, this function returns its author.

Syntax

DBMS_XDBRESEROUCE.GETAUTHOR (
   res   IN    XDBResource) 
 RETURN VARCHAR2;

Parameters

---

GETCHARACTERSET Function

Given an XDBResource, this function returns its characterset.

Syntax

DBMS_XDBRESEROUCE.GETCHARACTERSET (
   res   IN    XDBResource) 
 RETURN VARCHAR2;

Parameters

---

GETCOMMENT Function

Given an XDBResource, this function returns its comment.

Syntax

DBMS_XDBRESEROUCE.GETCOMMENT (
   res   IN    XDBResource) 
 RETURN VARCHAR2;

Parameters

---

GETCONTENTBLOB Function

This function returns the contents of the resource as a BLOB.

Syntax

DBMS_XDBRESEROUCE.GETCONTENTBLOB (
   res    IN     XDBResource,
   csid   OUT    PLS_INTEGER) 
 RETURN BLOB;

Parameters

---

GETCONTENTCLOB Function

This function returns the contents of the resource as a CLOB.

Syntax

DBMS_XDBRESEROUCE.GETCONTENTCLOB (
   res   IN    XDBResource) 
 RETURN CLOB;

Parameters

---

GETCONTENTREF Function

This function returns the contents of the resource as an XMLTypeRef.

Syntax

DBMS_XDBRESEROUCE.GETCONTENTREF (
   res   IN    XDBResource) 
 RETURN VARCHAR2;

Parameters

---

GETCONTENTTYPE Function

Given an XDBResource, this function returns its content-type.

Syntax

DBMS_XDBRESEROUCE.GETCONTENTTYPE (
   res   IN    XDBResource) 
 RETURN VARCHAR2;

Parameters

---

GETCONTENTXML Function

This function returns the contents of the resource as an XMLTypeRef.

Syntax

DBMS_XDBRESEROUCE.GETCONTENTXML (
   res   IN    XDBResource) 
 RETURN XMLType;

Parameters

---

GETCONTENTVARCHAR2 Function

This function returns the contents of the resource as a string.

Syntax

DBMS_XDBRESEROUCE.GETCONTENTVARCHAR2 (
   res   IN    XDBResource) 
 RETURN VARCHAR2;

Parameters

---

GETCREATIONDATE Function

Given an XDBResource, this function returns its creation date.

Syntax

DBMS_XDBRESEROUCE.GETCREATIONDATE (
   res   IN    XDBResource) 
 RETURN TIMESTAMP;

Parameters

---

GETCREATOR Function

Given an XDBResource, this function returns its creator.

Syntax

DBMS_XDBRESEROUCE.GETCREATOR (
   res   IN    XDBResource) 
 RETURN VARCHAR2;

Parameters

---

GETCUSTOMMETADATA Function

This function returns the requested custom metadata given the xpath and namespace to the metadata.

Syntax

DBMS_XDBRESEROUCE.GETCUSTOMMETADATA (
   res        IN    XDBResource, 
   xpath      IN    VARCHAR2,    namespace  IN    VARCHAR2)
 RETURN XMLType;

Parameters

Usage Notes

The first component of the XPath expression must be "Resource".

---

GETDISPLAYNAME Function

Given an XDBResource, this function returns its display name.

Syntax

DBMS_XDBRESEROUCE.GETDISPLAYNAME (
   res   IN    XDBResource) 
 RETURN VARCHAR2;

Parameters

---

GETLANGUAGE Function

Given an XDBResource, this function returns its language.

Syntax

DBMS_XDBRESEROUCE.GETLANGUAGE (
   res   IN    XDBResource) 
 RETURN VARCHAR2;

Parameters

---

GETLASTMODIFIER Function

Given an XDBResource, this function returns its last modifier.

Syntax

DBMS_XDBRESEROUCE.GETLASTMODIFIER (
   res   IN    XDBResource) 
 RETURN VARCHAR2;

Parameters

---

GETMODIFICATIONDATE Function

Given an XDBResource, this function returns its modification date.

Syntax

DBMS_XDBRESEROUCE.GETMODIFICATIONDATE (
   res   IN    XDBResource) 
 RETURN TIMESTAMP;

Parameters

---

GETOWNER Function

Given an XDBResource, this function returns its owner.

Syntax

DBMS_XDBRESEROUCE.GETOWNER (
   res   IN    XDBResource) 
 RETURN VARCHAR2;

Parameters

---

GETREFCOUNT Function

Given an XDBResource, this function returns its reference count.

Syntax

DBMS_XDBRESEROUCE.GETREFCOUNT (
   res   IN    XDBResource) 
 RETURN PLS_INTEGER;

Parameters

---

GETVERSIONID Function

Given an XDBResource, this function returns its version ID.

Syntax

DBMS_XDBRESEROUCE.GETVERSIONID (
   res   IN    XDBResource) 
 RETURN PLS_INTEGER;

Parameters

---

HASACLCHANGED Function

This function returns TRUE if the ACL of the given resource has changed, FALSE otherwise.

Syntax

DBMS_XDBRESEROUCE.HASACLCHANGED (
   res   IN    XDBResource) 
 RETURN BOOLEAN;

Parameters

---

HASAUTHORCHANGED Function

This function returns TRUE if the author of the given resource has changed, FALSE otherwise.

Syntax

DBMS_XDBRESEROUCE.HASAUTHORCHANGED (
   res   IN    XDBResource) 
 RETURN BOOLEAN;

Parameters

---

HASCHANGED Function

Given an XPath, this function determines whether the element or attribute represented by the XPath has changed.

Syntax

DBMS_XDBRESEROUCE.HASCHANGED (
   res         IN    XDBResource, 
   xpath       IN    VARCHAR2,
   namespace   IN    VARCHAR2) 
 RETURN BOOLEAN;

Parameters

---

HASCHARACTERSETCHANGED Function

This function returns TRUE if the character set of the given resource has changed, FALSE otherwise.

Syntax

DBMS_XDBRESEROUCE.HASCHARACTERSETCHANGED (
   res   IN    XDBResource) 
 RETURN BOOLEAN;

Parameters

---

HASCOMMENTCHANGED Function

This function returns TRUE if the comment of the given resource has changed, FALSE otherwise.

Syntax

DBMS_XDBRESEROUCE.HASCOMMENTCHANGED (
   res   IN    XDBResource) 
 RETURN BOOLEAN;

Parameters

---

HASCONTENTCHANGED Function

This function returns TRUE if the contents of the given resource has changed, FALSE otherwise.

Syntax

DBMS_XDBRESEROUCE.HASCONTENTCHANGED (
   res   IN    XDBResource) 
 RETURN BOOLEAN;

Parameters

---

HASCONTENTTYPECHANGED Function

This function returns TRUE if the content-type of the given resource has changed, FALSE otherwise

Syntax

DBMS_XDBRESEROUCE.HASCONTENTTYPECHANGED (
   res   IN    XDBResource) 
 RETURN BOOLEAN;

Parameters

---

HASCREATIONDATECHANGED Function

This function returns TRUE if the creation date of the given resource has changed, FALSE otherwise

Syntax

DBMS_XDBRESEROUCE.HASCREATIONDATECHANGED (
   res   IN    XDBResource) 
 RETURN BOOLEAN;

Parameters

---

HASCREATORCHANGED Function

This function returns TRUE if the creator of the given resource has changed, FALSE otherwise

Syntax

DBMS_XDBRESEROUCE.HASCREATORCHANGED (
   res   IN    XDBResource) 
 RETURN BOOLEAN;

Parameters

---

HASCUSTOMMETADATACHANGED Function

This function checks whether the custom-metadata for a given resource has changed.

Syntax

DBMS_XDBRESEROUCE.HASCUSTOMMETADATACHANGED (
   res   IN    XDBResource) 
 RETURN BOOLEAN;

Parameters

---

HASDISPLAYNAMECHANGED Function

This function returns TRUE if the display name of the given resource has changed, FALSE otherwise

Syntax

DBMS_XDBRESEROUCE.HASDISPLAYNAMECHANGED (
   res   IN    XDBResource) 
 RETURN BOOLEAN;

Parameters

---

HASLANGUAGECHANGED Function

This function returns TRUE if the language of the given resource has changed, FALSE otherwise

Syntax

DBMS_XDBRESEROUCE.HASLANGUAGECHANGED (
   res   IN    XDBResource) 
 RETURN BOOLEAN;

Parameters

---

HASLASTMODIFIERCHANGED Function

This function returns TRUE if the last modifier of the given resource has changed, FALSE otherwise

Syntax

DBMS_XDBRESEROUCE.HASLASTMODIFIERCHANGED (
   res   IN    XDBResource) 
 RETURN BOOLEAN;

Parameters

---

HASMODIFICATIONDATECHANGED Function

This function returns TRUE if the modification date of the given resource has changed, FALSE otherwise

Syntax

DBMS_XDBRESEROUCE.HASMODIFICATIONDATECHANGED (
   res   IN    XDBResource) 
 RETURN BOOLEAN;

Parameters

---

HASOWNERCHANGED Function

This function returns TRUE if the owner of the given resource has changed, FALSE otherwise.

Syntax

DBMS_XDBRESEROUCE.HASOWNERCHANGED (
   res   IN    XDBResource) 
 RETURN BOOLEAN;

Parameters

---

HASREFCOUNTCHANGED Function

This function returns TRUE if the reference count of the given resource has changed, FALSE otherwise.

Syntax

DBMS_XDBRESEROUCE.HASREFCOUNTCHANGED (
   res   IN    XDBResource) 
 RETURN BOOLEAN;

Parameters

---

HASVERSIONIDCHANGED Function

This function returns TRUE if the version ID of the given resource has changed, FALSE otherwise.

Syntax

DBMS_XDBRESEROUCE.HASVERSIONIDCHANGED (
   res   IN    XDBResource) 
 RETURN BOOLEAN;

Parameters

---

ISFOLDER Function

This function returns TRUE if the given resource is a folder, FALSE otherwise.

Syntax

DBMS_XDBRESEROUCE.ISFOLDER (
   res   IN    XDBResource) 
 RETURN BOOLEAN;

Parameters

---

ISNULL Function

This function returns TRUE if input resource is NULL.

Syntax

DBMS_XDBRESEROUCE.ISNULL (
   res   IN    XDBResource) 
 RETURN BOOLEAN;

Parameters

---

MAKEDOCUMENT Function

This function converts the XDBResource to a DOMDocument which can be operated on using the XMLDOM interface.

Syntax

DBMS_XDBRESEROUCE.MAKEDOCUMENT (
   res   IN    XDBResource) 
 RETURN DBMS_XMLDOM.DOMDocument;

Parameters

---

SAVE Procedure

This procedures updates the resource with any modifications.

Syntax

DBMS_XDBRESEROUCE.SAVE (
   res   IN    XDBResource);

Parameters

---

SETACL Procedure

This procedure sets the ACL of the given XDBResource to the path specified.

Syntax

DBMS_XDBRESEROUCE.SETACL (
   res      IN OUT  XDBResource, 
   ACLPath  IN      VARCHAR2);

Parameters

---

SETAUTHOR Procedure

This procedure sets the author of the given XDBResource to the specified string.

Syntax

DBMS_XDBRESEROUCE.SETAUTHOR (
   res     IN OUT  XDBResource, 
   author  IN      VARCHAR2);

Parameters

---

SETCHARACTERSET Procedure

This procedure sets the character set of the given XDBResource to a specified character set.

Syntax

DBMS_XDBRESEROUCE.SETCHARACTERSET (
   res      IN OUT  XDBResource, 
   charSet  IN      VARCHAR2);

Parameters

---

SETCOMMENT Procedure

This procedure sets a comment associated with the given XDBResource.

Syntax

DBMS_XDBRESEROUCE.SETCOMMENT (
   res      IN OUT  XDBResource, 
   comment  IN      VARCHAR2);

Parameters

---

SETCONTENT Procedures

This procedure replaces the contents of the given resource with the given datatype.

Syntax

DBMS_XDBRESEROUCE.SETCONTENT (
   res      IN OUT  XDBResource, 
   data     IN      BFILE,
   csid     IN      NUMBER);

DBMS_XDBRESEROUCE.SETCONTENT (
   res      IN OUT  XDBResource, 
   data     IN      BLOB,
   csid     IN      PLS_INTEGER);

DBMS_XDBRESEROUCE.SETCONTENT (
   res      IN OUT  XDBResource, 
   data     IN      CLOB);

DBMS_XDBRESEROUCE.SETCONTENT (
   res      IN OUT  XDBResource, 
   data     IN      REF SYS.XMLType,
   sticky   IN      BOOLEAN := TRUE);

DBMS_XDBRESEROUCE.SETCONTENT (
   res      IN OUT  XDBResource, 
   data     IN      VARCHAR2);

DBMS_XDBRESEROUCE.SETCONTENT (
   res      IN OUT  XDBResource, 
   data     IN      SYS.XMLType);

Parameters

---

SETCONTENTTYPE Procedure

This procedure sets the content-type of the given XDBResource.

Syntax

DBMS_XDBRESEROUCE.SETCONTENTTYPE (
   res         IN OUT  XDBResource, 
   conttype    IN      VARCHAR2);

Parameters

---

SETCUSTOMMETADATA Procedure

This procedure sets the custom metadata specified by the xpath and namespace to new data.

Syntax

DBMS_XDBRESEROUCE.SETCUSTOMMETADATA (
   res          IN OUT  XDBResource, 
   xpath        IN      VARCHAR2,
   namespace    IN      VARCHAR2, 
   newMetadata  IN      XMLType);

Parameters

Usage Notes

The first component of the XPath expression must be "Resource".

---

SETDISPLAYNAME Procedure

This procedure sets the display name of the given XDBResource.

Syntax

DBMS_XDBRESEROUCE.SETDISPLAYNAME (
   res      IN OUT  XDBResource, 
   name     IN      VARCHAR2);

Parameters

---

SETLANGUAGE Procedure

This procedure sets the language of the given XDBResource.

Syntax

DBMS_XDBRESEROUCE.SETLANGUAGE (
   res      IN OUT  XDBResource, 
   ACLPath  IN      VARCHAR2);

Parameters

---

SETOWNER Procedure

This procedure sets the owner of the given XDBResource.

Syntax

DBMS_XDBRESEROUCE.SETOWNER (
   res      IN OUT  XDBResource, 
   owner    IN      VARCHAR2);

Parameters