CatalogObject Structure ErrorInfo Structure

Description of Structures in Oracle BI EE Web Services 2-5

2.9 GetSubItemsParams Structure

Use this structure to contain optional parameters used in a getSubItems method. This structure is used in the WebCatalogService Service . Table 2–9 lists the fields in this structure.

2.10 ImportError Structure

Use this structure to describe the cause of a failure during an import. This structure is used in the ReplicationService Service . Table 2–10 lists the fields in this structure. Table 2–8 ErrorInfo Structure Fields Fields Description String code Specifies the error code to display. String context Specifies the service and method in which the error occurred. String details Specifies detailed information about the error. String message Specifies a human-readable description of the error. Table 2–9 GetSubItemsParams Structure Fields Fields Descriptions GetSubItemsFilter filter For internal use only. boolean includeACL If set to TRUE, then ACL information is included in the resulting ItemInfo structures. int withPermission and int withPermissionMask Specifies that you want to filter the resulting items collection by access level. The only items included in the result are those for which the following expression is true: itemPermission withPermissionMask = withPermission withPermissionMask where itemPermission is a combination of permission flags for the current catalog item. int withAttributes and int withAttributesMask Specifies that you want to filter the resulting items collection by attribute flags. The only items included in the result are those for which the following expression is true: itemAttributes withAttributesMask = withAttributes withAttributesMask where itemAttributes is a combination of attribute flags for the current catalog item. Table 2–10 ImportError Structure Fields Fields Description String item Specifies the path to the changed item. For example, usersjchananalyses. String operation For internal use only. String catalogError Specifies an error string, describing the reason for the failure. String file Specifies in which file the error occurred. 2-6 Oracle Fusion Middleware Integrators Guide for Oracle Business Intelligence Enterprise Edition

2.11 ItemInfo Structure

Use this structure to contain catalog information about an object. This structure is used in the WebCatalogService Service . Table 2–11 lists the fields in this structure.

2.12 NameValuePair Structure

Use this structure to denote named properties, such as COLOR=RED. This structure is used in the WebCatalogService Service . Table 2–12 lists the fields in this structure. String line Specifies the line in which the error occurred. Table 2–11 ItemInfo Structure Fields Fields Description String path Specifies the path to the object in the catalog. For example, usersjchananalyses. ItemInfoType type Specifies a character string that indicates the type. Valid values are: ■ Folder ■ Link ■ Missing ■ NoAccess ■ Object String caption Specifies the localized name of the object in the catalog. For example, in French, My Folders is displayed as Mes Dossiers. int attributes Specifies a combination of the following flags: 1 = read only 2 = archive 4 = hidden 8 = system Calendar lastModified Specifies the date and time that the object was last modified, in Calendar format. Calendar created Specifies the date and time that the object was created saved in the catalog, in Calendar format. Calendar accessed Specifies the data and time that the object was last accessed by a user, in Calendar format. String signature Specifies the signature of the catalog object. NameValuePair[] itemProperties Specifies an array of object properties. ACL aclXX Specifies the Access Control List for this catalog item. Account owner Specifies the owner of the object. String targetPath If the ItemInfoType field is set to Link, this field specifies the target path for the object. Table 2–10 Cont. ImportError Structure Fields Fields Description