Las descripciones de propiedad se definen mediante la especificación
de suceso básico común.
Una descripción de propiedad describe una propiedad que un suceso puede contener.
Puede tratarse de una propiedad definida por la especificación de suceso básico
común como tipo simple. Una descripción de propiedad no puede describir una
propiedad compleja como msgDataElement, pero puede describir una propiedad
simple que sea un hijo de una propiedad compleja. Una definición de suceso puede
contener un número indefinido de descripciones de propiedad (o ninguna descripción
de este tipo).
Una descripción de propiedad incluye los campos siguientes:
- name
- El nombre de la propiedad. Debe ser el nombre de un atributo del elemento
CommonBaseEvent, o un atributo de un subelemento complejo de CommonBaseEvent.
A modo de ejemplo, cabe citar severity,
priority y globalInstanceId.
- path
- Una vía de acceso de ubicación XPath que especifica la vía de acceso de la
propiedad, si la propiedad no es un atributo de CommonBaseEvent. La vía de acceso
identifica la propiedad padre de la propiedad que se describe. A continuación se
indican algunos ejemplos:
- Para describir una propiedad de CommonBaseEvent como severity, no
especifique ninguna vía de acceso. Una vía de acceso nula especifica una propiedad
de nivel superior.
- Para describir una propiedad de msgDataElement,
que es una propiedad compleja de
CommonBaseEvent, debe especificar la vía de acceso msgDataElement.
- Para describir una propiedad de msgHelp, que es una propiedad compleja
de msgDataElement, especifique la vía de acceso msgDataElement/msgHelp.
La vía de acceso también puede describir una instancia específica de
una propiedad que se repite. Por ejemplo, si una definición de suceso describe
varias propiedades de contextDataElements, podría especificar una denominada
businessContext, que utilizaría la vía de acceso
contextDataElements[@name='businessContext'].
- defaultValue
- Valor predeterminado de la propiedad. El valor predeterminado representa el
valor que debe utilizarse durante la cumplimentación del contenido para un suceso
que carece de un elemento de una propiedad necesaria. (Por consiguiente, tiene
sentido que una descripción de propiedad sea necesaria y que defina un valor
predeterminado.) Este campo es opcional.
- required
- Valor booleano que especifica si la propiedad es necesaria u opcional.
Si el valor de este campo es true, la propiedad es necesaria.
Este campo es opcional; si no se especifica, se da por supuesto que la propiedad
es opcional.
- permittedValue
- Valor permitido por la propiedad. Si una definición de suceso sólo permite
determinados valores para una propiedad, cada uno se representa mediante un campo
permittedValue en la descripción de la propiedad. Una descripción de propiedad
puede incluir un número indefinido de valores permitidos. Este campo es opcional y
no debe especificarse si se especifican los campos minValue o
maxValue.
- minValue
- maxValue
- Valores mínimo y máximo permitidos para la propiedad. Si una definición de
suceso permite un rango de valores para una propiedad, estos campos definen los
límites inferior y superior de dicho rango. Si sólo especifica minValue,
el rango permitido no tiene límite superior; si sólo especifica maxValue,
el rango permitido no tiene límite inferior. Estos campos son opcionales y no deben
especificarse si se especifican campos permittedValue.