Una descrizione proprietà è un'istanza della classe PropertyDescription.
Perché e quando eseguire questa attività
Per aggiungere una descrizione proprietà a una definizione di evento, è necessario prima creare una
nuova descrizione proprietà e impostare i valori dei relativi campi. È, quindi, possibile aggiungere la
descrizione proprietà alla definizione di evento.
Passi per questa attività
- Per creare una nuova descrizione proprietà, creare un'istanza di PropertyDescription, specificando il nome e il percorso della proprietà.
PropertyDescription propDesc = new PropertyDescription(name, path);
I parametri di questo
costruttore sono i seguenti:- nome
- Il nome della proprietà. Deve essere il nome di una proprietà semplice dell'elemento
CommonBaseEvent o di uno dei child.
- percorso
- Un percorso ubicazione XPath che specifica il percorso della proprietà. Per una proprietà di livello superiore di CommonBaseEvent (come severity o priority), path deve essere null.
L'oggetto restituito è un nuovo oggetto PropertyDescription.
- Completare i campi della descrizione proprietà. La classe PropertyDescription
fornisce un metodo setter per ciascuno dei campi contenuti in una descrizione proprietà. Fare riferimento alla documentazione API Javadoc per le informazioni complete su questi metodi. Ad esempio, per specificare che una proprietà è obbligatoria, impostare la proprietà required su true utilizzando il metodo setRequired(boolean):
propDesc.setRequired(true);
- Aggiungere la descrizione proprietà alla definizione di evento utilizzando il metodo
EventDefinition.addPropertyDescription().
definition.addPropertyDescription(propDesc);
Se la definizione di evento comprende già un'altra descrizione proprietà con lo stesso nome e
percorso, viene generata un'eccezione DescriptionExistsException.
Esempio
Il seguente frammento di codice crea una nuova descrizione proprietà, la completa con i dati
e l'aggiunge a una definizione di evento.
PropertyDescription propDesc = new PropertyDescription("severity",null);
propDesc.setRequired(true);
propDesc.setMinValue('30');
// la definizione è una definizione di evento valida
definition.addPropertyDescription(propDesc);