Oracle® Database PL/SQL Packages and Types Reference 11g Release 1 (11.1) Part Number B28419-01 |
|
|
View PDF |
The DBMS_XDBRESOURCE
package provides the interface to operate on the resource's metadata and contents.
See Also:
Oracle XML DB Developer's Guide for examples of "UsingDBMS_XDBRESOURCE
"This chapter contains the following topics:
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.
Table 150-1 DBMS_XDBRESOURCE Package Subprograms
Subprogram | Description |
---|---|
FREERESOURCE Procedure |
Frees any memory associated with an XDBResource |
GETACL Function |
Given an XDBResource, returns its ACL as string |
GETACLDOCFROMRES Function |
Returns the ACL Document for the given resource as XMLType |
GETAUTHOR Function |
Given an XDBResource, returns its author |
GETCHARACTERSET Function |
Given an XDBResource, returns its character set |
GETCOMMENT Function |
Given an XDBResource, returns its comment |
GETCONTENTBLOB Function |
Returns the contents of the resource as a BLOB |
GETCONTENTCLOB Function |
Returns the contents of the resource as a CLOB |
GETCONTENTREF Function |
Returns the contents of the resource as an XMLTypeRef |
GETCONTENTTYPE Function |
Given an XDBResource, returns its content-type |
GETCONTENTXML Function |
Returns the contents of the resource as XML |
GETCONTENTVARCHAR2 Function |
Returns the contents of the resource as a string |
GETCREATIONDATE Function |
Given an XDBResource, returns its creation date |
GETCREATOR Function |
Given an XDBResource, returns its creator |
GETCUSTOMMETADATA Function |
Returns the requested custom metadata given the xpath and namespace to the metadata |
GETDISPLAYNAME Function |
Given an XDBResource, returns its display name |
GETLANGUAGE Function |
Given an XDBResource, returns its language |
GETLASTMODIFIER Function |
Given an XDBResource, returns its last modifier |
GETMODIFICATIONDATE Function |
Given an XDBResource, returns its modification date |
GETOWNER Function |
Given an XDBResource, returns its owner. |
GETREFCOUNT Function |
Given an XDBResource, returns its reference count |
GETVERSIONID Function |
Given an XDBResource, returns its version ID. |
HASACLCHANGED Function |
Returns TRUE if the ACL of the given resource has changed, FALSE otherwise |
HASAUTHORCHANGED Function |
Returns TRUE if the ACL of the given resource has changed FALSE otherwise |
HASCHANGED Function |
Returns TRUE if the element or attribute represented by the given XPath has changed, FALSE otherwise |
HASCHARACTERSETCHANGED Function |
Returns TRUE if the character set of the given resource has changed, FALSE otherwise |
HASCOMMENTCHANGED Function |
Returns TRUE if the comment of the given resource has changed, FALSE otherwise |
HASCONTENTCHANGED Function |
Returns TRUE if the contents of the given resource has changed, FALSE otherwise |
HASCONTENTTYPECHANGED Function |
Returns TRUE if the content-type of the given resource has changed, FALSE otherwise |
HASCREATIONDATECHANGED Function |
Returns TRUE if the creation date of the given resource has changed, FALSE otherwise |
HASCREATORCHANGED Function |
Returns TRUE if the creation date of the given resource has changed, FALSE otherwise |
HASCUSTOMMETADATACHANGED Function |
Returns TRUE if custom-metadata for this XPath has changed, FALSE otherwise |
HASDISPLAYNAMECHANGED Function |
Returns TRUE if the display name of the given resource has changed, FALSE otherwise |
HASLANGUAGECHANGED Function |
Returns TRUE if the language of the given resource has changed, FALSE otherwise |
HASLASTMODIFIERCHANGED Function |
Returns TRUE if the last modifier of the given resource has changed, FALSE otherwise |
HASMODIFICATIONDATECHANGED Function |
Returns TRUE if the modification date of the given resource has changed, FALSE otherwise |
HASOWNERCHANGED Function |
Returns TRUE if the owner of the given resource has changed, FALSE otherwise |
HASREFCOUNTCHANGED Function |
Returns TRUE if the reference count of the given resource has changed, FALSE otherwise |
HASVERSIONIDCHANGED Function |
Returns TRUE if the version ID of the given resource has changed, FALSE otherwise |
ISFOLDER Function |
Returns TRUE if the given resource is a folder, FALSE otherwise |
ISNULL Function |
Returns TRUE if input resource is NULL , FALSE otherwise |
MAKEDOCUMENT Function |
Converts the XDBResource to a DOMDocument which can be operated on using the XMLDOM interface |
SAVE Procedure |
Updates the resource with any modifications |
SETACL Procedure |
Sets the ACL of the given XDBResource to the path specified |
SETAUTHOR Procedure |
Sets the author of the given XDBResource to the specified string |
SETCHARACTERSET Procedure |
Sets the character set of the given XDBResource to a specified character set |
SETCOMMENT Procedure |
Sets a comment associated with the given XDBResource |
SETCONTENT Procedures |
Replaces the contents of the given resource with the given CLOB |
SETCONTENTTYPE Procedure |
Sets the content-type of the given XDBResource |
SETCUSTOMMETADATA Procedure |
Sets the custom metadata specified by the XPath and namespace to new data |
SETDISPLAYNAME Procedure |
Sets the display name of the given XDBResource |
SETLANGUAGE Procedure |
Sets the language of the given XDBResource |
SETOWNER Procedure |
Sets the owner of the given XDBResource |
This procedure frees any memory associated with an XDBResource.
Syntax
DBMS_XDBRESEROUCE.FREERESOURCE ( res IN XDBResource) RETURN VARCHAR2;
Parameters
Given an XDBResource, this function returns its ACL as string.
Syntax
DBMS_XDBRESEROUCE.GETACL ( res IN XDBResource) RETURN VARCHAR2;
Parameters
This function returns the ACL Document for the given resource as XMLType
.
Syntax
DBMS_XDBRESEROUCE.GETACLDOCFROMRES ( res IN XDBResource) RETURN SYS.XMLTYPE;
Parameters
Given an XDBResource, this function returns its author.
Syntax
DBMS_XDBRESEROUCE.GETAUTHOR ( res IN XDBResource) RETURN VARCHAR2;
Parameters
Given an XDBResource, this function returns its characterset.
Syntax
DBMS_XDBRESEROUCE.GETCHARACTERSET ( res IN XDBResource) RETURN VARCHAR2;
Parameters
Given an XDBResource, this function returns its comment.
Syntax
DBMS_XDBRESEROUCE.GETCOMMENT ( res IN XDBResource) RETURN VARCHAR2;
Parameters
This function returns the contents of the resource as a BLOB
.
Syntax
DBMS_XDBRESEROUCE.GETCONTENTBLOB ( res IN XDBResource) RETURN BLOB;
Parameters
This function returns the contents of the resource as a CLOB
.
Syntax
DBMS_XDBRESEROUCE.GETCONTENTCLOB ( res IN XDBResource) RETURN CLOB;
Parameters
This function returns the contents of the resource as an XMLTypeRef
.
Syntax
DBMS_XDBRESEROUCE.GETCONTENTREF ( res IN XDBResource) RETURN VARCHAR2;
Parameters
Given an XDBResource, this function returns its content-type.
Syntax
DBMS_XDBRESEROUCE.GETCONTENTTYPE ( res IN XDBResource) RETURN VARCHAR2;
Parameters
This function returns the contents of the resource as an XMLTypeRef
.
Syntax
DBMS_XDBRESEROUCE.GETCONTENTXML ( res IN XDBResource) RETURN XMLType;
Parameters
This function returns the contents of the resource as a string.
Syntax
DBMS_XDBRESEROUCE.GETCONTENTVARCHAR2 ( res IN XDBResource) RETURN VARCHAR2;
Parameters
Given an XDBResource, this function returns its creation date.
Syntax
DBMS_XDBRESEROUCE.GETCREATIONDATE ( res IN XDBResource) RETURN TIMESTAMP;
Parameters
Given an XDBResource, this function returns its creator.
Syntax
DBMS_XDBRESEROUCE.GETCREATOR ( res IN XDBResource) RETURN VARCHAR2;
Parameters
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
Table 150-16 GETCUSTOMMETADATA Function Parameters
Parameter | Description |
---|---|
res |
XDBResource |
xpath |
XPath for custom metadata |
namespace |
Namespace |
Usage Notes
The first component of the XPath expression must be "Resource".
Given an XDBResource, this function returns its display name.
Syntax
DBMS_XDBRESEROUCE.GETDISPLAYNAME ( res IN XDBResource) RETURN VARCHAR2;
Parameters
Given an XDBResource, this function returns its language.
Syntax
DBMS_XDBRESEROUCE.GETLANGUAGE ( res IN XDBResource) RETURN VARCHAR2;
Parameters
Given an XDBResource, this function returns its last modifier.
Syntax
DBMS_XDBRESEROUCE.GETLASTMODIFIER ( res IN XDBResource) RETURN VARCHAR2;
Parameters
Given an XDBResource, this function returns its modification date.
Syntax
DBMS_XDBRESEROUCE.GETMODIFICATIONDATE ( res IN XDBResource) RETURN TIMESTAMP;
Parameters
Given an XDBResource, this function returns its owner.
Syntax
DBMS_XDBRESEROUCE.GETOWNER ( res IN XDBResource) RETURN VARCHAR2;
Parameters
Given an XDBResource, this function returns its reference count.
Syntax
DBMS_XDBRESEROUCE.GETREFCOUNT ( res IN XDBResource) RETURN PLS_INTEGER;
Parameters
Given an XDBResource, this function returns its version ID.
Syntax
DBMS_XDBRESEROUCE.GETVERSIONID ( res IN XDBResource) RETURN PLS_INTEGER;
Parameters
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
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
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
Table 150-26 HASCHANGED Function Parameters
Parameter | Description |
---|---|
res |
XDBResource |
xpath |
XPath to check |
bnamespace |
Namespace to use |
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
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
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
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
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
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
This function checks whether the custom-metadata for a given resource has changed.
Syntax
DBMS_XDBRESEROUCE.HASCUSTOMMETADATACHANGED ( res IN XDBResource) RETURN BOOLEAN;
Parameters
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
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
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
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
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
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
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
This function returns TRUE
if the given resource is a folder, FALSE
otherwise.
Syntax
DBMS_XDBRESEROUCE.ISFOLDER ( res IN XDBResource) RETURN BOOLEAN;
Parameters
This function returns TRUE
if input resource is NULL
.
Syntax
DBMS_XDBRESEROUCE.ISNULL ( res IN XDBResource) RETURN BOOLEAN;
Parameters
This function converts the XDBResource to a DOMDocument which can be operated on using the XMLDOM interface.
See Also:
The DBMS_XMLDOM packageSyntax
DBMS_XDBRESEROUCE.MAKEDOCUMENT ( res IN XDBResource) RETURN DBMS_XMLDOM.DOMDocument;
Parameters
This procedures updates the resource with any modifications.
Syntax
DBMS_XDBRESEROUCE.SAVE ( res IN XDBResource);
Parameters
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
Table 150-45 SETACL Procedure Parameters
Parameter | Description |
---|---|
res |
XDBResource |
ACLPath |
Absolute path of the new ACL |
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
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
Table 150-47 SETCHARACTERSET Procedure Parameters
Parameter | Description |
---|---|
res |
XDBResource |
charset |
New character set |
This procedure sets a comment associated with the given XDBResource.
Syntax
DBMS_XDBRESEROUCE.SETCOMMENT ( res IN OUT XDBResource, comment IN VARCHAR2);
Parameters
Table 150-48 SETCOMMENT Procedure Parameters
Parameter | Description |
---|---|
res |
XDBResource |
comment |
New comment |
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
Table 150-49 SETCONTENT Procedure Parameters
Parameter | Description |
---|---|
res |
XDBResource |
data |
Data input as BFILE , BLOB , CLOB , string, XMLType |
csid |
Character set ID of the BFILE , BLOB |
sticky |
If TRUE creates a sticky REF , otherwise non-sticky |
This procedure sets the content-type of the given XDBResource.
Syntax
DBMS_XDBRESEROUCE.SETCONTENTTYPE ( res IN OUT XDBResource, conttype IN VARCHAR2);
Parameters
Table 150-50 SETCONTENTTYPE Procedure Parameters
Parameter | Description |
---|---|
res |
XDBResource |
conttype |
New content-type |
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
Table 150-51 SETCUSTOMMETADATA Procedure Parameters
Parameter | Description |
---|---|
res |
XDBResource |
xpath |
XPath to change |
namespace |
Namespace to use |
newMetadata |
New data that should replace the metadata at the given XPath |
Usage Notes
The first component of the XPath expression must be "Resource".
This procedure sets the display name of the given XDBResource.
Syntax
DBMS_XDBRESEROUCE.SETDISPLAYNAME ( res IN OUT XDBResource, name IN VARCHAR2);
Parameters
Table 150-52 SETDISPLAYNAME Procedure Parameters
Parameter | Description |
---|---|
res |
XDBResource |
name |
New display name |
This procedure sets the language of the given XDBResource.
Syntax
DBMS_XDBRESEROUCE.SETLANGUAGE ( res IN OUT XDBResource, ACLPath IN VARCHAR2);
Parameters
Table 150-53 SETLANGUAGE Procedure Parameters
Parameter | Description |
---|---|
res |
XDBResource |
ACLPath |
New path |
This procedure sets the owner of the given XDBResource.
Syntax
DBMS_XDBRESEROUCE.SETOWNER ( res IN OUT XDBResource, owner IN VARCHAR2);
Parameters