属性描述由公共基本事件规范定义。
属性描述对事件可以包含的属性作出了描述。它可以是公共基本事件规范定义为简单类型的任何属性。属性描述不能描述复杂属性(如
msgDataElement),但它可以描述简单属性(复合属性的子代)。一个事件定义可以包含任意数目的属性描述(包括“零”个)。
一个属性描述包含以下字段:
- name
- 属性的名称。它必须是 CommonBaseEvent 元素属性或
CommonBaseEvent 的复杂子元素属性的名称。以下是一些示例:severity、priority 和
globalInstanceId。
- path
- 用于指定特性路径的 XPath 位置路径(如果该特性不是 CommonBaseEvent 的属性的话)。该路径标识要描述的属性的父属性。以下是一些示例:
- 要描述 CommonBaseEvent 的属性(如 severity),不要指定路径。null 路径指定顶级属性。
- 要描述 msgDataElement 的属性(它是 CommonBaseEvent 的复杂属性),指定路径 msgDataElement。
- 要描述 msgHelp 的属性(它本身是 msgDataElement 的复杂属性),指定路径 msgDataElement/msgHelp。
路径还可以描述一个重复属性的特定实例。例如,如果事件定义描述若干
contextDataElements 属性,同时您可能指定称为
businessContext 的属性,则应使用路径
contextDataElements[@name='businessContext']。
- defaultValue
- 属性的缺省值。缺省值表示缺少必需属性的事件在内容完成过程中应使用的值。(因此,需要属性描述并定义一个缺省值是有意义的。)此字段是可选的。
- required
- 一个布尔值,它会指定属性是必需的还是可选的。
如果此字段为 true,则属性是必需的。此字段是可选的;如果未指定值,则假定属性为可选。
- permittedValue
- 属性的允许值。如果事件定义仅允许属性使用特定值,则每个值将由属性描述中的 permittedValue
字段表示。属性描述可以包含任意数目的允许值。此字段是可选的,如果指定了
minValue 或 maxValue,则一定不能指定此字段。
- minValue
- maxValue
- 允许的属性最小值和最大值。如果事件定义允许属性使用一定范围内的值,则这些字段将定义该范围的下限和上限。如果仅指定
minValue,则允许的范围没有上限;同样,如果您仅指定 maxValue,则允许的范围没有下限。这些字段是可选的,如果指定了
permittedValue,则一定不能指定这些字段。