ヘッダーをスキップ
Oracle® Fusion Middleware Oracle Business Intelligence Publisher開発者ガイド
11gリリース1(11.1.1)
B66710-03
  目次へ移動
目次
索引へ移動
索引

前
前へ
 
次へ
次へ
 

6 CatalogService

この章では、BI Publisherサーバーのトップレベル・カタログとやり取りするためのCatalogServiceメソッドについて説明します。CatalogServiceは、フォルダ、レポート、データ・モデル、スタイル・テンプレート、サブテンプレートなどのすべてのレポート・オブジェクトを管理し、作成、削除、コピー、名前の変更などの一般的な操作に対応するメソッドを提供します。

この章の内容は次のとおりです。


注意:

BI Publisher Webサービスを使用して作成されたアプリケーションをデバッグする方法の詳細は、第1.4項「Webサービス・アプリケーションのデバッグ」を参照してください。


6.1 copyObject()メソッド

copyObject()メソッドは、BI Publisherカタログ内のオブジェクトをコピーします。

シグネチャ

boolean copyObject(String srcOjectAbsolutePath, String destObjectAbsolutePath, String newName, String userID, String password);

表6-1 copyObject()メソッドのパラメータ

パラメータ 説明

String srcOjectAbsolutePath

コピーするカタログ・オブジェクトへのパスです。

String destObjectAbsolutePath

オブジェクトのコピー先となるカタログ内の場所へのパスです。

String newName

新しいオブジェクトに割り当てる名前です。

String userID

BI Publisherのユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


6.2 copyObjectInSession()メソッド

このメソッドは、srcObjectAbsolutePathが参照するレポート・オブジェクトをdestFolderAbsolutePathが指定するコピー先フォルダにコピーします。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

boolean copyObjectInSession(String srcObjectAbsolutePath, String destFolderAbsolutePath, String newName, String bipSessionToken);

表6-2 copyObjectInSession()メソッドのパラメータ

パラメータ 説明

String srcOjectAbsolutePath

コピーするカタログ・オブジェクトへのパスです。

String destObjectAbsolutePath

オブジェクトのコピー先となるカタログ内の場所へのパスです。

String newName

新しいオブジェクトに割り当てる名前です。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


6.3 createFolder()メソッド

createFolder()メソッドを使用して、BI Publisherカタログ内にフォルダを作成します。

シグネチャ

String createFolder(String folderAbsolutePath, String userID, String password);

表6-3 createFolder()メソッドのパラメータ

パラメータ 説明

String folderAbsolutePath

作成するフォルダへのパスです。(例: /HR Manager/Employee Reports/)。

String userID

BI Publisherのユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


6.4 createFolderInSession()メソッド

createFolderInSession()メソッドは、指定ユーザーに対してBI Publisherカタログ内にフォルダを作成します。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

String createFolderInSession(String folderAbsolutePath, String bipSessionToken);

表6-4 createFolderInSession()メソッドのパラメータ

パラメータ 説明

String folderAbsolutePath

作成するフォルダへのパスです。(例: /HR Manager/Employee Reports/)。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


6.5 createObject()メソッド

createObject()メソッドは、BI Publisherカタログにオブジェクトを作成します。

シグネチャ

String createObject(String folderAbsolutePathURL, String objectName, String objectType, String objectDescription, byte[] objectData, String userID, String password);

表6-5 createObject()メソッドのパラメータ

パラメータ 説明

String folderAbsolutePathURL

新しいオブジェクトを配置するカタログ内のフォルダへの絶対パスです。

String objectName

新しいオブジェクトの名前です。

String objectType

カタログ・オブジェクトのタイプです。有効な値は次のとおりです。

xdm (データ・モデル)

xdo (レポート)

xsb (サブテンプレート)

xss (スタイル・テンプレート)

String objectDescription

新しいオブジェクトの説明を指定します。

byte[] objectData

オブジェクトのバイト・データです。

String userID

BI Publisherのユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


6.6 createObjectInSession()メソッド

createObjectInSession()メソッドは、指定ユーザーに対していBI Publisherカタログ内にオブジェクトを作成します。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

String createObjectInSession(String folderAbsolutePathURL, String objectName, String objectType, String objectDescription, byte[] objectData, String bipSessionToken);

表6-6 createObjectInSession()メソッドのパラメータ

パラメータ 説明

String folderAbsolutePathURL

新しいオブジェクトを配置するカタログ内のフォルダへの絶対パスです。

String objectName

新しいオブジェクトの名前です。

String objectType

カタログ・オブジェクトのタイプです。有効な値は次のとおりです。

xdm (データ・モデル)

xdo (レポート)

xsb (サブテンプレート)

xss (スタイル・テンプレート)

String objectDescription

新しいオブジェクトの説明を指定します。

byte[] objectData

オブジェクトのバイト・データです。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


6.7 deleteObject()メソッド

deleteObject()メソッドは、BI Publisherカタログからオブジェクトを削除します。

シグネチャ

boolean deleteObject(String reportObjectAbsolutePath, String userID, String password);

表6-7 deleteObject()メソッドのパラメータ

パラメータ 説明

String reportObjectAbsolutePath

カタログの削除対象オブジェクトのパスです。

String userID

BI Publisherのユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


6.8 deleteObjectInSession()メソッド

deleteObjectInSession()メソッドは、指定ユーザーのBI Publisherカタログからオブジェクトを削除します。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

boolean deleteObjectInSession(String objectAbsolutePath, String bipSessionToken);

表6-8 deleteObjectInSession()メソッドのパラメータ

パラメータ 説明

String objectAbsolutePath

カタログの削除対象オブジェクトのパスです。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


6.9 downloadObject()メソッド

downloadObject()メソッドは、BI Publisherカタログからオブジェクトをダウンロードします。このメソッドはリクエストされたオブジェクトをバイナリで返します。

シグネチャ

byte[] downloadObject(String reportAbsolutePath, String userID, String password);

表6-9 downloadObject()メソッドのパラメータ

パラメータ 説明

String reportAbsolutePath

カタログ内のダウンロード対象オブジェクトへのパスです。

String userID

BI Publisherのユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


6.10 downloadObjectInSession()メソッド

downloadObjectInSession()メソッドは、指定ユーザーのBI Publisherカタログからオブジェクトをダウンロードします。このメソッドはリクエストされたオブジェクトをバイナリで返します。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

byte[] downloadObjectInSession(String reportAbsolutePath, String bipSessionToken);

表6-10 downloadObjectInSession()メソッドのパラメータ

パラメータ 説明

String reportAbsolutePath

カタログ内のダウンロード対象オブジェクトへのパスです。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


6.11 downloadXLIFF()メソッド

downloadXLIFF()メソッドは、カタログから翻訳ファイル(XLIFF)をダウンロードします。このメソッドは、リクエストされたXLIFFファイルをバイナリで返します。

シグネチャ

byte[] downloadXLIFF(String objectAbsolutePath, String userID, String password);

表6-11 downloadXLIFF()メソッドのパラメータ

パラメータ 説明

String objectAbsolutePath

ダウンロードするXLIFFオブジェクトへのパスです。

String userID

BI Publisherユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


6.12 downloadXLIFFInSession()メソッド

downloadXLIFFInSession()メソッドは、指定ユーザーのカタログdownloadXLIFFInSessionから翻訳ファイル(XLIFF)をダウンロードします。このメソッドは、リクエストされたXLIFFファイルをバイナリで返します。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

byte[] downloadXLIFFInSession(String objectAbsolutePath, String locale, String bipSessionToken);

表6-12 downloadXLIFFInSession()メソッドのパラメータ

パラメータ 説明

String objectAbsolutePath

ダウンロードするXLIFFオブジェクトへのパスです。

String locale

XLIFFオブジェクトのロケールです(en_USなど)。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


6.13 getFolderContents()メソッド

getFolderContentsは、フォルダ内のすべてのアイテムを取得します。この操作では、指定されたフォルダ内のすべてのレポートとフォルダが返されます。これらのアイテムを使用して、実行するレポートや、さらに検索を行ってレポートを特定するフォルダを決定できます。

返されたオブジェクトの説明は、CatalogContentsを参照してください。

シグネチャ

CatalogContents getFolderContents(String folderAbsolutePath, String userID, String password);

表6-13 getFolderContents()メソッドのパラメータ

パラメータ 説明

String folderAbsolutePath

コンテンツ取得元となるフォルダへのパスです。(例: /HR Manager/Employee Reports/)。

String userID

BI Publisherのユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


6.14 getFolderContentsInSession()メソッド

getFolderContentsInSession()は、指定ユーザーのフォルダ内のアイテムをすべて取得します。この操作では、指定されたフォルダ内のすべてのレポートとフォルダが返されます。これらのアイテムを使用して、実行するレポートや、さらに検索を行ってレポートを特定するフォルダを決定できます。

返されたオブジェクトの説明は、CatalogContentsを参照してください。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

CatalogContents getFolderContentsInSession(String folderAbsolutePath, String bipSessionToken);

表6-14 getFolderContentsInSession()メソッドのパラメータ

パラメータ 説明

String folderAbsolutePath

コンテンツ取得元となるフォルダへのパスです。(例: /HR Manager/Employee Reports/)。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


6.15 getObject()メソッド

getObject()メソッドは、カタログからオブジェクトをダウンロードします。このメソッドはリクエストされたオブジェクト・ファイルをバイナリで返します。

シグネチャ

byte[] getObject(String reportObjectAbsolutePath, String locale, String userID, String password);

表6-15 getObject()メソッドのパラメータ

パラメータ 説明

String reportObjectAbsolutePath

ダウンロードするオブジェクトへのパスです。

String locale

取得するオブジェクトのロケールです。

String userID

BI Publisherユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


6.16 getObjectInfo()メソッド

getObjectInfo()メソッドは、BI Publisherカタログのオブジェクトに関する情報を取得します。このメソッドはCatalogObjectInfoオブジェクトを返します。CatalogObjectInfoを参照してください。

シグネチャ

CatalogObjectInfo getObjectInfo(String reportObjectAbsolutePath, String userID, String password);

表6-16 getObjectInfo()メソッドのパラメータ

パラメータ 説明

String reportObjectAbsolutePath

情報取得に関するレポート・オブジェクトへのパスです。

String userID

BI Publisherのユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


6.17 getObjectInfoInSession()メソッド

getObjectInfoInSession()メソッドは、指定ユーザーのBI Publisherカタログのオブジェクトに関する情報を取得します。このメソッドはCatalogObjectInfoオブジェクトを返します。CatalogObjectInfoを参照してください。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

CatalogObjectInfo getObjectInfoInSession(String objectAbsolutePath, String bipSessionToken);

表6-17 getObjectInfoInSession()メソッドのパラメータ

パラメータ 説明

String reportObjectAbsolutePath

情報取得に関するレポート・オブジェクトへのパスです。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


6.18 getObjectInSession()メソッド

getObjectInSession()メソッドは、指定ユーザーのカタログからオブジェクトをダウンロードします。このメソッドはリクエストされたオブジェクト・ファイルをバイナリで返します。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

byte[] getObjectInSession(String objectAbsolutePath, String bipSessionToken);

表6-18 getObjectInSession()メソッドのパラメータ

パラメータ 説明

String reportObjectAbsolutePath

取得するオブジェクトへのパスです。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


6.19 objectExist()メソッド

objectExist()メソッドは、BI Publisherカタログ内のオブジェクトの有無を特定します。

シグネチャ

boolean objectExist(String reportObjectAbsolutePath, String userID, String password);

表6-19 objectExist()メソッドのパラメータ

パラメータ 説明

String reportOjectAbsolutePath

カタログ内でテスト対象となるオブジェクトへのパスです。例: /HR Manager/Employee Reports/Employee Data Model.xdm

String userID

BI Publisherのユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


6.20 objectExistInSession()メソッド

objectExist()メソッドは、指定ユーザーのBI Publisherカタログ内のオブジェクトの有無を特定します。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

boolean objectExistInSession(String reportObjectAbsolutePath, String bipSessionToken);

表6-20 objectExistInSession()メソッドのパラメータ

パラメータ 説明

String reportOjectAbsolutePath

カタログ内でテスト対象となるオブジェクトへのパスです。例: /HR Manager/Employee Reports/Employee Data Model.xdm

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


6.21 renameObject()メソッド

renameObject()メソッドは、BI Publisherカタログ内のオブジェクトの名前を変更します。

シグネチャ

boolean renameObject(String reportObjectAbsolutePath, String newName, String userID, String password);

表6-21 renameObject()メソッドのパラメータ

パラメータ 説明

String reportObjectAbsolutePath

カタログ内にある、名前を変更するオブジェクトへのパスです。

String newName

オブジェクトに割り当てられる新しい名前です。

String userID

BI Publisherのユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


6.22 renameObjectInSession()メソッド

renameObject()メソッドは、指定ユーザーのBI Publisherカタログ内にあるオブジェクトの名前を変更します。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

boolean renameObjectInSession(String objectAbsolutePath, String newName, String bipSessionToken);

表6-22 renameObjectInSession()メソッドのパラメータ

パラメータ 説明

String reportObjectAbsolutePath

カタログ内にある、名前を変更するオブジェクトへのパスです。

String newName

オブジェクトの新しい名前です。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


6.23 updateObject()メソッド

updateObject()メソッドは、BI Publisherカタログ内のオブジェクトを更新します。

シグネチャ

boolean updateObject(String reportObjectAbsolutePath, byte[] objectData, String userID, String password);

表6-23 updateObject()メソッドのパラメータ

パラメータ 説明

String reportOjectAbsolutePath

カタログ内にある更新対象オブジェクトへのパスです。例: /HR Manager/Employee Reports/Employee Data Model.xdm

byte[] objectData

オブジェクトを更新する際に使用するデータです。

String userID

BI Publisherのユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


6.24 updateObjectInSession()メソッド

updateObject()メソッドは、指定ユーザーのBI Publisherカタログ内にあるオブジェクトを更新します。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

boolean updateObjectInSession(String objectAbsolutePath, byte[] objectData, String bipSessionToken);

表6-24 updateObjectInSession()メソッドのパラメータ

パラメータ 説明

String reportOjectAbsolutePath

カタログ内にある更新対象オブジェクトへのパスです。例: /HR Manager/Employee Reports/Employee Data Model.xdm

byte[] objectData

オブジェクトを更新する際に使用するデータです。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


6.25 uploadObject()メソッド

uploadObject()メソッドは、新しいオブジェクトをBI Publisherカタログにアップロードします。

シグネチャ

String uploadObject(String reportObjectAbsolutePathURL, String objectType, byte[] objectZippedData, String userID, String password);

表6-25 uploadObject()メソッドのパラメータ

パラメータ 説明

String reportObjectAbsolutePathURL

カタログ内のオブジェクトへのパス。

String objectType

アップロードするオブジェクトのタイプです。有効な値は次のとおりです。

xdm (データ・モデル)

xdo (レポート)

xsb (サブテンプレート)

xss (スタイル・テンプレート)

byte[] objectZippedData

ZIP形式でアップロードするオブジェクトです。

String userID

BI Publisherのユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


6.26 uploadObjectInSession()メソッド

uploadObject()メソッドは、新しいオブジェクトを指定ユーザーのBI Publisherカタログにアップロードします。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

String uploadObject(String reportObjectAbsolutePathURL, String objectType, byte[] objectZippedData, String userID, String bipSessionToken);

表6-26 uploadObjectInSession()メソッドのパラメータ

パラメータ 説明

String reportObjectAbsolutePathURL

カタログ内のオブジェクトへのパス。

String objectType

アップロードするオブジェクトのタイプです。有効な値は次のとおりです。

xdm (データ・モデル)

xdo (レポート)

xsb (サブテンプレート)

xss (スタイル・テンプレート)

byte[] objectZippedData

ZIP形式でアップロードするオブジェクトです。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。


6.27 uploadXLIFF()メソッド

uploadXLIFF()メソッドは、翻訳ファイル(XLIFF)をカタログにアップロードします。

シグネチャ

boolean uploadXLIFF(String objectAbsolutePath, byte[] xliffData, String locale, String userID, String password);

表6-27 uploadXLIFF()メソッドのパラメータ

パラメータ 説明

String objectAbsolutePath

アップロードするXLIFFオブジェクトへのパスです。

byte[] xliffData

アップロードするXLIFFファイルです。

String locale

XLIFFに割り当てられるロケールです(en_USなど)。

String userID

BI Publisherユーザー名を指定します。

String password

ユーザー名のパスワードを指定します。


6.28 uploadXLIFFInSession()メソッド

uploadXLIFF()メソッドは、翻訳ファイル(XLIFF)を指定ユーザーのカタログにアップロードします。

インセッション・メソッドの詳細は、第1.3項「インセッション・メソッドについて」を参照してください。

シグネチャ

boolean uploadXLIFF(String objectAbsolutePath, byte[] xliffData, String locale, String bipSessionToken);

表6-28 uploadXLIFFInSession()メソッドのパラメータ

パラメータ 説明

String objectAbsolutePath

アップロードするXLIFFオブジェクトへのパスです。

byte[] xliffData

アップロードするXLIFFファイルです。

String locale

XLIFFに割り当てられるロケールです(en_USなど)。

String bipSessionToken

BI Publisherサーバーでユーザーに対して生成された専用トークン文字列です。bipSessionToken文字列を使用すると、ユーザーは資格証明を入力する必要がなくなります。BI Publisherサーバーでは、このトークン文字列を検証し、BI Publisherサーバー・セッションを復元して必要な操作を実行できます。