Oracle E-Business Suite開発者ガイド リリース12.2 E53035-01

目次

前へ

次へ

APPCOREルーチンAPI

APPCOREルーチンAPIについて

この章では、PL/SQLプロシージャから多数のOracle E-Business Suite APIをコールするための仕様を説明します。APPCOREライブラリのルーチンのほとんどはこの章で説明していますが、一部のAPPCOREルーチンは他の章で説明しています(たとえば、APP_SPECIALルーチンについては「ツールバーおよびデフォルト・メニューの制御」の章で説明しています)。この章では次のルーチンについて説明しています。

• APP_COMBO: 組合せブロックAPI

• APP_DATE: 日付変換API

• APP_EXCEPTION: 例外処理API

• APP_FIELD: 項目関連ユーティリティ

• APP_FIND: 問合せ検索ユーティリティ

• APP_ITEM: 個別項目ユーティリティ

• APP_ITEM_PROPERTY: プロパティ・ユーティリティ

• APP_NAVIGATE

• APP_RECORD: レコード・ユーティリティ

• APP_REGION: リージョン・ユーティリティ

• APP_STANDARDパッケージ

• APP_WINDOW: ウィンドウ・ユーティリティ

APP_COMBO: 組合せブロックAPI

APP_COMBOを使用して、組合せブロックのナビゲーションを制御します。

APP_COMBO.KEY_PREV_ITEM

procedure  APP_COMBO.KEY_PREV_ITEM;

APP_DATEとFND_DATE: 日付変換API

日付のフォーマット、変換または検証は、APP_DATEおよびFND_DATEパッケージ・ユーティリティを使用して実行できます。このパッケージは日付関連の複雑な書式マスクを隠すためのものです。これらのルーチンは、特に日付を文字列として処理するときに有用です。文字型の日付、つまり、略した文字日付は、内部的に日付として格納されますが、UIでは日付フィールドではなく文字フィールドとして処理される値です。これらのルーチンは、複数言語、フレキシブル書式マスク、およびこれらの変換の2000年対応の側面を処理するように設計されています。リリース12.2から、APP_DATEおよびFND_DATEでは国際カレンダをサポートしています(カレンダ認識)。

APP_DATEルーチンはAPPCOREライブラリの中にあり、フォームや他のライブラリからコールできます。ただし、CUSTOMライブラリなどAPPCOREに添付されているライブラリは除きます。CUSTOMライブラリやAPPCOREに添付されている各種ライブラリのコードに対しては、特別なAPPCORE2ライブラリの中のAPP_DATE2パッケージを使用します。APP_DATE2パッケージはAPP_DATEと同等のもので、同じルーチンと引数を含みます。

FND_DATEパッケージはデータベースに配置されています。FND_DATEルーチンはSQL文または他のデータベース・パッケージからコールできます。多くのルーチンはAPP_DATEとFND_DATEの両方のパッケージにあります。

日付用語リスト

日付は様々な方法で表すことができるため、次のAPIで使用される日付関連用語を定義しておくと有用です。

警告: APP_DATEおよびFND_DATEルーチンは、canonical_mask、user_maskなどのパッケージ変数を使用します。Oracle E-Business Suiteが正しく動作するためにはこれらの値が正しいことが条件となるため、これらの変数は変更しないでください。

国際カレンダ・サポートとcalendar_awareパラメータ

Oracle E-Business Suiteには、Hijrahカレンダおよびタイ・カレンダに対する国際カレンダ・サポートが組み込まれています。リリース12.2からは、文字日付もサポートするように拡張されています(文字日付とは、内部的には日付として格納され、UIでは文字フィールドとして処理される値です)。APP_DATEおよびFND_DATEはパラメータを使用して、内部的なカレンダ認識を制御します。カレンダ認識であることによって、APIではプロファイル・オプション「FND: フォーム・ユーザー・カレンダ」の設定が考慮されるようになります(設定されている場合)。デフォルトでは、ユーザー・カレンダにはグレゴリウス・カレンダが表示されますが、プロファイル・オプションに別のカレンダが設定されている場合は、そのカレンダが使用されます。

カレンダ・サポートの詳細は、『Oracle E-Business Suiteセットアップ・ガイド』のカレンダのサポートに関する項を参照してください。

このドキュメントでは、次の用語および意味を使用します。

• カレンダ未認識 - グレゴリウス・カレンダのみがサポートされます。

• カレンダ認識 - その他のカレンダがサポートされます。

デフォルトのAPP_DATEはカレンダ認識で、デフォルトのFND_DATEはカレンダ非認識です。calendar_awareパラメータを明示的に設定することで、これらのAPIで文字日付の値を処理する方法を制御できます。製品のカレンダとして常にグレゴリウスを必要とするインスタンスがある可能性に注意してください。その場合は、文字日付ルーチンがカレンダ非認識をコールするようにしてください。

calendar_awareパラメータには、次の値が使用されます。

calendar_unaware CONSTANT number := 0;
calendar_aware CONSTANT number := 1;

calendar_awareパラメータを使用する場合は、次の例のように明示的にリストする必要があります。

fnd_date_displaydt_to_date(
charDT=>:lines.need_by_date, 
calendar_aware=>1)

PL/SQLファンクションで定義された変数はSQL文から参照できないため、FND_DATEルーチンのコールでは、変数のかわりに0または1の数値を使用します。

calendar_awareパラメータの使用例

APP_DATEの例を次に示します。

l_promised_date := APP_DATE.displayDT_to_date(name_in('PO_SHIPMENTS.promised_date'),calendar_aware=>APP_DATE.calendar_unaware); 

FND_DATEの例を次に示します。

AND (Nvl(Trunc(fnd_Date.Displaydt_to_date(charDT=>:lines.Need_By_Date,calendar_aware=>1)), Trunc(SYSDATE))
BETWEEN Nvl(poh.Start_Date,Nvl(Trunc(fnd_Date.Displaydt_to_date(charDT=>:lines.Need_By_Date,calendar_aware=>1)), Trunc(SYSDATE)))
AND Nvl(poh.End_Date,Nvl(Trunc(fnd_Date.Displaydt_to_date(charDT=>:lines.Need_By_Date,calendar_aware=>1)), Trunc(SYSDATE)))
OR Trunc(SYSDATE)
BETWEEN Nvl(poh.Start_Date,Trunc(SYSDATE)) AND Nvl(poh.End_Date,Trunc(SYSDATE))) 

一般的な質問と回答

次に、一般的な質問と回答を示します。

パラメータを明示的にリストする必要はありますか。

つまり、この例のようにパラメータを渡すことはできますか。

fnd_Date.Displaydt_to_date(:lines.Need_By_Date,1)

回答: いいえ。次の例のようにパラメータを明示的にリストする必要があります。

fnd_Date.Displaydt_to_date(charDT=>:lines.Need_By_Date,calendar_aware=>1)

パラメータを明示的にリストすることは、暗黙的な変換によって予想外のファンクションがコールされて、意図しない結果となる状況が排除されます。

定数を使用できないのはなぜですか。FND_DATEの例では、calendar_aware=>FND_DATE.calendar_awareではなく、calendar_aware=>1が使用されています。理由を説明してください。

回答: PL/SQLのファンクションおよびプロシージャで定義された変数は、SQL文から参照できないためです。

このcalendar_awareパラメータの拡張によって、すべてのフォームを再コンパイルする必要はありますか。

回答: いいえ。再コンパイルが必要なのは、変更したフォームとライブラリのみです。

APP_DATE.CANONICAL_TO_DATEとFND_DATE.CANONICAL_TO_DATE

function APP_DATE.CANONICAL_TO_DATE(
canonical varchar2)
return date;

例1

declare
hire_date varchar2(20) := '1980/01/01';
num_days_employed number;
begin
num_days_employed := trunc(sysdate) -
app_date.canonical_to_date(hire_date);
message('Length of employment in days: '||
to_char(num_days_employed));
end;

例2

select fnd_date.canonical_to_date(tab.my_char_date) 
from ...

APP_DATE.DISPLAYDATE_TO_DATEとFND_DATE.DISPLAYDATE_TO_DATE

function APP_DATE.DISPLAYDATE_TO_DATE(
chardate varchar2
[calendar_aware=>value])
return date;

APP_DATE.DISPLAYDT_TO_DATEとFND_DATE.DISPLAYDT_TO_DATE

function APP_DATE.DISPLAYDT_TO_DATE(
charDT varchar2
[calendar_aware=>value])
return date;

例1

l_promised_date := APP_DATE.displayDT_to_date(
name_in('PO_SHIPMENTS.promised_date'),
calendar_aware=>APP_DATE.calendar_unaware); 

例2

fnd_Date.Displaydt_to_date(
charDT=>:lines.Need_By_Date,
calendar_aware=>1)

APP_DATE.DATE_TO_CANONICALとFND_DATE.DATE_TO_CANONICAL

function APP_DATE.DATE_TO_CANONICAL( 
dateval date) 
return varchar2;

例

select fnd_date.date_to_canonical(hire_date) 
from emp ...

APP_DATE.DATE_TO_DISPLAYDATEとFND_DATE.DATE_TO_DISPLAYDATE

function APP_DATE.DATE_TO_DISPLAYDATE(
dateval date
[calendar_aware=>value])  
return varchar2;

例

declare
my_displaydate varchar2(30);
my_dateval date;
begin
my_displaydate :=
app_date.date_to_displaydate(my_dateval);
end; 

APP_DATE.DATE_TO_DISPLAYDTとFND_DATE.DATE_TO_DISPLAYDT

function APP_DATE.DATE_TO_DISPLAYDT(
dateval date
[calendar_aware=>value])
return varchar2;

例

declare
my_displaydt varchar2(30);
my_dateval date;
begin
my_displaydt :=
app_date.date_to_displaydt(my_dateval);
end; 

APP_DATE.DATE_TO_FIELD

procedure APP_DATE.DATE_TO_FIELD(
	dateval date,
	field varchar2,
	datetime varchar2 default 'DEFAULT',
	date_parameter boolean default FALSE
 	[calendar_aware=>value]);

例

次のコードを

COPY(to_char(my_date_value, 'DD-MON-YYYY {HR24:MI:SS}','my_block.my_date_field');

次のコードに置換します。

app_date.date_to_field(my_date_value, 'my_block.my_date_field');

APP_DATE.FIELD_TO_DATE

function APP_DATE.FIELD_TO_DATE(
	field varchar2 default NULL, 
	date_parameter boolean default FALSE
	[calendar_aware=>value])
 return date;

例

次のコードを

to_date(NAME_IN('my_block.my_date_field'), 'DD-MON-YYYY {HH24:MI:SS}');

次のコードに置換します。

my_date = app_date.field_to_date('my_block.my_date_field');

APP_DATE.VALIDATE_CHARDATE

procedure APP_DATE.VALIDATE_CHARDATE(
	field varchar2 default NULL
	[calendar_aware=>value])

APP_DATE.VALIDATE_CHARDT

procedure APP_DATE.VALIDATE_CHARDT(
 	field varchar2 default NULL
	[calendar_aware=>value])

FND_DATE.STRING_TO_DATE

function FND_DATE.STRING_TO_DATE(
	p_string IN VARCHAR2,
	p_mask   IN VARCHAR2)
RETURN DATE; 

FND_DATE.STRING_TO_CANONICAL

function FND_DATE.STRING_TO_CANONICAL(
	p_string IN VARCHAR2, 
	p_mask   IN VARCHAR2)
RETURN VARCHAR2; 

APP_EXCEPTION: 例外処理API

フォームのために記述したPL/SQLプロシージャから例外を呼び出すには、APPCOREパッケージのAPP_EXCEPTIONを使用します。

APP_EXCEPTION.RAISE_EXCEPTION

procedure  APP_EXCEPTION.RAISE_EXCEPTION(

 exception_type varchar2 default null,
			  exception_code number   default null,
			  exception_text varchar2 default null);

APP_EXCEPTION.RETRIEVE

procedure  APP_EXCEPTION.RETRIEVE;

APP_EXCEPTION.GET_TYPE

function  APP_EXCEPTION.GET_TYPE return varchar2;

APP_EXCEPTION.GET_CODE

function  APP_EXCEPTION.GET_CODE return number;

APP_EXCEPTION.GET_TEXT

function  APP_EXCEPTION.GET_TEXT return varchar2;

APP_EXCEPTION.RECORD_LOCK_EXCEPTION

APP_EXCEPTION.RECORD_LOCK_ERROR

procedure  APP_EXCEPTION.RECORD_LOCK_ERROR (
counter  IN   OUT   number);

APP_EXCEPTION.DISABLED

procedure  APP_EXCEPTION.DISABLED;

APP_FIELD: 項目関連ユーティリティ

この項では、フォーム項目の間の関連を管理するユーティリティについて説明します。

APP_FIELD.CLEAR_FIELDS

procedure  APP_FIELD.CLEAR_FIELDS(

 field1  varchar2, 
			 field2  varchar2 default NULL,
			 field3  varchar2 default NULL,
			 field4  varchar2 default NULL,
			 field5  varchar2 default NULL,
			 field6  varchar2 default NULL,
			 field7  varchar2 default NULL,
			 field8  varchar2 default NULL,
			 field9  varchar2 default NULL,
			 field10 varchar2 default NULL);

APP_FIELD.CLEAR_DEPENDENT_FIELDS

procedure  APP_FIELD.CLEAR_DEPENDENT_FIELDS(

master_field varchar2,
			 field1  varchar2,
			 field2  varchar2 default NULL,
			 field3  varchar2 default NULL,
			 field4  varchar2 default NULL,
			 field5  varchar2 default NULL,
			 field6  varchar2 default NULL,
			 field7  varchar2 default NULL,
			 field8  varchar2 default NULL,
			 field9  varchar2 default NULL,
			 field10 varchar2 default NULL); 

APP_FIELD.SET_DEPENDENT_FIELD

procedure  APP_FIELD.SET_DEPENDENT_FIELD(event           varchar2,
			master_field    varchar2,
			dependent_field varchar2
			invalidate      boolean    default  FALSE);   

procedure  APP_FIELD.SET_DEPENDENT_FIELD(

event           varchar2,
			condition       boolean,
			dependent_field varchar2
			invalidate      boolean    default  FALSE);   

トリガー:

• マスター・フィールドのWHEN-VALIDATE-ITEM

• 条件の基になっているフィールドのWHEN-VALIDATE-ITEM、または従属フィールドのイベントINIT

• PRE-RECORD

• POST-QUERY (従属項目がマルチレコード・ブロックにあるときにのみ必要)

APP_FIELD.SET_EXCLUSIVE_FIELD

procedure  APP_FIELD.SET_EXCLUSIVE_FIELD(

event           varchar2,
			field1           varchar2,
			field2           varchar2,
			field3           varchar2  default NULL);

このプロシージャの使用例は、「相互排他項目」を参照してください。

APP_FIELD.SET_INCLUSIVE_FIELD

procedure  APP_FIELD.SET_INCLUSIVE_FIELD(

event           varchar2,
			field1           varchar2,
			field2           varchar2,
			field3           varchar2  default NULL,
			field4           varchar2  default NULL,
			field5           varchar2  default NULL);

このプロシージャの使用例は、「相互包含項目」を参照してください。

APP_FIELD.SET_REQUIRED_FIELD

procedure  APP_FIELD.SET_REQUIRED_FIELD(

event           varchar2,
			condition       boolean,
			field1           varchar2,
			field2           varchar2  default NULL,
			field3           varchar2  default NULL,
			field4           varchar2  default NULL,
			field5           varchar2  default NULL);

このプロシージャの使用例は、「条件付き必須項目」を参照してください。

APP_FIND: 問合せ検索ユーティリティ

次のルーチンを使用して、「検索」ウィンドウ機能を実装します。

関連項目: 問合せ検索の概要

APP_FIND.NEW

procedure  APP_FIND.NEW(
block_name varchar2);

APP_FIND.CLEAR

procedure  APP_FIND.CLEAR;

APP_FIND.CLEAR_DETAIL

procedure  APP_FIND.CLEAR_DETAIL(

detail_block    varchar2);

例

APP_FIND.CLEAR_DETAIL('MYBLOCK');

APP_FIND.FIND

procedure  APP_FIND.FIND(

block_name    varchar2);

APP_FIND.QUERY_RANGE

procedure  APP_FIND.QUERY_RANGE(

low_value    varchar2/date/number,
			high_value   varchar2/date/number,
			db_item_name varchar2);

APP_FIND.QUERY_FIND

procedure  APP_FIND.QUERY_FIND(

lov_name varchar2);

procedure APP_FIND.QUERY_FIND(
			block_window    varchar2,
			find_window     varchar2,
			find_block      varchar2);

APP_ITEM: 個別項目ユーティリティ

この項では、項目を個別に管理するユーティリティについて説明します。

APP_ITEM.COPY_DATE

procedure  APP_ITEM.COPY_DATE(

date_val  varchar2
			item_name varchar2);

copy(to_char(to_date('01-01-1900', 'DD-MM-YYYY'),
               'DD-MON-YYYY'), 'bar.lamb');

APP_ITEM.IS_VALID

procedure  APP_ITEM.IS_VALID(
        val         varchar2
			dtype       varchar2  default 'DATE');

function APP_ITEM.IS_VALID(
			val         varchar2
			dtype       varchar2  default 'DATE')
return BOOLEAN;

APP_ITEM.SIZE_WIDGET

procedure  APP_ITEM.SIZE_WIDGET(
        wid_name varchar2.
			max_width number default 20);

APP_ITEM_PROPERTY: プロパティ・ユーティリティ

これらのユーティリティは、項目のOracle FormsおよびOracle E-Business Suiteプロパティの制御を支援します。

APP_ITEM_PROPERTY.GET_PROPERTY

function  APP_ITEM_PROPERTY.GET_PROPERTY(
       item_name varchar2, 
			property number) 
			return number;

function  APP_ITEM_PROPERTY.GET_PROPERTY(
			item_id item, 
			property number)
			 return number;

関連項目: 項目プロパティの設定

APP_ITEM_PROPERTY.SET_PROPERTY

procedure  APP_ITEM_PROPERTY.SET_PROPERTY(
       item_name varchar2, 
			property varchar2, 
			value number);

procedure  APP_ITEM_PROPERTY.SET_PROPERTY(
			item_id item, 
			property varchar2,
			value number);

関連項目: 項目プロパティの設定

APP_ITEM_PROPERTY.SET_VISUAL_ATTRIBUTE

procedure  APP_ITEM_PROPERTY.SET_VISUAL_ATTRIBUTE(

item_name varchar2, 
			property number 
			value number);

APP_NAVIGATE: フォーム機能のオープン

すでに開いている同一のフォームのインスタンスを再使用するフォーム機能をオープンする場合には、FND_FUNCTION.EXECUTEではなくこのユーティリティを使用します。その他すべてのフォームや機能のオープンにはFND_FUNCTION.EXECUTEを使用します。

APP_NAVIGATE.EXECUTE

procedure APP_NAVIGATE.EXECUTE( 		
		function_name	in varchar2, 		o
		pen_flag 		in varchar2 default 'Y', 		
		session_flag	in varchar2 default 'SESSION', 		
		other_params	in varchar2 default NULL, 		
		activate_flag	in varchar2 default 'ACTIVATE', 		
		pinned		in boolean  default FALSE);

APP_RECORD: レコード・ユーティリティ

レコード・レベルでブロックと相互作用するユーティリティを次に示します。

APP_RECORD.TOUCH_RECORD

procedure  TOUCH_RECORD(
		block_name		varchar2	default NULL,
	 	record_number		NUMBER	default NULL); 

APP_RECORD.HIGHLIGHT

procedure  APP_RECORD.HIGHLIGHT(
		value		varchar2/number); 

ヒント: 非表示フィールドが多い大規模ブロックのパフォーマンスを向上するには、すべての非表示フィールドをブロックの最後に置き、非表示項目の前にAPPCORE_STOPという名前の非データベース項目を置きます。APP_RECORD.HIGHLIGHTがこのフィールドに達したときにハイライト表示が停止されます。

APP_RECORD.FOR_ALL_RECORDS

procedure  APP_RECORD.FOR_ALL_RECORDS(
		block_name      varchar2, 
		trigger_name     varchar2);

procedure APP_RECORD.FOR_ALL_RECORDS(
			trigger_name     varchar2);

APP_RECORD.DELETE_ROW

procedure  APP_RECORD.DELETE_ROW(
			check_delete        BOOLEAN   default FALSE,
			product_name        varchar2  default NULL,
			message_name        varchar2  default NULL);

function  APP_RECORD.DELETE_ROW(
			check_delete        BOOLEAN   default FALSE,
			product_name        varchar2  default NULL,
			message_name        varchar2  default NULL)
			return BOOLEAN;

APP_RECORD.VALIDATE_RANGE

procedure  APP_RECORD.VALIDATE_RANGE(
		from_item     varchar2,
		to_item       varchar2,
		range_name    varchar2  default NULL,
		event_name    varchar2  default 'WHEN-BUTTON-PRESSED',
		dtype         varchar2  default 'DATE',
		product_name  varchar2  default NULL,
		message_name  varchar2  default NULL);

APP_REGION: リージョン・ユーティリティ

代替リージョンで使用されるユーティリティを次に示します(下位互換性のためにのみサポートされています。代替リージョンはタブに置き換えられています)。

APP_REGION.ALT_REGION

function  APP_REGION.ALT_REGIONS(  		
		poplist_name varchar2)   		     
				return BOOLEAN;

例

if APP_REGION.ALT_REGIONS('CONTROL.LINE_REGIONS') then
    CONTROL.LINE_REGIONS('WHEN-LIST-CHANGED');
end if;

関連項目: 代替リージョンの動作のコーディング

APP_STANDARDパッケージ

APP_STANDARD.APP_VALIDATE

procedure  APP_STANDARD.APP_VALIDATE (scope NUMBER);

APP_STANDARD.EVENT

procedure  APP_STANDARD.EVENT (
		event_name        varchar2);

関連項目: TEMPLATEフォームでの特殊トリガー

APP_STANDARD.SYNCHRONIZE

procedure  APP_STANDARD.SYNCHRONIZE;

APP_STANDARD.PLATFORM

APP_STANDARD.PLATFORM varchar2(30);

例

if APP_STANDARD.PLATFORM = 'MSWINDOWS' then
		MDI_height := get_window_property(FORMS_MDI_WINDOW,
														HEIGHT); end if;  

APP_WINDOW: ウィンドウ・ユーティリティ

ウィンドウ・レベルで動作するユーティリティを次に示します。

APP_WINDOW.CLOSE_FIRST_WINDOW

procedure  APP_WINDOW.CLOSE_FIRST_WINDOW;  

APP_WINDOW.PROGRESS

procedure  APP_WINDOW.PROGRESS( percent    number);  

APP_WINDOW.SET_COORDINATION

procedure  APP_WINDOW.SET_COORDINATION(
		event           varchar2,
		coordination    varchar2,
		relation_name   varchar2);

関連項目: マスター詳細関連

APP_WINDOW.SET_WINDOW_POSITION

procedure  APP_WINDOW.SET_WINDOW_POSITION(
		child          varchar2,
		rel            varchar2,
		parent         varchar2     default  NULL);

関連項目: 非モーダル・ウィンドウ

APP_WINDOW.SET_TITLE

procedure  APP_WINDOW.SET_TITLE(

	window_name  varchar2, 
	session      varchar2,
	instance1    varchar2 default 'APP_ARGUMENT_NOT_PASSED',
	instance2    varchar2 default 'APP_ARGUMENT_NOT_PASSED',
	instance3    varchar2 default 'APP_ARGUMENT_NOT_PASSED');

関連項目: 非モーダル・ウィンドウ

Copyright © 1995, 2013, Oracle and/or its affiliates. All rights reserved.