APEX_IRパッケージは、対話モード・レポートに関連付けられたOracle Application Express環境でプログラミングする際に使用可能なユーティリティを提供します。APEX_IRパッケージを使用すると、対話モード・レポートの実行時の問合せの取得、フィルタの追加、レポート設定のリセットまたはクリア、保存されたレポートの削除およびサブスクリプションの管理が可能です。
トピック:
構文
APEX_IR.ADD_FILTER(
p_page_id IN NUMBER,
p_region_id IN NUMBER,
p_report_column IN VARCHAR2,
p_filter_value IN VARCHAR2,
p_operator_abbr IN VARCHAR2 DEFAULT NULL,
p_report_id IN NUMBER DEFAULT NULL);
パラメータ
表11-1では、ADD_FILTERプロシージャのシグネチャ1で使用可能なパラメータについて説明します。
表11-1 ADD_FILTERプロシージャのシグネチャ1のパラメータ
| パラメータ | 説明 |
|---|---|
|
|
対話モード・レポートを含む、Application Expressのカレント・アプリケーションのページ。 |
|
|
対話モード・レポート・リージョン(ID)。 |
|
|
フィルタ処理されるレポートSQL列名または列の別名。 |
|
|
フィルタ値。この値はNおよびNNには使用されません。 |
|
|
フィルタ・タイプ。有効な値は次のとおりです。 EQ = 等しい NEQ = 等しくない LT = 未満 LTE = 以下 GT = より大きい GTE = 以上 LIKE = SQLのLike演算子 NLIKE = 類似ではない N = Null NN = NULLではない C = 含む NC = 含まない IN = SQL In演算子 NIN = SQL Not In演算子 |
|
|
カレント・アプリケーション・ページで保存したレポートID。 |
例
次の例に、ADD_FILTERプロシージャを使用して、DEPTNOが30で、カレント・アプリケーションのページ1にレポートID880629800374638220、リージョン2505704029884282を持つ対話モード・レポートをフィルタ処理する方法を示します。
BEGIN
APEX_IR.ADD_FILTER(
p_page_id => 1,
p_region_id => 2505704029884282,
p_report_column => 'DEPTNO',
p_filter_value => '30',
p_operator_abbr => 'EQ',
p_report_id => 880629800374638220);
END;
このプロシージャは、レポート別名を使用して、対話モード・レポートにフィルタを作成します。
|
注意: このプロシージャはページ発行プロセスでのみ使用されます。 |
構文
APEX_IR.ADD_FILTER(
p_page_id IN NUMBER,
p_region_id IN NUMBER,
p_report_column IN VARCHAR2,
p_filter_value IN VARCHAR2,
p_operator_abbr IN VARCHAR2 DEFAULT NULL,
p_report_alias IN VARCHAR2 DEFAULT NULL);
パラメータ
表11-2では、ADD_FILTERプロシージャのシグネチャ2で使用可能なパラメータについて説明します。
表11-2 ADD_FILTERプロシージャのシグネチャ2
| パラメータ | 説明 |
|---|---|
|
|
対話モード・レポートを含む、Application Expressのカレント・アプリケーションのページ。 |
|
|
対話モード・レポート・リージョン(ID)。 |
|
|
フィルタ処理されるレポートSQL列名または列の別名。 |
|
|
これはフィルタ値です。この値はNおよびNNには使用されません。 |
|
|
フィルタ・タイプ。有効な値は次のとおりです。 EQ = 等しい NEQ = 等しくない LT = 未満 LTE = 以下 GT = より大きい GTE = 以上 LIKE = SQLのLike演算子 NLIKE = 類似ではない N = Null NN = NULLではない C = 含む NC = 含まない IN = SQL In演算子 NIN = SQL Not In演算子 |
|
|
カレント・アプリケーション・ページで保存したレポート別名。 |
例
次の例に、ADD_FILTERプロシージャを使用して、DEPTNOが30で、カレント・アプリケーションのページ1にレポート別名CATEGORY_REPORT、リージョン2505704029884282を持つ対話モード・レポートをフィルタ処理する方法を示します。
BEGIN
APEX_IR.ADD_FILTER(
p_page_id => 1,
p_region_id => 2505704029884282,
p_report_column => 'DEPTNO',
p_filter_value => '30',
p_operator_abbr => 'EQ',
p_report_alias => 'CATEGORY_REPORT');
END;
このプロシージャは、対話モード・レポートのサブスクリプションの言語を変更します。
構文
APEX_IR.CHANGE_SUBSCRIPTION_LANG(
p_subscription_id IN NUMBER,
p_language IN VARCHAR2);
パラメータ
表11-3では、使用可能なパラメータについて説明します。
表11-3 CHANGE_SUBSCRIPTION_LANGプロシージャのパラメータ
| パラメータ | 説明 |
|---|---|
|
|
現行のワークスペース内の言語を変更するサブスクリプションID。 |
|
|
これはIANA言語コードです。 |
例
次の例に、CHANGE_SUBSCRIPTION_LANGプロシージャを使用して、現行のワークスペースにあるIDが567890123のサブスクリプションをドイツ語に変更する方法を示します。
BEGIN
APEX_IR.CHANGE_SUBSCRIPTION_LANG(
p_subscription_id => 567890123,
p_language => 'de');
END;
構文
APEX_IR.CLEAR_REPORT(
p_page_id IN NUMBER,
p_region_id IN NUMBER,
p_report_id IN NUMBER DEFAULT NULL);
パラメータ
表11-4では、CLEAR_REPORTプロシージャのシグネチャ1で使用可能なパラメータについて説明します。
表11-4 CLEAR_REPORTプロシージャのシグネチャ1のパラメータ
| パラメータ | 説明 |
|---|---|
|
|
対話モード・レポートを含む、Application Expressのカレント・アプリケーションのページ。 |
|
|
対話モード・レポート・リージョン(ID)。 |
|
|
カレント・アプリケーション・ページで保存したレポートID。 |
例
次の例に、CLEAR_REPORTプロシージャを使用して、カレント・アプリケーションのページ1にレポートID880629800374638220、リージョン2505704029884282を持つ対話モード・レポート設定をクリアする方法を示します。
BEGIN
APEX_IR.CLEAR_REPORT(
p_page_id => 1,
p_region_id => 2505704029884282,
p_report_id => 880629800374638220);
END;
構文
APEX_IR.CLEAR_REPORT(
p_page_id IN NUMBER,
p_region_id IN NUMBER,
p_report_alias IN VARCHAR2 DEFAULT NULL);
パラメータ
表11-5では、CLEAR_REPORTプロシージャのシグネチャ2で使用可能なパラメータについて説明します。
表11-5 CLEAR_REPORTプロシージャのシグネチャ2のパラメータ
| パラメータ | 説明 |
|---|---|
|
|
対話モード・レポートを含む、Application Expressのカレント・アプリケーションのページ。 |
|
|
対話モード・レポート・リージョン(ID)。 |
|
|
カレント・アプリケーション・ページで保存したレポート別名。 |
例
次の例に、CLEAR_REPORTプロシージャを使用して、カレント・アプリケーションのページ1にレポート別名CATEGORY_REPORT、リージョン2505704029884282を持つ対話モード・レポート設定をクリアする方法を示します。
BEGIN
APEX_IR.CLEAR_REPORT(
p_page_id => 1,
p_region_id => 2505704029884282,
p_report_alias => 'CATEGORY_REPORT');
END;
このプロシージャは、保存した対話モード・レポートを削除します。プライマリ・デフォルト・レポート以外のすべての保存済レポートを削除します。
構文
APEX_IR.DELETE_REPORT(
p_report_id IN NUMBER);
パラメータ
表11-6では、DELETE_REPORTプロシージャで使用可能なパラメータについて説明します。
例
次の例に、DELETE_REPORTプロシージャを使用して、カレント・アプリケーションにあるIDが880629800374638220の保存済の対話モード・レポートを削除する方法を示します。
BEGIN
APEX_IR.DELETE_REPORT (
p_report_id => 880629800374638220);
END;
このプロシージャは、対話モード・レポートのサブスクリプションを削除します。
構文
APEX_IR.DELETE_SUBSCRIPTION(
p_subscription_id IN NUMBER);
パラメータ
表11-7では、DELETE_SUBSCRIPTIONプロシージャで使用可能なパラメータについて説明します。
例
次の例に、DELETE_SUBSCRIPTIONプロシージャを使用して、現行のワークスペースにあるIDが567890123のサブスクリプションを削除する方法を示します。
BEGIN
APEX_IR.DELETE_SUBSCRIPTION(
p_subscription_id => 567890123);
END;
このファンクションは、指定されたページおよびリージョンで最後に表示された基本レポートのIDを戻します。
構文
APEX_IR.GET_LAST_VIEWED_REPORT_ID(
p_page_id IN NUMBER,
p_region_id IN NUMBER);
パラメータ
表11-8では、GET_LAST_VIEWDED_REPORT_IDファンクションで使用可能なパラメータについて説明します。
表11-8 GET_LAST_VIEWED_REPORT_IDファンクションのパラメータ
| パラメータ | 説明 |
|---|---|
|
|
対話モード・レポートを含む、Application Expressのカレント・アプリケーションのページ。 |
|
|
対話モード・レポート・リージョンのID。 |
例
次の例に、GET_LAST_VIEWED_REPORT_IDファンクションを使用して、リージョンが2505704029884282のカレント・アプリケーションのページ1で最後に表示されたレポートIDを取得する方法を示します。
DECLARE
l_report_id number;
BEGIN
l_report_id := APEX_IR.GET_LAST_VIEWED_REPORT_ID (
p_page_id => 1,
p_region_id => 2505704029884282);
END;
このファンクションは、対話モード・レポートの実行時の問合せを戻します。
構文
APEX_IR.GET_REPOR(
p_page_id IN NUMBER,
p_region_id IN NUMBER,
p_report_id IN NUMBER DEFAULT NULL);
パラメータ
表11-9では、GET_REPORTファンクションで使用可能なパラメータについて説明します。
表11-9 GET_REPORTファンクションのパラメータ
| パラメータ | 説明 |
|---|---|
|
|
対話モード・レポートを含む、Application Expressのカレント・アプリケーションのページ。 |
|
|
対話モード・レポート・リージョンのID。 |
|
|
カレント・アプリケーション・ページで保存したレポートID。 |
例
次の例に、GET_REPORTファンクションを使用して、カレント・アプリケーションのページ1にレポートID880629800374638220、リージョン2505704029884282を持つ実行時のレポート問合せをバインド変数情報とともに取得する方法を示します。
DECLARE
l_report apex_ir.t_report;
l_query varchar2(32767);
BEGIN
l_report := APEX_IR.GET_REPORT (
p_page_id => 1,
p_region_id => 2505704029884282,
p_report_id => 880629800374638220);
l_query := l_report.sql_query;
sys.htp.p('Statement = '||l_report.sql_query);
for i in 1..l_report.binds.count
loop
sys.htp.p(i||'. '||l_report.binds(i).name||' = '||l_report.binds(i).value);
end loop;
END;
このプロシージャは、レポートIDを使用して、レポート設定を開発者が定義したデフォルト設定にリセットします。
|
注意: このプロシージャはページ発行プロセスでのみ使用されます。 |
構文
APEX_IR.RESET_REPORT(
p_page_id IN NUMBER,
p_region_id IN NUMBER,
p_report_id IN NUMBER DEFAULT NULL);
パラメータ
表11-10では、RESET_REPORTプロシージャのシグネチャ1で使用可能なパラメータについて説明します。
表11-10 RESET_REPORTプロシージャのシグネチャ1のパラメータ
| パラメータ | 説明 |
|---|---|
|
|
対話モード・レポートを含む、Application Expressのカレント・アプリケーションのページ。 |
|
|
対話モード・レポート・リージョンのID。 |
|
|
カレント・アプリケーション・ページで保存したレポートID。 |
例
次の例に、RESET_REPORTプロシージャのシグネチャ1を使用して、カレント・アプリケーションのページ1にレポートID880629800374638220、リージョン2505704029884282を持つ対話モード・レポート設定をリセットする方法を示します。
BEGIN
APEX_IR.RESET_REPORT(
p_page_id => 1,
p_region_id => 2505704029884282,
p_report_id => 880629800374638220);
END;
構文
APEX_IR.RESET_REPORT(
p_page_id IN NUMBER,
p_region_id IN NUMBER,
p_report_alias IN VARCHAR2 DEFAULT NULL);
パラメータ
表11-11では、RESET_REPORTプロシージャのシグネチャ2で使用可能なパラメータについて説明します。
表11-11 RESET_REPORTプロシージャのシグネチャ2のパラメータ
| パラメータ | 説明 |
|---|---|
|
|
対話モード・レポートを含む、Application Expressのカレント・アプリケーションのページ。 |
|
|
対話モード・レポート・リージョンのID。 |
|
|
カレント・アプリケーション・ページで保存したレポート別名。 |
例
次の例に、RESET_REPORTプロシージャを使用して、カレント・アプリケーションのページ1にレポート別名CATEGORY_REPORT、リージョン2505704029884282を持つ対話モード・レポート設定をリセットする方法を示します。
BEGIN
APEX_IR.RESET_REPORT(
p_page_id => 1,
p_region_id => 2505704029884282,
p_report_alias => 'CATEGORY_REPORT');
END;