com.hp.ucmdb.api.types

Interface Element

All Superinterfaces:

ElementProperties

All Known Subinterfaces:

AffectedCI, AffectedRelation, CI, Relation, TopologyCI, TopologyRelation

public interface Element
extends ElementProperties

The common interface of CI and Relation.

Method Summary

Modifier and Type	Method and Description
UcmdbId	getId() The ID of the element.
Property	getProperty(String propertyName) Returns a property object for the property of the specified name.
Object	getPropertyValue(String propertyName) Returns the value of the specified property.
String	getType() The element's class name.
Collection<Property>	properties() Returns the properties of the element as an unmodifiable collection.
Map<String,Property>	propertiesAsMap() Returns the properties of the element as a map from property name to property object.
int	propertiesSize() Returns the number of properties in this element.
void	removeProperty(String propertyName) Removes the property from the element.
void	setBooleanProperty(String name, boolean value)
void	setBytesProperty(String name, byte[] value)
void	setDateProperty(String name, Date value)
void	setDoubleProperty(String name, double value)
void	setFloatProperty(String name, float value)
void	setIntListProperty(String name, int[] value)
void	setIntListProperty(String name, Iterable<Integer> value)
void	setIntProperty(String name, int value)
void	setLongProperty(String name, long value)
void	setPropertyValue(String name, Object value) Sets the property to the value.
void	setStringListProperty(String name, Iterable<String> value)
void	setStringListProperty(String name, String[] value)
void	setStringProperty(String name, String value)
void	setXmlProperty(String name, String value)

Method Detail

getId

UcmdbId getId()

The ID of the element.

getType

String getType()

The element's class name.

properties

Collection<Property> properties()

Returns the properties of the element as an unmodifiable collection.

Specified by:

properties in interface ElementProperties

propertiesAsMap

Map<String,Property> propertiesAsMap()

Returns the properties of the element as a map from property name to property object.

propertiesSize

int propertiesSize()

Returns the number of properties in this element.

Specified by:

propertiesSize in interface ElementProperties

getProperty

Property getProperty(String propertyName)

Returns a property object for the property of the specified name.
Returns null if the client-side representation of the element does not have a value for the property. This does not necessarily mean that the corresponding uCMDB-side element does not have a value for the property.

Specified by:

getProperty in interface ElementProperties

removeProperty

void removeProperty(String propertyName)

Removes the property from the element.

Parameters:

propertyName - name of the property to remove

getPropertyValue

Object getPropertyValue(String propertyName)

Returns the value of the specified property. The class of the returned object is property-type specific. Foer details, see Property.getValue().

Specified by:

getPropertyValue in interface ElementProperties

See Also:

getProperty(java.lang.String)

setPropertyValue

void setPropertyValue(String name,
                      Object value)

Sets the property to the value.
The type of the property is deduced from the class of the value parameter. The following classes are supported:

• Boolean, Integer, Long, Float, Double and String are interpreted as their UCMDB counterparts. Using autoboxing boolean, int, long, float and double can also be passed.
• byte[] is interpreted as BYTES
• Date is interpreted as DATE
• Iterable<String> and String[] are interpreted as STRING_LIST
• Iterable<Integer> and int[] are interpreted as INTEGER_LIST

Specified by:

setPropertyValue in interface ElementProperties

Parameters:

name - name of the property

value - value of the property

setBooleanProperty

void setBooleanProperty(String name,
                        boolean value)

Specified by:

setBooleanProperty in interface ElementProperties

setBytesProperty

void setBytesProperty(String name,
                      byte[] value)

Specified by:

setBytesProperty in interface ElementProperties

setDateProperty

void setDateProperty(String name,
                     Date value)

Specified by:

setDateProperty in interface ElementProperties

setDoubleProperty

void setDoubleProperty(String name,
                       double value)

Specified by:

setDoubleProperty in interface ElementProperties

setFloatProperty

void setFloatProperty(String name,
                      float value)

Specified by:

setFloatProperty in interface ElementProperties

setIntListProperty

void setIntListProperty(String name,
                        int[] value)

Specified by:

setIntListProperty in interface ElementProperties

setIntListProperty

void setIntListProperty(String name,
                        Iterable<Integer> value)

Specified by:

setIntListProperty in interface ElementProperties

setIntProperty

void setIntProperty(String name,
                    int value)

Specified by:

setIntProperty in interface ElementProperties

setLongProperty

void setLongProperty(String name,
                     long value)

Specified by:

setLongProperty in interface ElementProperties

setStringListProperty

void setStringListProperty(String name,
                           String[] value)

Specified by:

setStringListProperty in interface ElementProperties

setStringListProperty

void setStringListProperty(String name,
                           Iterable<String> value)

Specified by:

setStringListProperty in interface ElementProperties

setStringProperty

void setStringProperty(String name,
                       String value)

Specified by:

setStringProperty in interface ElementProperties

setXmlProperty

void setXmlProperty(String name,
                    String value)

Specified by:

setXmlProperty in interface ElementProperties