Una descripción de propiedad es una instancia de la clase PropertyDescription.
Por qué y cuándo realizar esta tarea
Para añadir una descripción de propiedad a una definición de suceso,
primero debe crear una nueva descripción de propiedad y, a continuación,
establecer los valores de sus campos. A
continuación, puede añadir la descripción de propiedad a la definición de
suceso.
Pasos para realizar esta tarea
- Para crear una nueva descripción de propiedad, cree una
instancia de PropertyDescription, especificando el nombre y la
vía de acceso de la propiedad.
PropertyDescription propDesc = new PropertyDescription(nombre, vía de acceso);
Los parámetros de este constructor son los siguientes:- nombre
- Nombre de la propiedad.
Debe ser el nombre de una propiedad sencilla bien de un elemento
CommonBaseEvent o de uno de sus hijos.
- vía de acceso
- Vía de acceso de la ubicación XPath que especifica la vía de acceso a
la propiedad. Para una propiedad de nivel superior de CommonBaseEvent (como severity o priority), el parámetro vía de acceso debería ser null.
El objeto devuelto es un objeto
PropertyDescription nuevo.
- Rellene los campos de la descripción de propiedad. La clase PropertyDescription proporciona un método setter para cada uno de
los campos de una descripción de propiedad. Consulte la documentación de la API Javadoc para obtener toda la información sobre estos métodos. Por ejemplo,
para especificar que una propiedad sea necesaria, establezca la propiedad
required en true mediante el método setRequired(boolean):
propDesc.setRequired(true);
- Añada la descripción de propiedad a la definición de suceso
mediante el método EventDefinition.addPropertyDescription().
definition.addPropertyDescription(propDesc);
Si la
definición de suceso ya incluye otra descripción de propiedad con los
mismos nombre y vía de acceso, se genera una excepción
DescriptionExistsException.
El siguiente fragmento de código crea una nueva descripción de
propiedad, la rellena con datos y la añade a una definición de suceso.
PropertyDescription propDesc = new PropertyDescription("severity",null);
propDesc.setRequired(true);
propDesc.setMinValue('30');
// la definición es una definición de suceso válida
definition.addPropertyDescription(propDesc);