6-6 Developers Guide for Oracle Business Intelligence Publisher
6.10 downloadObjectInSession Method
Use downloadObjectInSession method to download an object from the BI Publisher catalog for a given user. This method returns the requested object in binary.
For more information about in-session methods, see Section 1.2, About In-Session
Methods.
Signature byte[] downloadObjectInSessionString reportAbsolutePath, String bipSessionToken;
6.11 downloadXLIFF Method
Use downloadXLIFF method to download a translation file XLIFF from the catalog. This method returns the requested XLIFF file in binary.
Signature byte[] downloadXLIFFString objectAbsolutePath, String userID, String password;
6.12 downloadXLIFFInSession Method
Use downloadXLIFFInSession method to download a translation file XLIFF from the catalog downloadXLIFFInSession a given user. This method returns the requested
XLIFF file in binary.
For more information about in-session methods, see Section 1.2, About In-Session
Methods.
Table 6–9 Parameters for downloadObject Method
Parameter Description
String reportAbsolutePath The path to the object in the catalog to download.
String userID Specifies a BI Publisher user name.
String password Specifies the password for the user name.
Table 6–10 Parameters for downloadObjectInSession Method
Parameter Description
String reportAbsolutePath The path to the object in the catalog to download.
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–11 Parameters for downloadXLIFF Method
Parameter Description
String objectAbsolutePath The path to the XLIFF object to download.
String userID Specifies the BI Publisher user name.
String password Specifies the password for the user name.
CatalogService 6-7
Signature byte[] downloadXLIFFInSessionString objectAbsolutePath, String locale, String
bipSessionToken;
6.13 getFolderContents Method
Use getFolderContents to get all of the items in a folder. This will return all the reports and folders contained in the specified folder. You can then use these items to
determine what reports you might want to execute or what folders you may want to further search to identify a report.
See CatalogContents
for a description of the return object.
Signature CatalogContents getFolderContentsString folderAbsolutePath, String userID, String
password;
6.14 getFolderContentsInSession Method
Use getFolderContentsInSession to get all of the items in a folder for a given user. This will return all the reports and folders contained in the specified folder. You can
then use these items to determine what reports you might want to execute or what folders you may want to further search to identify a report.
See CatalogContents
for a description of the return object. For more information about in-session methods, see
Section 1.2, About In-Session Methods.
Signature CatalogContents getFolderContentsInSessionString folderAbsolutePath, String
bipSessionToken;
Table 6–12 Parameters for downloadXLIFFInSession Method
Parameter Description
String objectAbsolutePath The path to the XLIFF object to download.
String locale The locale of the XLIFF object for example, en_US.
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–13 Parameters for getFolderContents Method
Parameter Description
String folderAbsolutePath The path to the folder for which to retrieve the contents.
For example: HR ManagerEmployee Reports String userID
Specifies a BI Publisher user name. String password
Specifies the password for the user name.
Kategori