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
Parameter Description
String reportObjectAbsolutePath The path to the report object about which to get
information. 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–18 Parameters for getObjectInSession Method
Parameter Description
String reportObjectAbsolutePath The path to the object to retrieve.
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–19 Parameters for objectExist Method
Parameter Description
String reportOjectAbsolutePath The path to the object to test for in the catalog. For
example: HR ManagerEmployee ReportsEmployee Data Model.xdm
String userID Specifies a BI Publisher user name.
6-10 Developers Guide for Oracle Business Intelligence Publisher
6.20 objectExistInSession Method
Use objectExist method to determine if an object exists in the BI Publisher catalog for a given user.
For more information about in-session methods, see Section 1.2, About In-Session
Methods.
Signature boolean objectExistInSessionString reportObjectAbsolutePath, String
bipSessionToken;
6.21 renameObject Method
Use renameObject method to rename an object in the BI Publisher catalog.
Signature boolean renameObjectString reportObjectAbsolutePath, String newName, String
userID, String password;
6.22 renameObjectInSession Method
Use renameObject method to rename an object in the BI Publisher catalog for a given user.
For more information about in-session methods, see Section 1.2, About In-Session
Methods. String password
Specifies the password for the user name.
Table 6–20 Parameters for objectExistInSession Method
Parameter Description
String reportOjectAbsolutePath The path to the object to test for in the catalog. For
example: HR ManagerEmployee ReportsEmployee Data Model.xdm
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–21 Parameters for renameObject Method
Parameter Description
String reportObjectAbsolutePath The path to the object in the catalog to rename.
String newName The new name to assign the object.
String userID Specifies a BI Publisher user name.
String password Specifies the password for the user name.
Table 6–19 Cont. Parameters for objectExist Method
Parameter Description