19 APEX_PAGE

APEX_PAGEパッケージは、ページを処理するためのパブリックAPIです。

グローバル定数
IS_DESKTOP_UIファンクション
IS_JQM_SMARTPHONE_UIファンクション
IS_JQM_TABLET_UIファンクション
GET_UI_TYPEファンクション
IS_READ_ONLYファンクション
GET_PAGE_MODEファンクション
PURGE_CACHEプロシージャ
GET_URLファンクション

グローバル定数

このパッケージでは、次の定数が使用されます。

c_ui_type_desktop        constant varchar2(10) := 'DESKTOP';
c_ui_type_jqm_smartphone constant varchar2(15) := 'JQM_SMARTPHONE';

IS_DESKTOP_UIファンクション

このファンクションは、現在のページがデスクトップ・ブラウザ用に設計されている場合はTRUEを戻します。

構文

FUNCTION IS_DESKTOP_UI 
RETURN BOOLEAN;

IS_JQM_SMARTPHONE_UIファンクション

このファンクションは、現在のページがjQuery Mobileを使用するスマートフォン・デバイス用に設計されている場合はTRUEを戻します。

構文

FUNCTION IS_JQM_SMARTPHONE_UI
RETURN BOOLEAN;

IS_JQM_TABLET_UIファンクション

このファンクションは、現在のページがjQuery Mobileを使用するタブレット・デバイス用に設計されている場合はTRUEを戻します。

構文

FUNCTION IS_JQM_TABLET_UI
RETURN BOOLEAN;

GET_UI_TYPEファンクション

このファンクションは、現在のページの設計対象となっているユーザー・インタフェース(UI)のタイプを戻します。

構文

FUNCTION GET_UI_TYPE 
RETURN VARCHAR2;

IS_READ_ONLYファンクション

このファンクションは、現在のページが読取り専用でレンダリングされる場合はTRUEを、それ以外の場合はFALSEを戻します。

構文

FUNCTION IS_READ_ONLY
RETURN BOOLEAN;

GET_PAGE_MODEファンクション

このファンクションは、現在のページのページ・モードを戻します。

構文

FUNCTION GET_PAGE_MODE (
    p_application_id        IN NUMBER,
    p_page_id 
    RETURN VARCHAR2;

パラメータ

表19-1 GET_PAGE_MODEのパラメータ

パラメータ	説明
`p_application_id`	アプリケーションの`ID`。デフォルトは、現在のアプリケーションです。
`p_page_id`	ページの`ID`。デフォルトは、現在のページです。

PURGE_CACHEプロシージャ

このプロシージャは、指定されたユーザーの指定のアプリケーション、ページおよびリージョンのキャッシュをパージします。ユーザーを指定しないと、ページのキャッシュされたすべてのバージョンがパージされます。

構文

PROCEDURE PURGE_CACHE (
    p_application_id       IN NUMBER DEFAULT wwv_flow.g_flow_id,
    p_page_id              IN NUMBER DEFAULT wwv_flow.g_flow_step_id,
    p_user_name            IN VARCHAR2 DEFAULT NULL,
    p_current_session_only IN BOOLEAN  DEFAULT FALSE );

パラメータ

表19-2 PURGE_CACHEのパラメータ

パラメータ	説明
`p_application_id`	アプリケーションの`ID`。デフォルトは、現在のアプリケーションです。
`p_page_id`	ページの`ID`。デフォルトは、現在のページです。NULLを渡すと、Oracle Application Expressでは、アプリケーションのすべてのページに関するキャッシュがパージされます。
`p_user_name`	特定のユーザー用に保存されたエントリのみをパージする場合は、ユーザー名を指定します。
`p_current_session_only`	現在のセッション用に保存されたエントリのみをパージする場合は、TRUEを指定します。デフォルトは、FALSEです。

例

次の例では、現在のページについてセッション固有のキャッシュをパージします。

BEGIN
     APEX_PAGE.PURGE_CACHE (
         p_current_session_only => true );
END;

GET_URLファンクション

このファンクションは、Oracle Application Expressのf?p= URLを戻します。連結されたURLよりも、ファンクション・コールを読み込んだ方が明確な場合があります。比較のため、次に示す例を参照してください。

構文

FUNCTION GET_URL (
    p_application        IN VARCHAR2 DEFAULT NULL,
    p_page               IN VARCHAR2 DEFAULT NULL,
    p_session            IN NUMBER   DEFAULT WWV_FLOW.G_INSTANCE,
    p_request            IN VARCHAR2 DEFAULT NULL,
    p_debug              IN VARCHAR2 DEFAULT NULL,
    p_clear_cache        IN VARCHAR2 DEFAULT NULL,
    p_items              IN VARCHAR2 DEFAULT NULL,
    p_values             IN VARCHAR2 DEFAULT NULL,
    p_printer_friendly   IN VARCHAR2 DEFAULT NULL,
    p_trace              IN VARCHAR2 DEFAULT NULL )
    RETURN VARCHAR2;

パラメータ

表19-3 PURGE_CACHEのパラメータ

パラメータ	説明
`p_application`	アプリケーションのIDまたは別名。デフォルトは、現在のアプリケーションです。
`p_page`	ページのIDまたは別名。デフォルトは、現在のページです。
`p_session`	セッションID。デフォルトは、現在のセッションIDです。
`p_request`	URLリクエスト・パラメータ。
`p_debug`	URLデバッグ・パラメータ。デフォルトは、現在のデバッグ・モードです。
`p_clear_cache`	URLキャッシュ・クリア・パラメータ。
`p_items`	セッション・ステートを設定するための、カンマで区切られたアイテム名のリスト。
`p_values`	セッション・ステートを設定するための、カンマで区切られたアイテム値のリスト。
`p_printer_friendly`	URL印刷用パラメータ。デフォルトは、現在のリクエストの「印刷用」モードです。
`p_trace`	SQLトレース・パラメータ。

例

次の問合せでは、APEX_PAGE.GET_URLとその代替のAPEX_UTIL.PREPARE_URLを使用して同一のURLを2つ生成します。

SELECT APEX_PAGE.GET_URL (
            p_page   => 1,
            p_items  => 'P1_X,P1_Y',
            p_values => 'somevalue,othervalue' ) f_url_1,
         APEX_UTIL.PREPARE_URL('f?p=&APP_ID.:1:&APP_SESSION.::::P1_X,P1_Y:somevalue,othervalue')
     FROM DUAL