はじめに

Oracle Application Express APIリファレンスでは、Oracle Application Express環境でプログラミングする際に使用可能な、APIと呼ばれるApplication Programming Interfaceについて説明します。

注意:

Oracle Application Express 4.2では、APEX_DEBUG_MESSAGEパッケージは、APEX_DEBUGにリネームされました。APEX_DEBUG_MESSAGEパッケージ名は、下位互換性のために引き続きサポートされます。ただし、Oracle Application Expressの旧バージョンでAPEX_DEBUGパッケージを実行する場合を除き、新規アプリケーションでは新しいAPEX_DEBUGパッケージを使用することをお薦めします。

トピック:

トピック概要
対象読者
ドキュメントのアクセシビリティについて
関連ドキュメント
表記規則

トピック概要

このマニュアルは、次の章で構成されています。

タイトル

説明

注意:

リリース2.2では、Oracle Application ExpressのAPIは、接頭辞APEX_によってリネームされました。APIの以前の接頭辞HTMLDB_も、下位互換性のためにサポートされます。ただし、Oracle Application Expressの旧バージョンでAPIを実行する場合を除き、新規アプリケーションでは新しいAPI名を使用することをお薦めします。

対象読者

Oracle Application Express APIリファレンスは、Oracle Application Expressを使用してデータベース集中型のWebアプリケーションを構築するアプリケーション開発者を対象としています。このガイドでは、Oracle Application Express環境でプログラミングする際に使用可能なAPIについて説明します。

このガイドを使用するには、リレーショナル・データベースの概念、およびOracle Application Expressを実行するオペレーティング・システム環境について理解しておく必要があります。

参照:

『Oracle Database Application Express 2日で開発者ガイド』

ドキュメントのアクセシビリティについて

Oracleのアクセシビリティについての詳細情報は、Oracle Accessibility ProgramのWebサイト(http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc)を参照してください。

Oracle Supportへのアクセス

Oracleサポート・サービスでは、My Oracle Supportを通して電子支援サービスを提供しています。詳細情報は(http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info)か、聴覚に障害のあるお客様は(http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs)を参照してください。

ドキュメント内のサンプル・コードのアクセシビリティについて

スクリーン・リーダーは、ドキュメント内のサンプル・コードを正確に読めない場合があります。コード表記規則では閉じ括弧のみを行に記述する必要があります。しかし、一部のスクリーン・リーダーは括弧のみの行を読まない場合があります。

表記規則

PL/SQLサブプログラムの表記規則の詳細は、『Oracle Database PL/SQL言語リファレンス』を参照してください。このマニュアルには、次の情報が含まれています。

サブプログラムのパラメータ・モードの指定
サブプログラムのパラメータのデフォルト値の指定
PL/SQLサブプログラムの名前のオーバーロード

このマニュアルでは次の表記規則を使用します。

規則

意味

このリリースでの変更点	Oracle Application Expressリリース4.2用のこのドキュメントでの変更点について説明します。
APEX_APPLICATION	`APEX_APPLICATION`パッケージを使用すると、多数のグローバル変数を利用できます。
APEX_APPLICATION_INSTALL	`APEX_APPLICATION_INSTALL`パッケージには、Application Expressアプリケーションのインストール・プロセス中にアプリケーション属性を変更するためのメソッドが多数用意されています。
APEX_AUTHENTICATION	`APEX_AUTHENTICATION`パッケージには、認証プラグインのための公開APIが用意されています。
APEX_COLLECTION	`APEX_COLLECTION`を使用すると、1つ以上の非スカラー値を一時的に取得できます。コレクションを使用して、現在セッション・ステートにある行および列を格納します。これによって、あるユーザーの特定のセッション中にそれらの行および列に対してアクセス、操作または処理を行うことができます。
APEX_CSS	`APEX_CSS`パッケージには、CSSスタイルをHTTP出力に追加するためのユーティリティ・ファンクションが用意されています。通常、このパッケージはプラグイン開発に使用されます。
APEX_CUSTOM_AUTH	`APEX_CUSTOM_AUTH`パッケージを使用すると、認証およびセッション管理に関連する様々な操作を実行できます。
APEX_DEBUG	`APEX_DEBUG`パッケージには、デバッグ・メッセージ・ログを管理するためのユーティリティ・ファンクションが用意されています。
APEX_ESCAPE	`APEX_ESCAPE`パッケージには、データがそれ以降の処理に適するように、文字列内の特殊文字をエスケープする機能が用意されています。
APEX_ERROR	`APEX_ERROR`パッケージには、エラー処理ファンクションのためのインタフェース宣言と、いくつかのユーティリティ・ファンクションが用意されており、Application Expressアプリケーションでエラーを生成するためのプロシージャやファンクションが含まれています。
APEX_INSTANCE_ADMIN	`APEX_INSTANCE_ADMIN`パッケージには、Oracle Application Expressのランタイム環境を管理するためのユーティリティが用意されています。`APEX_INSTANCE_ADMIN`パッケージを使用すると、電子メール設定、ウォレット設定、レポート出力設定などの取得と設定を行い、スキームとワークスペースのマッピングを管理できます。
APEX_IR	`APEX_IR`パッケージは、対話モード・レポートに関連付けられたOracle Application Express環境でプログラミングする際に使用可能なユーティリティを提供します。
APEX_ITEM	`APEX_ITEM`パッケージを使用すると、ページごとに個別にアイテムを作成するかわりに、SQL問合せに基づいてフォーム要素を動的に作成できます。
APEX_JAVASCRIPT	`APEX_JAVASCRIPT`パッケージには、動的なJavaScriptコードをHTTP出力に追加するためのユーティリティ・ファンクションが用意されています。通常、このパッケージはプラグイン開発に使用されます。
APEX_LANG	`APEX_LANG` APIを使用してメッセージを翻訳できます。
APEX_LDAP	`APEX_LDAP`を使用すると、Lightweight Directory Access Protocol (LDAP)認証に関連する様々な操作を実行できます。
APEX_MAIL	`APEX_MAIL`パッケージを使用すると、Oracle Application Expressアプリケーションから電子メールを送信できます。
APEX_PLSQL_JOB	`APEX_PLSQL_JOB`パッケージを使用すると、アプリケーションのバックグラウンドでPL/SQLコードを実行できます。操作が完了していない状態でもユーザーがアプリケーションで作業を継続できるため、長時間実行操作の管理に有効な方法です。
APEX_PLUGIN	`APEX_PLUGIN`パッケージには、インタフェース宣言と、プラグインを処理するいくつかのユーティリティ・ファンクションが用意されています。
APEX_PLUGIN_UTIL	`APEX_PLUGIN_UTIL`パッケージには、プラグインを記述する際の共通の問題を解決するユーティリティ・ファクションが用意されています。
APEX_UI_DEFAULT_UPDATE	`APEX_UI_DEFAULT_UPDATE`パッケージを使用すると、ユーザー・インタフェースのデフォルト値を設定して、スキーマ内の表に関連付けることができます。このパッケージは、更新する表を所有しているスキーマ内からコールする必要があります。
APEX_UTIL	`APEX_UTIL`パッケージを使用すると、セッション・ステートの取得と設定、ファイルの取得、ユーザーの認可の確認、ユーザーへの別のステートの再設定、およびユーザーのプリファレンスの取得と設定を行うことができます。
APEX_WEB_SERVICE	`APEX_WEB_SERVICE` APIを使用すると、PL/SQLを使用できるアプリケーション内の任意の場所でWebサービスと対話できるため、Application Expressと他のシステムを統合できます。APIには、SOAPおよびRESTful形式のWebサービスをコールするためのプロシージャおよびファンクションが含まれます。
JavaScript API	これらのJavaScriptファンクションおよびオブジェクトを使用することで、クライアント側の機能(ページ要素の表示/非表示、XML HTTP Asynchronous JavaScriptおよびXML (AJAX)リクエストの作成など)を提供できます。
太字	太字は、操作に関連するGraphical User Interface要素、または本文中で定義されている用語および用語集に記載されている用語を示します。
イタリック体	イタリックは、ユーザーが特定の値を指定するプレースホルダ変数を示します。
`固定幅フォント`	固定幅フォントは、段落内のコマンド、URL、サンプル内のコード、画面に表示されるテキスト、または入力するテキストを示します。

はじめに

トピック概要

対象読者

ドキュメントのアクセシビリティについて

関連ドキュメント

表記規則