ReportEditingServiceサービス

ReportEditingServiceサービスを使用して、引数とOracle Analyticsプレゼンテーション・サービス・データをマージし、結果を作成して戻します。

メソッド名	説明
applyReportDefaults()メソッド	分析のデフォルトの引数を分析に適用し、結果を戻します。
applyReportParams()メソッド	レポートの引数を分析オブジェクトに適用し、結果を戻します。
getPromptElements()メソッド	特定の分析の基準プロンプト列定義のリストおよび現在の実行時状態を取得します。
generateReportSQL()メソッド	指定された分析に対するSQL問合せを取得します。
getReportColumns()メソッド	分析の基準列のリストを取得します。
getReportElements()メソッド	プロンプトのリスト、保護されていないフィルタおよび特定のレポートの参照されたプレゼンテーション変数を取得します。

applyReportDefaults()メソッド

applyReportDefaults()メソッドを使用して、分析のデフォルトの引数を分析に適用し、結果を戻します。

シグネチャ

String applyReportDefaults(ReportRef reportRefs, String sessionID);

引数	説明
ReportRef object	ReportRef共通構造体で提供される、分析定義へのパスを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

デフォルトの分析引数を指定した分析オブジェクトに適用した結果を戻します。

applyReportParams()メソッド

applyReportParams()メソッドを使用して、分析引数を分析に適用し、結果を戻します。

シグネチャ

Object applyReportParams(ReportRef reportRef, ReportParams reportParams, boolean encodeInString, String sessionID);

引数	説明
ReportRef reportRef	ReportRef共通構造体で提供される、分析定義へのパスを指定します。
ReportParams reportParams	オプション。実行前に分析に適用するフィルタまたは変数を指定します。この情報は、ReportParams共通構造体で提供されます。
boolean encodeInString	TRUEに設定されている場合、戻される分析オブジェクトは、文字列としてエンコードされます。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

分析引数を指定した分析オブジェクトに適用した結果を戻します。encodeInStringをtrueに設定した場合、結果は文字列としてエンコードされます。

getPromptElements()メソッド

getPromptElements()メソッドを使用して、特定の分析の基準プロンプト列定義のリストおよび現在の実行時状態を取得します。

シグネチャ

getPromptElements(ReportRef promptRef, String viewState, String viewID, String portalPath, String page, NameValuePair optionalParams, String sessionID);

引数	説明
ReportRef promptRef	必須。保存されたレポートまたはレポートXMLドキュメントへのカタログ・パスを指定します。
String viewState	オプション。実行時のviewStateを指定します。実行時プロンプト定義は、ビューのviewStateを設定する他のプロンプトに基づいて変更される場合があります。
String viewID	オプション: ビューIDを指定します
String portalPath	オプション: レポートが存在するダッシュボード・カタログ・パスを指定します。
String page	オプション: レポートが存在するダッシュボード・ページ名を指定します。
NameValuePair optionalParams	オプション: 通常デバッグ目的で使用される追加パラメータの名前を指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

レポート・プロンプト列のセット。

「PromptsObjectModel構造体」を参照してください。

generateReportSQL()メソッド

generateReportSQL()メソッドを使用して、指定した分析に対する論理SQL問合せを取得します。

シグネチャ

String generateReportSQL(ReportRef reportRef, ReportParams reportParams, String sessionID);

引数	説明
ReportRef reportRef	ReportRef共通構造体で提供される、分析定義へのパスを指定します。
ReportParams reportParams	オプション。実行前に分析に適用するフィルタまたは変数へのパスを指定します。これはReportParams共通構造体で提供されます。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

指定した分析のSQL問合せを含む文字列。

getReportColumns()メソッド

getReportColumns()メソッドを使用して、特定の分析の基準列のリストを取得します。

シグネチャ

ReportColumn[] getReportElements(String reportPath, String sessionID);

引数	説明
ReportRef reportRef	ReportRef共通構造体で提供される、分析定義へのパスを指定します。
String sessionID	セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

ReportColumn[] - レポートの列の配列。

「ReportHierarchicalColumn構造体」および「ReportRegularColumn構造体」を参照してください。

getReportElements()メソッド

getReportElements()メソッドを使用して、すべてのレポート・プロンプトのリスト、保護されていないフィルタおよび特定のレポートの参照されたプレゼンテーション変数を取得します。

シグネチャ

String getReportElements(String reportPath, String sessionID);

引数	説明
String reportPath	必須。レポートのレポート・カタログ・パスを指定します。
String sessionID	オプション。セッションIDを指定します。これは通常ログオン・メソッドにより戻されます。SOAPクライアント・エンジンがHTTP Cookieを処理できる場合、セッションIDは省略するか、nullに設定することができます。

戻り値

ADFパラメータをレポートします。

存在する場合、次にリストされた順序で次のオブジェクトのADFパラメータをレポートします。

• プロンプト

• 保護されていないフィルタ

• レポートで参照されたプレゼンテーション変数

• Oracle Analyticsプレゼンテーション・サービスで参照されたコンテキスト変数

「ReportADFParameters構造体」を参照してください。