Oracle Workflow APIリファレンス リリース2.6.3.5 部品番号: B15622-01 |
![]() |
![]() |
![]() |
![]() |
![]() |
||
前へ | 次へ | 目次 | 索引 | 用語集 |
WF_EVENT_Tには、ビジネス・イベント・システムとワークフロー・エンジンがビジネス・イベントを表現するときに使用する、イベント・メッセージ構造を定義します。Oracle Workflow内部では、ビジネス・イベント・システムとワークフロー・エンジンはこの形式でイベントを伝達します。 Oracle Workflowでビジネス・イベント・システムに対して用意されている標準キューの多くは、ペイロード・タイプとしてWF_EVENT_Tを使用します。
注意: カスタム・ペイロード・タイプのキュー(システムに定義済の既存のキューなど)を使用する場合は、キュー・ハンドラを作成して、Workflow標準のWF_EVENT_T構造とカスタム・ペイロード・タイプとを変換する必要があります。 『Oracle Workflow管理者ガイド』のキューの設定に関する項、および『Oracle Workflow開発者ガイド』のキュー・ハンドラの標準APIに関する項を参照してください。
次の表に、WF_EVENT_Tデータ型の属性を示します。
属性名 | データ型 | 説明 |
---|---|---|
PRIORITY | NUMBER | メッセージ受信者がメッセージをデキューするときの優先度。数値が小さいほど、優先度は高くなります。たとえば、1は高い優先度、50は通常の優先度、99は低い優先度を表します。 |
SEND_DATE | DATE | メッセージをデキューできる日時。 この送信日には、システム日付(すぐにデキューされる)または未来日付(後でデキューされる)を設定できます。 イベントが呼び出されたときに送信日が未来日付に設定されている場合、イベント・メッセージはWF_DEFERREDキューに格納され、指定された日付までサブスクリプション処理は開始されません。イベントがエージェントに送信されたときに送信日が未来日付に設定されている場合、イベント・メッセージはそのエージェントのキューに伝播されますが、コンシューマは指定された日付までイベント・メッセージをデキューできません。 |
RECEIVE_DATE | DATE | エージェント・リスナーによってメッセージがデキューされる日時。 |
CORRELATION_ID | VARCHAR2(240) | このメッセージを他のメッセージと関連付けるための相関ID。この属性は初期値は空白で、関数によって設定されます。相関IDに値が設定されている場合、イベントがワークフロー・プロセスに送信されると、その値は項目キーとして使用されます。プロセス・インスタンスの項目キーに使用できるのは、1バイトのキャラクタのみであることに注意してください。マルチバイトの値を含めることはできません。 |
PARAMETER_LIST | WF_PARAMETER_ LIST_T | 追加パラメータの名前と値のペアのリスト。 |
EVENT_NAME | VARCHAR2(240) | イベントの内部名。 |
EVENT_KEY | VARCHAR2(240) | イベントのインスタンスを一意に識別するための文字列。 |
EVENT_DATA | CLOB | イベントの内容の詳細情報。イベント・データはXML文書として作成できる。 |
FROM_AGENT | WF_AGENT_T | イベントの送信元のエージェント。イベントがローカルで発生した場合、この属性の初期値はNULLです。 |
TO_AGENT | WF_AGENT_T | イベントの送信先のエージェント(メッセージ受信者)。 |
ERROR_ SUBSCRIPTION | RAW(16) | このイベントの処理時にエラーが発生した場合、この属性にはエラー発生時に実行されていたサブスクリプションが設定されます。 |
ERROR_MESSAGE | VARCHAR2(4000) | このイベントの処理時にエラーが発生した場合、イベント・マネージャによって生成されるエラー・メッセージ。 |
ERROR_STACK | VARCHAR2(4000) | このイベントの処理時にエラーが発生した場合、イベント・マネージャによって生成される引数のエラー・スタック。エラー・スタックには、エラーの原因を特定するときに役立つコンテキスト情報が格納されます。 |
注意: EVENT_NAME、EVENT_KEYおよびEVENT_DATA属性の値は、setEventName、setEventKeyおよびsetEventDataの各メソッドを使用して個別に設定する以外に、Contentメソッドを使用してイベント・コンテンツ属性をまとめて設定することもできます。 「Content」を参照してください。
同様に、FROM_AGENT、TO_AGENT、PRIORITYおよびSEND_DATE属性の値も、setFromAgent、setToAgent、setPriority、setSendDateの各メソッドを使用して個別に設定したり、Addressメソッドを使用してアドレス属性をまとめて設定することもできます。 「Address」を参照してください。
WF_EVENT_TおよびSYS.AQ$_JMS_TEXT_MESSAGE間のマッピング
STATIC PROCEDURE initialize
(new_wf_event_t in out wf_event_t)
説明
新しいWF_EVENT_Tオブジェクトを初期化するために、PRIORITY属性を0に設定し、Empty_CLOB()関数を使用してEVENT_DATA属性をEMPTYに初期設定し、他のすべての属性をNULLに設定します。
注意: 新しいWF_EVENT_Tオブジェクトを操作するには、まずInitializeメソッドをコールする必要があります。
引数(入力)
new_wf_event_t | 初期化するWF_EVENT_Tオブジェクト。 |
MEMBER FUNCTION getPriority
return number
説明
WF_EVENT_TオブジェクトのPRIORITY属性の値を返します。
MEMBER FUNCTION getSendDate
return date
説明
WF_EVENT_TオブジェクトのSEND_DATE属性の値を返します。
MEMBER FUNCTION getReceiveDate
return date
説明
WF_EVENT_TオブジェクトのRECEIVE_DATE属性の値を返します。
MEMBER FUNCTION getCorrelationID
return varchar2
説明
WF_EVENT_TオブジェクトのCORRELATION_ID属性の値を返します。
MEMBER FUNCTION getParameterList
return wf_parameter_list_t
説明
WF_EVENT_TオブジェクトのPARAMETER_LIST属性の値を返します。
MEMBER FUNCTION getEventName
return varchar2
説明
WF_EVENT_TオブジェクトのEVENT_NAME属性の値を返します。
MEMBER FUNCTION getEventKey
return varchar2
説明
WF_EVENT_TオブジェクトのEVENT_KEY属性の値を返します。
MEMBER FUNCTION getEventData
return clob
説明
WF_EVENT_TオブジェクトのEVENT_DATA属性の値を返します。
MEMBER FUNCTION getFromAgent
return wf_agent_t
説明
WF_EVENT_TオブジェクトのFROM_AGENT属性の値を返します。
MEMBER FUNCTION getToAgent
return wf_agent_t
説明
WF_EVENT_TオブジェクトのTO_AGENT属性の値を返します。
MEMBER FUNCTION getErrorSubscription
return raw
説明
WF_EVENT_TオブジェクトのERROR_SUBSCRIPTION属性の値を返します。
MEMBER FUNCTION getErrorMessage
return varchar2
説明
WF_EVENT_TオブジェクトのERROR_MESSAGE属性の値を返します。
MEMBER FUNCTION getErrorStack
return varchar2
説明
WF_EVENT_TオブジェクトのERROR_STACK属性の値を返します。
MEMBER PROCEDURE setPriority
(pPriority in number)
説明
WF_EVENT_TオブジェクトのPRIORITY属性の値を設定します。
引数(入力)
pPriority | PRIORITY属性の値。 |
MEMBER PROCEDURE setSendDate
(pSendDate in date default sysdate)
説明
WF_EVENT_TオブジェクトのSEND_DATE属性の値を設定します。
引数(入力)
pSendDate | SEND_DATE属性の値。 |
MEMBER PROCEDURE setReceiveDate
(pReceiveDate in date default sysdate)
説明
WF_EVENT_TオブジェクトのRECEIVE_DATE属性の値を設定します。
引数(入力)
pReceiveDate | RECEIVE_DATE属性の値。 |
MEMBER PROCEDURE setCorrelationID
(pCorrelationID in varchar2)
説明
WF_EVENT_TオブジェクトのCORRELATION_ID属性の値を設定します。
引数(入力)
pCorrelationID | CORRELATION_ID属性の値。 |
MEMBER PROCEDURE setParameterList
(pParameterList in wf_parameter_list_t)
説明
WF_EVENT_TオブジェクトのPARAMETER_LIST属性の値を設定します。
引数(入力)
pParameterList | PARAMETER_LIST属性の値。 |
MEMBER PROCEDURE setEventName
(pEventName in varchar2)
説明
WF_EVENT_TオブジェクトのEVENT_NAME属性の値を設定します。
引数(入力)
pEventName | EVENT_NAME属性の値。 |
MEMBER PROCEDURE setEventKey
(pEventKey in varchar2)
説明
WF_EVENT_TオブジェクトのEVENT_KEY属性の値を設定します。
引数(入力)
pEventKey | EVENT_KEY属性の値。 |
MEMBER PROCEDURE setEventData
(pEventData in clob)
説明
WF_EVENT_TオブジェクトのEVENT_DATA属性の値を設定します。
引数(入力)
pEventData | EVENT_DATA属性の値。 |
MEMBER PROCEDURE setFromAgent
(pFromAgent in wf_agent_t)
説明
WF_EVENT_TオブジェクトのFROM_AGENT属性の値を設定します。
引数(入力)
pFromAgent | FROM_AGENT属性の値。 |
MEMBER PROCEDURE setToAgent
(pToAgent in wf_agent_t)
説明
WF_EVENT_TオブジェクトのTO_AGENT属性の値を設定します。
引数(入力)
pToAgent | TO_AGENT属性の値。 |
MEMBER PROCEDURE setErrorSubscription
(pErrorSubscription in raw)
説明
WF_EVENT_TオブジェクトのERROR_SUBSCRIPTION属性の値を設定します。
引数(入力)
pErrorSubscription | ERROR_SUBSCRIPTION属性の値。 |
MEMBER PROCEDURE setErrorMessage
(pErrorMessage in varchar2)
説明
WF_EVENT_TオブジェクトのERROR_MESSAGE属性の値を設定します。
引数(入力)
pErrorMessage | ERROR_MESSAGE属性の値。 |
MEMBER PROCEDURE setErrorStack
(pErrorStack in varchar2)
説明
WF_EVENT_TオブジェクトのERROR_STACK属性の値を設定します。
引数(入力)
pErrorStack | ERROR_STACK属性の値。 |
MEMBER PROCEDURE Content
(pName in varchar2,
pKey in varchar2,
pData in clob)
説明
EVENT_NAME、EVENT_KEYおよびEVENT_DATAなど、WF_EVENT_Tオブジェクトのすべてのイベント・コンテンツ属性の値を設定します。
引数(入力)
pName | EVENT_NAME属性の値。 |
pKey | EVENT_KEY属性の値。 |
pData | EVENT_DATA属性の値。 |
MEMBER PROCEDURE Address
(pOutAgent in wf_agent_t,
pToAgent in wf_agent_t,
pPriority in number,
pSendDate in date)
説明
FROM_AGENT、TO_AGENT、PRIORITYおよびSEND_DATEなど、WF_EVENT_Tオブジェクトのすべてのアドレス属性の値を設定します。
引数(入力)
pOutAgent | FROM_AGENT属性の値。 |
pToAgent | TO_AGENT属性の値。 |
pPriority | PRIORITY属性の値。 |
pSendDate | SEND_DATE属性の値。 |
MEMBER PROCEDURE AddParameterToList
(pName in varchar2,
pValue in varchar2)
説明
WF_EVENT_TオブジェクトのPARAMETER_LIST属性に格納されているリストに、新しいパラメータの名前と値のペアを追加します。指定された名前のパラメータがパラメータ・リストにすでに存在する場合は、そのパラメータの前の値が上書きされます。
引数(入力)
pName | パラメータ名。 |
pValue | パラメータ値。 |
MEMBER FUNCTION GetValueForParameter
(pName in varchar2) return varchar2
説明
WF_EVENT_TオブジェクトのPARAMETER_LIST属性に格納されているリストから、指定されたパラメータの値を返します。このメソッドは、パラメータ・リストの終わりから先頭方向に検索します。指定された名前のパラメータがパラメータ・リストにない場合は、GetValueForParameterメソッドによってNULLが返されます。
引数(入力)
pName | パラメータ名。 |
前へ | 次へ | 目次 | 索引 | 用語集 |