Order Managementの拡張機能で使用できるメソッド
オーダー管理拡張で使用できるメソッドの詳細を取得します。
canApplyHoldメソッド
canApplyHoldは、明細がモデルまたはキットの子明細ではなく、明細に保留を適用していないことを確認します。
boolean canApplyHold(def line, def holdCode) {
if (isChildLine(line)) {
debug("is child line");
return false;
}
if (holdExists(line, holdCode)) {
debug("hold already exists");
return false;
}
return true;
}
canApplyHoldは値を返します。
- true. 明細はモデルまたはキットの子明細ではなく、明細に保留を適用していません。
- false. 明細がモデルまたはキットの子明細であるか、すでに明細に保留を適用しています。
詳細は、「Order Management拡張を使用した保留の適用」を参照してください。
デバッグ・メソッド
debug
メソッドを使用して、拡張を使用して保留を適用したときに発生する可能性のある問題のトラブルシューティングに役立つ詳細を取得します。 詳細は、「オーダー管理拡張のテスト」のデバッグ・メソッドの使用サブ・トピックを参照してください。
実行コンテキスト・メソッド
ExecutionContextメソッドは、SOAP webサービスをコールします。
次の書式を使用します
SoapServiceResponse invokeSoapService(String integrationName, String xmlStr)
説明
-
integrationName。 統合の名前を識別します。
-
xmlStr。 文字列形式のSOAP本文のXML表現。
ExecutionContextは詳細を返します。
パラメータ |
説明 |
---|---|
|
文字列 現在実行中のオーダー管理拡張の名前。 |
|
文字列 拡張をトリガーしたイベントを識別する略称です。 |
|
Logger. 拡張機能がログを書き込むことができるロガー。 |
|
オーダー管理拡張のコードからwebサービスをコールするために使用できるサービスを返します。 |
|
現在サインインしているユーザーの名前を返します。 |
|
いずれかを返します。
説明
|
|
ユーザーが現在のセッションで使用している言語を識別する略称を返します。 |
|
java.sql.Dateのインスタンスで現在のシステム日付を返します。 |
|
java.sql.Timestampオブジェクトの現在のシステム時間を返します。 |
添付の取得メソッド
getAttachments()メソッドを使用して、次の属性を取得します:
エンティティ |
コードで使用する値 |
親 |
すべてのイベントでの読取り |
保存中または発行リクエストの開始中の書込み |
送信リクエストの終了時の書込み |
---|---|---|---|---|---|
ヘッダー添付 |
該当なし |
ヘッダー |
Yes |
Yes |
Yes |
履行明細添付 |
該当なし |
ライン |
Yes |
Yes |
No |
holdExistsメソッド
明細に保留を適用したかどうかを確認します。
boolean holdExists(def line, def holdCode) {
ArrayList holds = line.getHolds();
for (hold in holds) {
if (holdCode.equals(hold.getAttribute("HoldCode"))) {
debug("Found hold code on line");
return true;
}
}
return false;
}
holdExistsは値を返します。
- true. 明細にはすでに保留を適用しました。
- false. 明細に保留を適用していません。
isChildLineメソッド
ラインがモデルまたはキットの子であるかどうかを確認します。
boolean isChildLine(def line) {
def rootParentLineId = line.getAttribute("RootParentLineReference");
def fulfillLineId = line.getAttribute("FulfillmentLineIdentifier");
return (rootParentLineId != null && rootParentLineId != fulfillLineId);
}
isChildLineは値を返します。
- true. 明細は、モデルまたはキットの子明細です。
- false. 明細がモデルまたはキットの子明細ではありません。
isFirstDraftOrderメソッド
販売オーダーが下書きステータスであることを確認します。
boolean isFirstDraftOrder() {
String statusCode = header.getAttribute("StatusCode");
if ("DOO_DRAFT".equals(statusCode)) {
def cvn = header.getAttribute("ChangeVersionNumber");
if (cvn == 1) {
return true;
}
}
return false;
}
isFirstDraftOrderは値を返します。
- true. 販売オーダーは下書きステータスです。
- false. 販売オーダーは下書きステータスではありません。
ロガー・メソッド
Loggerメソッドは、メッセージ・ログを返します。
次の書式を使用します
フォーマット |
説明 |
---|---|
|
いずれかを返します。
説明
|
|
説明
|
|
メッセージを詳細レベルで保存します。 説明
|
|
説明
|
|
メッセージをより細かく保存します。 説明
|
|
説明
|
|
説明
|
|
メッセージを重大レベルで保存します。 説明
|
|
メッセージを重大レベルで保存します。 説明
|
メッセージ・メソッド
Messageメソッドでは、メッセージ・タイプとメッセージ・テキストを使用して、販売オーダーのメッセージを作成します。 デフォルトでは、ORA_MANAGE_EXTENSIONSリクエスト関数を使用してメッセージをログに記録します。
デフォルトのメッセージ・カテゴリを使用し、トークンを使用しないリテラル・メッセージを表示するために使用する書式を次に示します。
Message(MessageType type, String text)
説明
-
「タイプ」。 メッセージのタイプ ERRORまたはWARNINGを使用できます。
-
「本書」。 表示するメッセージのテキストで、一組の二重引用符( ")で囲みます。
リテラル文字列を含む警告メッセージの例を次に示します。
Message(MessageType Message.MessageType.WARNING, String "This is the warning message.")
リテラル文字列を含むエラー・メッセージを次に示します。
Message(MessageType Message.MessageType.ERROR, String "This is the error message.")
メッセージ名およびトークンの指定
メッセージ名およびメッセージ・トークン・パラメータを指定するために使用する書式を次に示します。
Message(MessageType type, String name, Map<String, Object> parameters)
説明
-
「タイプ」。 メッセージのタイプ ERRORまたはWARNINGを使用できます。
-
「名前」。 「メッセージの管理」ページからのメッセージの名前。
次に、このメッセージの属性が「メッセージの管理」ページで使用する必要がある値を示します。
属性
値
アプリケーション
分散オーダー・オーケストレーション
モジュール
分散オーダー・オーケストレーション
詳細は、「オーダー管理でのメッセージの設定」を参照してください。
-
「パラメータ」。 メッセージ・トークンおよびトークン値を含むマップ。 Messageメソッドでは、このマップを使用してトークンに値を移入します。 これらのトークンはメッセージの一部です。
DOO_CUST_RELATIONSHIP_WARNINGという名前のメッセージの内容を表示するコードの例を次に示します。
Message(MessageType Message.MessageType.WARNING, String "DOO_CUST_RELATIONSHIP_WARNING", Map<String, Object> messageParams)
販売オーダーおよび販売オーダー明細のメッセージの作成
リクエスト機能、メッセージ名およびメッセージ・トークン・パラメータを使用して、販売オーダーまたはオーダー明細のメッセージを作成できます。 Messageメソッドは、指定したリクエスト関数を使用してメッセージをログに記録します。
販売オーダーに使用する書式を次に示します。
Message(MessageType type, String requestFunction, String name, Map string, object msgParams)
オーダー明細に使用する書式を次に示します。
Message(MessageType type, String requestFunction, Object line, String name, Map string, object msgParams)
説明
-
「オブジェクト行」。 メッセージのロギング時に参照するオーダー明細を識別します。
その他のパラメータの詳細は、このトピックの「メッセージ・リポジトリ」のトークンのマップに関する項を参照してください。
リクエスト関数を使用するコードの例を次に示します。
Message(MessageType Message.MessageType.WARNING, String "DEMO_REQFUNC", String "DOO_CUST_RELATIONSHIP_WARNING", Map string, object msgParams)
説明
-
DEMO_REQFUNCは、参照DOO_MSG_REQUEST_FUNCTIONの値です。
行セット・イテレータ・メソッド
RowSetIteratorメソッドは、イテレータの行を管理します。
次の書式を使用します
Row first()
RowSetIteratorは詳細を返します。
パラメータ |
説明 |
---|---|
|
イテレータの最初の行を返します。 |
|
現在の行の後に別の行が存在するかどうかを示すブール値を返します。 |
|
イテレータ内の次の行を返します。 現在の行の後に行が存在しない場合、このパラメータはNULL値を返します。 |
|
イテレータの最後の行を返します。 |
|
現在の行の前に別の行が存在するかどうかを示すブール値を返します。 |
|
イテレータの前の行を返します。 現在の行の前に行が存在しない場合、このパラメータはNULL値を返します。 |
|
新しい行を作成します。 エンティティで新規行の作成がサポートされていない場合、拡張でこのメソッドをコールすると、このパラメータはエラー・メッセージを返します。 |
|
現在のイテレータに行を挿入します。この行には、挿入する行番号を指定します。 このメソッドは、イテレータの作成後にイテレータに新しい行を追加するために使用します。 |
サービス起動側メソッド
ServiceInvokerメソッドはサービスをコールします。
検証例外メソッド
ValidationExceptionメソッドは、指定したエラー・テキストを使用して検証例外を作成します。 指定したメッセージ・テキストが表示されます。
次の書式を使用します
ValidationException(String messageText)
メッセージ・リポジトリからのメッセージの表示
ValidationExceptionは、Oracle Applicationsメッセージ・リポジトリからエラー・メッセージ・テキストを取得し、トークン値を移入してから、オーダー管理作業領域にメッセージを表示できます。
次の書式を使用します
ValidationException(String name, Map string, object parameters)
説明
-
「名前」。 「メッセージの管理」ページで指定したメッセージの名前。
-
「パラメータ」。 メッセージ・トークンおよびトークン値を含むマップ。 ValidationExceptionはこのマップを使用して、トークンにメッセージ内の値を移入します。
メッセージ・リポジトリのトークンのマップ
これは、指定するマップを作成するためにValidationExceptionとともに使用する形式です。
ValidationException(java.lang.String requestFunction, java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> parameters)
説明
-
requestFunction。 メッセージをログに記録するリクエスト関数の参照コード。 リクエスト機能を定義するには、リクエスト機能という名前のオーダー管理参照を使用します。 このパラメータが空の値を渡した場合、ValidationExceptionはリクエスト関数をORA_MANAGE_EXTENSIONSにデフォルト設定します。
-
「名前」。 「メッセージの管理」ページで指定したメッセージの名前。 「メッセージの管理」ページを使用する場合は、このメッセージのアプリケーションとして分散オーダー・オーケストレーションを指定する必要があります。
-
「パラメータ」。 メッセージ・トークンおよびトークン値を含むマップ。 ValidationExceptionはこのマップを使用して、トークンにメッセージ内の値を移入します。
メッセージ・リポジトリからのメッセージ・オブジェクトの表示
ValidationExceptionは、メッセージ・オブジェクトのリストを使用して検証例外を作成できます。 複数のメッセージを含む検証エラーに対応できます。
次の書式を使用します
ValidationException(List message messages)
説明
-
「メッセージ」。 メッセージ・オブジェクトのリスト。 メッセージ・オブジェクトの作成方法の詳細は、このトピックの「メッセージ・メソッド」の項を参照してください。
参照参照コードの使用
参照コードの参照に使用する書式を次に示します。
throw new ValidationException("lookup_code")
DOO_MSG_REQUEST_FUNCTIONという名前の参照タイプには、参照コードが含まれます。
参照コード |
説明 |
---|---|
ASSIGN_PROC |
プロセス割当。 |
MANAGE_TASK |
履行タスク。 |
MANAGE_HOLD |
保留 |
MANAGE_PROC |
履行プロセス。 |
PLAN_PROC |
履行プランニング。 |
PROC_CHANGE |
変更オーダー |
XFORM_ORDER |
オーダー変換。 オーダー管理が受信ソース・オーダーを販売オーダーに変換する前に格納するために使用する事業所。 |
VALD_CONSTRAINT |
処理制約。 |
VALD_PROC_DEFN |
プロセス定義。 |
VALD_ACTION_ELGB |
処理適格。 |
ORA_VALD_ORDER_DATA |
オーダーの検証。 |
ORA_VALD_CONFIG |
構成 |
ORA_VALD_PRICING |
価格設定 |
ORA_NOTIFY_EVENT |
イベント通知。 |
ORA_VALD_PAYMENT |
支払 |
ORA_VERIFY_TRADE_COMPLIANCE |
履行明細が取引コンプライアンス・ポリシーを満たしているかどうかを確認します。 |
ORA_CREDIT_CHECK |
与信チェック失敗を確認します。 |
ORA_ORDER_APPROVALS |
オーダー承認メッセージのメッセージ機能分類です。 |
ORA_MANAGE_EXTENSIONS |
拡張フレームワークが記録するメッセージのデフォルト・タイプです。 |
これらの参照コードのいずれかを指定することも、参照に新しい参照コードを追加することもできます。
ビュー・オブジェクト・メソッド
ViewObjectメソッドは、ビューの基準を検索して返します。
次の書式を使用します
ViewCriteria getViewCriteria(name)
説明
-
「名前」。 ビュー基準の名前。
ビュー基準は、ビュー・オブジェクトのWHERE句の行基準のリストです。 各行基準は、各属性の基準を含む配列です。
ビュー基準の作成
次の書式を使用します
ViewCriteria createViewCriteria()
ViewObjectは、新しいビュー基準オブジェクトを返します。
ビュー基準に従った行の検索
指定したビュー基準に従って行を検索し、イテレータで返すために使用する形式を次に示します。
RowIterator findByViewCriteria(ViewCriteria viewCriteria, int numberOfRows)
説明
-
viewCriteria。 行の検索に使用するビュー基準の名前。
-
numberOfRows。 返される行数。 次のいずれかを使用します。
-
-1。 ビュー基準に一致するすべての行を取得します。
-
正の整数 行のサブセットを取得します。 たとえば、
3
を使用して、基準に一致する最初の3行を取得します。 条件に一致する行が2行のみの場合は、この2行のみが返されます。
-
たとえば、すべての行を取得し、vc
という名前のローカル変数に格納するコードを次に示します。
def rowset = itemPVO.findByViewCriteria(vc, -1);
変数名と値の配列を含める書式を次に示します。
RowIterator findByViewCriteriaWithBindVars(ViewCriteria viewCriteria, int maxNumOfRows, String[] variableNames, Object[] variableValues)
説明
-
variableNames。 ビュー基準で使用する変数名の配列。
-
variableValues。 ビュー基準で使用する変数値の配列。
ビュー基準の名前に従って行を検索するために使用する書式を次に示します。
RowIterator findByViewCriteriaWithBindVars(String viewCriteriaName, int maxNumOfRows, String[] variableNames, Object[] variableValues)
説明
-
viewCriteriaName。 行の検索に使用するビュー基準の名前。
詳細は、「Oracle Applications Cloudのパブリック・ビュー・オブジェクト(ドキュメントID 2386411.1)」を参照してください。
住所メソッド
これらのメソッドは、住所データとともに使用できます。
- public Address(String addressLine1, String addressLine2, String addressLine3, String addressLine4, String city, String state, String postalCode, String county, String province, String country)
- public void setAddress1(String address1)
- public String getAddress1() { return mAddress1; }
- public void setAddress2(String address2)
- public String getAddress2() { return mAddress2; }
- public void setAddress3(String address3)
- public String getAddress3() { return mAddress3; }
- public void setAddress4( () {String address4; }
- public String getAddress4() { return mAddress4; }
- public void setCity(String city)
- public String getCity() { return mCity; }
- public void setPostalCode(String postalCode)
- public String getPostalCode() {return mPostalCode; }
- public void setState(String state)
- public String getState() { return mState; }
- public void setProvince(String province)
- public String getProvince() { return mProvince; }
- public void setCounty(String county)
- public String getCounty() { return mCounty; }
- public void setCountry(String country)
- public String getCountry() { return mCountry; }
添付メソッド
これらのメソッドを使用して、添付を管理できます。
- public String getDatatypeCode() { return mDatatypeCode; }
- public void setDatatypeCode(String datatypeCode)
- public void setAttachedDocumentId(Long attachedDocumentId)
- public長いgetAttachedDocumentId() { return mAttachedDocumentId; }
- public void setCategoryName(String mCategoryName)
- public String getCategoryName() { return mCategoryName; }
- public void setDocumentAttributes(String documentAttributes)
- public String getDocumentAttributes() { return mDocumentAttributes; }
- public void setDescription(String description)
- public String getDescription() { return mDescription; }
- public void setEntityAttributes(String entityAttributes)
- public String getEntityAttributes() { return mEntityAttributes; }
- public void setEntityName(String entityName)
- public String getEntityName() { return mEntityName; }
- public void setFileContentType(String fileContentType)
- public String getFileContentType() { return mFileContentType; }
- public void setFileName(String fileName)
- public String getFileName() { return mFileName; }
- public void setPk1Value(String pk1Value )
- public String getPk1Value() { return mPk1Value; }
- public void setTitle(String title)
- public String getTitle() { return mTitle; }
- public void setUrl(String url)
- public String getUrl() { return mUrl; }
- public BlobDomain getFileContent() { return mFileContent; }
- public void setFileContent(byte[] fileContent)
- public void setFileContent(BlobDomain fileContent) { }
- public String getText() { return mText; }
- public void setText(String text)
- public void setDocumentName(String documentId)
- public String getDocumentName() { return mDocumentId; }
- public void setDocumentIdentifier(String documentVersion)
- public String getDocumentIdentifier() { return mDocumentVersion; }
- public void setContentRepositoryFileShared(boolean contentRepositoryFileShared)
-
public boolean isContentRepositoryFileShared() { return mContentRepositoryFileShared; }
CreateLineParamsメソッド
これらのメソッドは、CreateLineParams操作で使用できます。
- public void setProductIdentifier(Long productIdentifier)
- public void setProductNumber(String productNumber)
- public String getProductNumber()
- public void setOrderedUOMCode(String orderedUOMCode)
- public String getOrderedUOMCode()
- public void setOrderedUOM(String orderedUOM)
- public String getOrderedUOM()
- public void setOrderedQuantity(BigDecimal orderedQuantity)
- パブリックBigDecimal getOrderedQuantity()
拡張可能フレックスフィールド・メソッド
これらのメソッドは、拡張がオーダー・ヘッダーまたはオーダー明細の拡張可能フレックスフィールドを参照する場合に使用できます。
メソッド | 説明 |
---|---|
public getOrCreateContextRow(String contextCode) |
このメソッドは、拡張可能フレックスフィールドに対して値を書き込むか、または拡張可能フレックスフィールドから値を取得するために使用します。 フレックスフィールド・コンテキスト内の値を返します。 コンテキストがまだ存在しない場合、メソッドは新しいコンテキストを作成して返します。 フレックスフィールド・コンテキストのコードを取得するには、このメソッドでcontextCodeパラメータを使用します。 コンテキストが存在する場合、メソッドはコンテキストを返し、それ以外の場合は新しいコンテキストを作成して返します。 |
public Row getContextRow(String contextCode) | getOrCreateContextRowと同じことを行いますが、現在拡張可能フレックスフィールドに含まれる値のみを取得します。 |
オーダー・ヘッダーおよびオーダー明細メソッド
これらのメソッドは、オーダー・ヘッダーまたはオーダー明細で使用できます。
メソッド | 説明 |
---|---|
「パブリック」 String getAttribute(String attributeName) |
メソッドのattributeNameパラメータで指定した属性の値を取得します。 attributeNameパラメータで属性の名前またはエンティティ名を指定します。 getAttributeを使用して、次のヘッダー・エンティティの値を取得することもできます:
ヘッダー・エンティティのコレクションを戻すことができます。 |
公開リストgetAttachments() | オーダー・ヘッダーまたはオーダー明細にある添付のリストを取得します。 |
public createAttachment(Attachment attachment) | オーダー・ヘッダーまたはオーダー明細に添付を追加します。 |
public deleteAttachment(Attachment attachment) | オーダー・ヘッダーまたはオーダー明細から添付を削除します。 |
public duplicateAttachments(List attachmentList) | オーダー・ヘッダーまたはオーダー明細にある添付を複製します。 |
public行createNewLine(CreateLineParams createLineParams) |
無料品目を追加します。 追加した行の行オブジェクトを返します。 次に対してcreateNewLineを使用する場合:
|
public boolean isSellingProfitCenterUserUpdated() | trueまたはfalseを含みます。 True: ユーザーがSellingProfitCenter属性を更新しました。 False: ユーザーはSellingProfitCenter属性を更新しませんでした。 |
住所メソッド
拡張機能では、メソッドのパラメータで指定したアドレス・データを使用して、属性の値を検索します。
メソッド | 説明 |
---|---|
public void setShipToAddress(Address address) | オーダー明細の出荷先住所属性を設定します。 |
public void setBillToAddress(Address address) | オーダー明細の請求先住所属性を設定します。 |
public void setSupplierAddress(Address address) | オーダー明細でサプライヤの住所属性を設定します。 |
public void setDestinationShippingAddress(Address address) | オーダー明細の搬送先出荷先住所属性を設定します。 |
public void setFinalDischargeLocationAddress(Address address) | オーダー明細に最終荷下ろし住所属性を設定します。 |
パーティ・メソッド
拡張では、メソッドのパラメータで指定した個人データを使用して、属性の値を検索します。
メソッド | 説明 |
---|---|
public void setShipToParty(Person person) | オーダー明細の出荷先パーティ属性を設定します。 |
public void setShipToContact(Person person) | オーダー明細の出荷先担当者属性を設定します。 |
public void setBillToAccount(Person person) | オーダー明細の請求先顧客属性を設定します。 |
public void setBillToContact(Person person) | オーダー明細の請求先担当者属性を設定します。 |
オーダー明細メソッド
メソッド | 説明 |
---|---|
public String getAttribute(String attributeName) |
オーダー明細から任意の属性の値を取得します。 attributeNameパラメータで属性の名前を指定します。 attributeNameパラメータを使用して、行エンティティにある次のエンティティのいずれかを指定することもできます:
このメソッドを使用して拡張可能フレックスフィールドの値を取得することはできません。 |
public setAttribute(String attributeName, Object value) |
オーダー明細で属性の値を設定します。
|
公開リストgetTransformedLines() |
現在の行の内線番号が変換された行のリストを取得します。 変換された行は、空き品目を含む行です。 |
public boolean isTransformed() | trueまたはfalseを含みます。 True: オーダー明細は変換された明細です。 False: オーダー明細は変換済明細ではありません。 |
public boolean isOpen() | trueまたはfalseを含みます。 True: オーダー明細がオープンしています。 False: オーダー明細がオープンしていません。 |
public boolean isClosed() | trueまたはfalseを含みます。 True: オーダー明細はクローズされています。 False: オーダー明細がクローズされていません。 |
public boolean isCanceled() | trueまたはfalseを含みます。 True: オーダー明細が取り消されます。 False: オーダー明細が取り消されていません。 |
公開リストgetHolds() | オーダー明細にある保留のリストを取得します。 |
public Hold applyHold(String holdCode) |
オーダー明細に保留を適用します。 このメソッドは、追加したばかりの保留オブジェクトも返します。 |
個人メソッド
- public Person(String firstName, String lastName)
- public Person(String firstName, String middleName, String lastName)
- public Person(String firstName, String lastName, String middleName, String suffix, String title)
- public void setFirstName(String firstName)
- public String getFirstName() {return mFirstName;}
- public void setLastName(String lastName)
- public String getLastName() {return mLastName;}
- public void setMiddleName(String middleName
- public String getMiddleName() {return mMiddleName; }
- public void setSuffix(String suffix)
- public String getSuffix() {return mSuffix;}
- public void setTitle(String title)
- public String getTitle() {return mTitle; }