プロパティーの記述

プロパティー記述は、Common Base Event 仕様で定義されています。

プロパティー記述は、イベントに含めることのできるプロパティーを記述します。 これは、Common Base Event 仕様によって単純型として定義されている、任意のプロパティーにすることができます。プロパティーの説明は、msgDataElement などの複合プロパティーを記述することができません。 ただし、複合プロパティーの子であるシンプル・プロパティーを記述することができます。イベント定義には、任意の数 (ゼロを含む) のプロパティー記述を含めることができます。

プロパティー記述には、次のようなフィールドが含まれています。

name
プロパティーの名前。 これは、CommonBaseEvent エレメントの属性、または CommonBaseEvent の 複雑なサブエレメントの属性の名前である必要があります。 例として、severitypriority、および globalInstanceId を挙げることができます。
path
プロパティーが CommonBaseEvent の属性ではない場合、プロパティーへの パスを指定する XPath ロケーション・パス。path は、記述されているプロパティーの親プロパティーを識別します。 以下に例を挙げます。
  • severity などの CommonBaseEvent のプロパティーを記述する場合、path を指定しない。ヌル・パスで、最上位のプロパティーが指定されます。
  • CommonBaseEvent の複合プロパティーである msgDataElement のプロパティーを記述するには、path msgDataElement を指定します。
  • msgDataElement の複合プロパティーである msgHelp のプロパティーを記述するには、path msgDataElement/msgHelp を指定します。

パスでは、繰り返されるプロパティーの特定インスタンスを記述することもできます。 例えば、イベント定義がいくつかの contextDataElements プロパティーについて記述している場合、businessContext という名前のプロパティーを指定し、path contextDataElements[@name='businessContext'] を指定することができます。

defaultValue
プロパティーのデフォルト値。 デフォルト値は、必要なプロパティーが欠落しているイベントのコンテンツ完了中に使用される値です。 (このため、プロパティーの説明を要求し、それによってデフォルト値を定義することには意味があります。) このフィールドはオプションです。
required
プロパティーが必須か、またはオプションかを指定するブール値。 このフィールドが true であれば、そのプロパティーは必須です。 このフィールドはオプションです。このフィールドに値が指定されていない場合、 プロパティーはオプションであると想定されます。
permittedValue
プロパティーの許可値。 イベント定義で 1 つのプロパティーに対して特定の値のみが 許可されている場合、それぞれの値は、プロパティーの説明の permittedValue フィールドによって表されます。プロパティー記述には、任意の数の許可値を含めることができます。 このフィールドはオプションで、minValue または maxValue フィールドが指定されている場合は指定してはいけません。
minValue
maxValue
プロパティーの最小許可値および最大許可値。 イベント定義でプロパティーの値の範囲が許可されている場合、これらのフィールドは、 この範囲の上限と下限を定義します。minValue のみを指定した場合、 許可される範囲に上限はありません。同様に、maxValue のみを指定した場合、 許可される範囲に下限はありません。 これらのフィールドはオプションで、permittedValue フィールドが指定されている場合は指定する必要はありません。

ご利用条件 |


(c) Copyright IBM Corporation 2005, 2006.
本製品では Eclipse テクノロジーが採用されています。(http://www.eclipse.org)