WebCatalogService Service

Use the WebCatalogService service to provide methods for navigating and managing the catalog, and to read and write catalog objects in XML format.

Enumeration and Method Names	Description
ErrorDetailsLevel Enumeration	Specifies a list of valid values for methods.
ReadObjectsReturnOptions Enumeration	Specifies a list of valid values for methods.
copyItem() Method	Copies an object from one location to another in the catalog.
copyItem2() Method	Generates an archive file from the catalog.
createFolder() Method	Creates a new folder in the catalog.
createLink() Method	Creates a link to the catalog.
deleteItem() Method	Deletes an object from the catalog.
getItemInfo() Method	Retrieves catalog information for an object.
getMaintenanceMode() Method	Retrieves the maintenance mode status.
getObjectCategories() Method	Retrieves all supported categories.
getObjectCreateList() Method	Retrieves all creatable objects.
getObjectTypes() Method	Retrieves all supported catalog object types.
getSubItems() Method	Retrieves the collection of child subitems for an object in the catalog.
getUserHomeDirPath() Method	Retrieves the home directory path of a user.
maintenanceMode() Method	Locks the catalog during maintenance.
moveItem() Method	Moves an object in the catalog to a different location in the catalog.
pasteItem2() Method	Pastes the copied items.
readObjects() Method	Reads an object from the catalog.
removeFolder() Method	Deletes a folder from the catalog.
setItemAttributes() Method	Sets attribute flags for the specified catalog item.
setItemProperty() Method	Sets a property for an object in the catalog.
setOwnership() Method	Take ownership of the specified item.
updateCatalogItemACL() Method	Update the Access Control List for an item in the catalog.
writeObjects() Method	Writes a list of objects to the catalog.

ErrorDetailsLevel Enumeration

The ErrorDetailsLevel enumeration specifies a list of valid values for methods in WebCatalogService Service.

See WebCatalogService Service.

Note:

Only one of the values in ErrorDetailsLevel should be selected.

Table 9-1 ErrorDetailsLevel Enumeration Values

Values	Description
String ErrorCode	Specifies that the ErrorInfo.errorCode field is populated.
String ErrorCodeAndText	Specifies that the ErrorInfo.errorCode and ErrorInfo.message fields are populated.
String FullDetails	Specifies that all ErrorInfo fields are populated.

ReadObjectsReturnOptions Enumeration

The ReadObjectsReturnOptions enumeration is a list of valid values for methods in the WebCatalogService Service.

This enumeration specifies a list of valid values for methods in the WebCatalogService Service.

Values	Description
String NoObject	Specifies that the catalogObject and catalogObjectBytes fields are not populated.
String ObjectAsString	Specifies that the catalogObject field is populated and the catalogObjectBytes fields is not populated.
String ObjectAsBinary	Specifies that the catalogObject field is not populated and the catalogObjectBytes fields is populated.
String ObjectAsBinaryUseMtom	Specifies that the catalogObject field is not populated and the catalogObjectBytes fields is populated and using MTOM to encode the content returned by the SOAP message.

copyItem() Method

Use the copyItem() method to copy an object from one location in the catalog to another location in the catalog.

Signature

void copyItem(String pathSrc, String pathDest, int flagACL, String sessionID);

Arguments	Description
String pathSrc	Specifies the current path to the object in the catalog.
String pathDest	Specifies the location in the catalog where the object should be copied.
int flagACL	Specified whether the item is copied with security. 0 indicates that the item is copied without security. 1 indicates that the item is copied with security.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

copyItem2() Method

Use the copyItem2() method to generate an archive file from the catalog.

Signature

DataHandler copyItem2(List[] path, boolean recursive, boolean permissions, boolean timestamps, boolean useMtom, String skipPath, CopyItem2Params options, String sessionID);

Arguments	Description
List[] path	Specifies the location in the catalog from which the archive was created.
boolean recursive	Specifies whether the child-level folders were included in the archive.
boolean permissions	Specified whether the items are copied with security.
boolean timestamps	Specifies whether to preserve the items' time stamps were preserved.
boolean useMtom	Specifies whether MTOM was used to encode the content returned by the SOAP message.
String skipPath	Specifies the location of the folder to skip while archiving.
CopyItem2Params options	Specifies the source application.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

createFolder() Method

Use the createFolder() method to create a folder in the catalog.

Signature

void createFolder(String path, boolean createIfNotExists, boolean createIntermediateDirs, String sessionID);

Arguments	Description
String path	Specifies the location in the catalog where the folder should be created, including the name of the new folder.
boolean createIfNotExists	If set to TRUE, then the folder object is created in the catalog if it does not already exist. If set to FALSE, then the folder object is not recreated if it already exists.
boolean createIntermediateDirs	If set to TRUE, then an intermediate directory is created. If set to FALSE, the an intermediate directory is not created.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

createLink() Method

Use the createLink() method to create a link to the catalog.

Signature

void createLink(String path, String pathTarget, boolean overwriteIfExists, String sessionID);

Arguments	Description
String Path	Specifies the path to the parent object in the catalog.
String TargetPath	Specifies the location in the catalog to which the link being created should refer.
boolean overwriteIfExists	If set to TRUE, then the link is overwritten if it already exists in the catalog. If set to FALSE, then the link is not overwritten if it already exists in the catalog.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

deleteItem() Method

Use the deleteItem() method to delete an object from the catalog.

To delete a folder, see removeFolder() Method.

Signature

void deleteItem(String path, String sessionID);

Arguments	Description
String path	Specifies the path to the object in the catalog.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

getItemInfo() Method

Use the getItemInfo() method to retrieve catalog information for an object.

Signature

ItemInfo getItemInfo(String path, boolean resolveLinks, String sessionID);

Arguments	Description
String path	Specifies the path to the object in the catalog.
boolean resolveLinks	If set to TRUE and the path in the catalog refers to a link, then Oracle Analytics retrieves information for the object pointed to by the link.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

Returns catalog information for an object in an ItemInfo structure.

See ItemInfo Structure.

getMaintenanceMode() Method

Use the getMaintenanceMode() method to retrieve the maintenance mode status.

Signature

Boolean getMaintenanceMode(String sessionID);

Arguments	Description
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

Returns true or false value indicating current maintenance mode status.

See maintenanceMode() Method.

getObjectCategories() Method

Use the getObjectCategories() method to retrieve the supported categories.

Signature

Boolean getObjectCategories(String sessionID);

Arguments	Description
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

Returns a list of supported categories.

getObjectCreateList() Method

Use the getObjectCreateList() method to retrieve a list of all creatable objects.

Signature

Boolean getObjectCreateList(String sessionID);

Arguments	Description
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

Returns a list of creatable objects.

getObjectTypes() Method

Use the getObjectTypes() method to retrieve a list of all supported catalog object types.

Signature

Boolean getObjectTypes(String sessionID);

Arguments	Description
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

Returns a list of supported object types.

getSubItems() Method

Use the getSubItems() method to retrieve the collection of child sub-items for an object in the catalog.

Signature

List[] getSubItems(String path, String mask, boolean resolveLinks, GetSubItemsParams options, String sessionID);

Arguments	Description
String path	Specifies the path to the parent object in the catalog.
String mask	Specifies a mask that indicates the child subitems to retrieve. The mask character is an asterisk (*). To retrieve all child subitems, use a single asterisk.
boolean resolveLinks	If set to TRUE and the path in the catalog refers to a link, then information is retrieved for the child subitems of the object pointed to by the link.
GetSubItemsParams options	Optional. Specifies parameters to supply to the GetSubItemsParams structure. For information about the GetSubItemsParams structure, see GetSubItemsParams Structure.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

Returns a collection of child subitems in an ItemInfo structure.

See ItemInfo Structure.

getUserHomeDirPath() Method

Use the getUserHomeDirPath() method to retrieve the home directory path of a user.

Signature

String getUserHomeDirPath(String user name, String sessionID);

Arguments	Description
String user name	Specifies the name of the user
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

Returns the path of the specified user's home directory.

maintenanceMode() Method

Use the maintenanceMode() method to lock the catalog during maintenance.

Signature

void maintenanceMode(boolean flag, String sessionID);

Arguments	Description
boolean flag	Set to TRUE if the catalog is locked.
String sessionID)	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

moveItem() Method

Use the moveItem() method to move an object in the catalog to a different location in the catalog.

Signature

void moveItem(String pathSrc, String pathDest, int flagACL, String sessionID);

Arguments	Description
String pathSrc	Specifies the current path to the object in the catalog.
String pathDest	Specifies the location in the catalog where the object should be moved.
int flagACL	Specified whether the item is moved with security. 0 indicates that the item is moved without security. 1 indicates that the item is moved with security.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

pasteItem2() Method

Use the pasteItem2() method to paste the copied items.

Signature

pasteItem2(Binary stream DataHandler archive, String replacePath, int flagACL, int flagOverwrite, String sessionID);

Arguments	Description
Binary stream DataHandler archive	Specifies the returned content of the item as string or bytes. What you specify in this field is determined by the readObjects method.
String replacePath	Specifies the location to paste the copied item.
int flagACL	Specified whether the item is pasted with security. 0 indicates that the item is pasted without security. 1 indicates that the item is pasted without security.
int flagOverwrite	Specifies whether the pasted item overwrites existing item. 0 indicates replace all, 1 indicates replace old, 2 indicates replace none, and 3 indicates force replace.
int flagReplaceReferences	Specifies whether to replace the path references in the xml objects.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

readObjects() Method

Use the readObjects() method to read an object from the catalog and return a CatalogObject structure.

Signature

List[] readObjects(List[] paths, boolean resolveLinks, ErrorDetailsLevel errorMode, ReadObjectsReturnOptions returnOptions, String sessionID);

Arguments	Description
List[] paths	Specifies the location of the object in the catalog.
boolean resolveLinks	If set to TRUE and the path in the catalog refers to a link, then the object is written to the location pointed to by the link.
ErrorDetailsLevel errorMode	Specifies the amount of error information in the errorInfo field in the CatalogObjects structure. For more information, see CatalogObject Structure.
ReadObjectsReturnOptions returnOptions	Specifies a list of valid values. For more information, see "ReadObjectsReturnOptions Enumeration".
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

Returns an array of CatalogObject Structure objects.

See CatalogObject Structure.

If a read operation fails for a catalog object (for example, due to an invalid path or insufficient privileges), the errorInfo field for that object contains a description of the error.

removeFolder() Method

Use the removeFolder() method to delete a folder and its contents from the catalog.

To delete an object other than a folder and its contents, see deleteItem() Method.

Signature

void removeFolder(String path, boolean recursive, String sessionID);

Arguments	Description
String path	Specifies the path to the folder in the catalog.
boolean recursive	If set to TRUE, then remove the specified folder and its contents. If set to FALSE, then only remove the specified folder if it is empty, otherwise display an exception message.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

setItemAttributes() Method

Use the setItemAttributes() method to set attribute flags for a specified catalog item.

Signature

void setItemAttributes (List[] path, int value, int valueOff, boolean recursive, String sessionID);

Arguments	Description
List[] path	Specifies the path to the folder in the catalog.
int value	Specifies which attributes is added. Specifies a combination of the following flags: 1 = read only 2 = archive 4 = hidden 8 = system
int valueOff	Specifies which attributes is removed. See the above int value cell for flags.
boolean recursive	Specifies whether to set the properties of items in sub-directories.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

setItemProperty() Method

Use the setItemProperty() method to set a property for an object in the catalog.

Signature

void setItemProperty(List[] path, List[] name, List[] value, boolean recursive, String sessionID);

Arguments	Description
List[] path	Specifies the path to the object in the catalog.
List[] name	Specifies the name of the property to set.
List[] value	Specifies the new setting for the property.
boolean recursive	Specifies whether to set the properties of items in sub-directories.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

setOwnership() Method

Use the setOwnership() method to take ownership of the specified item.

Signature

void setOwnership(List[]path, Account owner, boolean recursive, String sessionID);

Arguments	Description
List[] path	Specifies the location in the catalog of the object to take ownership.
Account owner	Specifies the account to assign as owner.
boolean recursive	If set to TRUE, then apply this action to the specified folder and its contents. If set to FALSE, then only apply this action to the specified folder if it is empty, otherwise display an exception message.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

updateCatalogItemACL() Method

Use the updateCatalogItemACL() method to update the Access Control List for an item in the catalog.

Signature

void updateCatalogItemACL(List[] path, ACL acl, UpdateCatalogItemACLParams options, String sessionID);

Fields	Description
List[] path	Specifies the path to the object in the catalog.
ACL acl	Specifies the Access Control List. For more information, see ACL Structure.
UpdateCatalogItemACLParams options	Specifies additional parameters. For more information, see UpdateCatalogItemACLParams Structure.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

writeObjects() Method

Use the writeObjects() method to write an array of objects to the catalog.

Signature

List[] writeObjects(List[] catalogObjects, boolean allowOverwrite, boolean createIntermediateDirs, ErrorDetailsLevel errorMode, String sessionID);

Argument	Description
List [] catalogObjects	Specifies the objects to write to the catalog, supplied in the CatalogObject structure. For information about the CatalogObject structure, see CatalogObject Structure. All fields of object.itemInfo are ignored, except for the array of item properties, which are applied to the object. The signature of the resulting document is always COXmlDocument1.
boolean allowOverwrite	If set to TRUE, then if the object already exists in the catalog, it is overwritten. If set to FALSE, then if the object already exists in the catalog, it is not overwritten.
boolean createIntermediateDirs	If set to TRUE and the path in the catalog refers to a link, then the object is written to the location pointed to by the link.
ErrorDetailsLevel errorMode	Specifies the amount of error information in the errorInfo field in the CatalogObject Structure.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

Array of ErrorInfo Structure objects.

See ErrorInfo Structure.