ユニット core.message
ユーザーメッセージを作成および管理するメソッドを提供するスクリプトユニットです。
addError
procedure addError(message: string)
指定されたエラーメッセージを現在の検証コンテキストに追加します。
例:
uses core.message as msg;
...
export procedure checkRecord(record : .Project)
begin
msg.addError('This is an error message');
end
...
パラメーター:
message: 文字列メッセージ。
使用可能箇所:
addInfo
procedure addInfo(message: string)
指定された情報メッセージを現在の検証コンテキストに追加します。
例:
uses core.message as msg;
...
export procedure checkRecord(record : .Project)
begin
msg.addInfo('This is an info message');
end
...
パラメーター:
message: 文字列メッセージ。
使用可能箇所:
addLocale
function addLocale(userMessage: user\_message, message: string, locale: locale): user\_message
ユーザーメッセージにロケールを追加します。
例:
uses core.message as msg;
export procedure executeScriptTask()
begin
var fr:=locale.of('fr','FR');
var en:=locale.of('en','EN');
var messageEn:=msg.of('A new message',en);
var message:=msg.addLocale(messageEn,'Un nouveau message',fr);
end
パラメーター:
userMessage: ユーザーメッセージ。
message: ロケールの言語での文字列メッセージ。null の場合、空の文字列が使用されます。
locale: ロケール。null の場合、デフォルトのロケールが使用されます。
戻り値:
追加されたロケールを持つ新しいメッセージ。入力 userMessage が null の場合、指定されたロケールのみを持つ新しいユーザーメッセージを作成します。
使用可能箇所:
addMessage
procedure addMessage(message: user\_message)
指定されたユーザーメッセージを現在の検証コンテキストに追加します。
例:
uses core.message as msg;
...
export procedure checkRecord(record : .Project)
begin
var userMessage:=msg.ofBundleError('Key.invalid.value', 'Bundle/path');
msg.addMessage(userMessage);
end
...
パラメーター:
message: ユーザーメッセージ。
使用可能箇所:
addRecordMessage
procedure addRecordMessage(record: record, message: user\_message)
指定されたレコードの現在の検証コンテキストに情報メッセージを追加します。
例:
uses core.message as msg;
...
export procedure checkTable()
begin
var xpath :='/root/table[./id=15]';
var record := d.lookupRecordByFullXPath(table, xpath);
var userMessage:=msg.ofBundleInfo('Key.key2', 'Bundle/path');
msg.addRecordMessage(record,userMessage);
end
...
パラメーター:
record: レコード。
message: ユーザーメッセージ。
使用可能箇所:
addWarning
procedure addWarning(message: string)
指定された警告メッセージを現在の検証コンテキストに追加します。
例:
uses core.message as msg;
...
export procedure checkRecord(record : .Project)
begin
msg.addWarning('This is a warning message');
end
...
パラメーター:
message: 文字列メッセージ。
使用可能箇所:
addXPathMessage
procedure addXPathMessage(xPath: string, message: user\_message)
指定されたXPath述語に一致するレコードの現在の検証コンテキストにユーザーメッセージを追加します。
例:
uses core.message as msg;
...
export procedure checkTable()
begin
var userMessage:=msg.ofBundleError('key.key1', 'Bundle/path');
msg.addXPathMessage('./number<100',userMessage);
end
...
パラメーター:
xPath: メッセージが適用されるレコードのXPath述語。
message: ユーザーメッセージ。
使用可能箇所:
of
function of(message: string, locale: locale): user\_message
単一のロケールに対してユーザーメッセージのインスタンスを作成します。
例:
uses core.message as msg;
export procedure executeScriptTask()
begin
var en:=locale.of('en','EN');
var message:=msg.of('A new message',en);
end
パラメーター:
message: ロケールの言語での文字列メッセージ。null の場合、空の文字列が使用されます。
locale: ロケール。null の場合、デフォルトのロケールが使用されます。
戻り値:
新しいユーザーメッセージ。
使用可能箇所:
ofBundleError
function ofBundleError(path: string, key: string, parameters: list<object>): user\_message
メッセージバンドルからエラーユーザーメッセージのインスタンスを作成します。
バンドルからのユーザーメッセージは、EBX IDE でパスとキーを指定することで作成できます。
例:
uses core.message as msg;
...
export procedure check()
begin
// the error message from the bundle: 'The reference {0} must start with "TIBCO"'
// the reference id is passed as parameter to the message
var message:= message.ofBundleError('bundle/path','reference.starts.tibco',_ebx.root.reference_id);
end
...
パラメーター:
key: バンドル内のメッセージのキー。
parameters: メッセージのパラメーター。
戻り値:
新しいユーザーメッセージ。
使用可能箇所:
ofBundleInfo
function ofBundleInfo(path: string, key: string, parameters: list<object>): user\_message
メッセージバンドルから情報ユーザーメッセージのインスタンスを作成します。
バンドルからのユーザーメッセージは、EBX IDE でパスとキーを指定することで作成できます。
例:
uses core.message as msg;
export procedure executeScriptTask()
begin
// the info message from the bundle: 'The script task {0} has been executed successfully'
// the workflow id is passed as parameter to the message
var message:= message.ofBundleInfo('bundle/path','script.task.info',_ebx.workflow.id);
end
パラメーター:
key: バンドル内のメッセージのキー。
path: バンドルのパス。
parameters: メッセージのパラメーター。
戻り値:
新しいユーザーメッセージ。
使用可能箇所:
ofBundleWarning
function ofBundleWarning(path: string, key: string, parameters: list<object>): user\_message
メッセージバンドルから警告ユーザーメッセージのインスタンスを作成します。
バンドルからのユーザーメッセージは、EBX IDE でパスとキーを指定することで作成できます。
例:
uses core.message as msg;
...
export procedure checkRecord(record : .Department)
begin
// the warning message from the bundle: 'The location of the department {0} is mandatory'
// the department is passed as parameters to the message
var message:= message.ofBundleWarning('bundle/path','location.mandatory',record.department_id);
end
....
パラメーター:
key: バンドル内のメッセージのキー。
path: バンドルのパス。
parameters: メッセージのパラメーター。
戻り値:
新しいユーザーメッセージ。
使用可能箇所:
toString
function toString(userMessage: user\_message, locale: locale): string
指定されたロケールでメッセージをフォーマットします。
例:
uses core.message as msg;
export procedure executeScriptTask()
begin
var label:=_ebx.workflow.label;
var englishLabel:=msg.toString(label,locale.of('en','EN'));
var frenchLabel:=msg.toString(label,locale.of('fr','FR'));
end
パラメーター:
userMessage: ユーザーメッセージ。
locale: ロケール。null の場合、デフォルトのロケールが使用されます。
戻り値:
指定されたロケールでフォーマットされた文字列メッセージ。入力 userMessage が null の場合、null。
使用可能箇所: