getFolderContents Method getFolderContentsInSession Method getObject Method getObjectInfo Method

6-8 Developers Guide for Oracle Business Intelligence Publisher

6.15 getObject Method

Use getObject method to download an object from the catalog. This method returns the requested object file in binary. Signature byte[] getObjectString reportObjectAbsolutePath, String locale, String userID, String password;

6.16 getObjectInfo Method

Use getObjectInfo method to get information about an object in the BI Publisher catalog. This method returns the CatalogObjectInfo object. See CatalogObjectInfo . Signature CatalogObjectInfo getObjectInfoString reportObjectAbsolutePath, String userID, String password;

6.17 getObjectInfoInSession Method

Use getObjectInfoInSession method to get information about an object in the BI Publisher catalog for a given user. This method returns the CatalogObjectInfo object. See CatalogObjectInfo . Table 6–14 Parameters for getFolderContentsInSession Method Parameter Description String folderAbsolutePath The path to the folder for which to retrieve the contents. For example: HR ManagerEmployee Reports String bipSessionToken The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore the BI Publisher server session to perform needed operation. Table 6–15 Parameters for getObject Method Parameter Description String reportObjectAbsolutePath The path to the object to download. String locale The locale of the object to get. String userID Specifies the BI Publisher user name. String password Specifies the password for the user name. Table 6–16 Parameters for getObjectInfo Method Parameter Description String reportObjectAbsolutePath The path to the report object about which to get information. String userID Specifies a BI Publisher user name. String password Specifies the password for the user name. CatalogService 6-9 For more information about in-session methods, see Section 1.2, About In-Session Methods. Signature CatalogObjectInfo getObjectInfoInSessionString objectAbsolutePath, String bipSessionToken;

6.18 getObjectInSession Method

Use getObjectInSession method to download an object from the catalog for a given user. This method returns the requested object file in binary. For more information about in-session methods, see Section 1.2, About In-Session Methods. Signature byte[] getObjectInSessionString objectAbsolutePath, String bipSessionToken;

6.19 objectExist Method

Use objectExist method to determine if an object exists in the BI Publisher catalog. Signature boolean objectExistString reportObjectAbsolutePath, String userID, String password; Table 6–17 Parameters for getObjectInfoInSession Method