com.hp.ucmdb.api.classmodel

Interface Attribute

public interface Attribute

The definition of an attribute of a UCMDB class.

Method Summary

Modifier and Type	Method and Description
Object	getDefaultValue() The default value of a non-static attribute.
String	getDescription()
String	getDisplayLabel()
String	getName() The attribute name.
Map<String,Qualifier>	getQualifiers() The qualifiers defined for the attribute.
Object	getResolvedDefaultValue()
Integer	getSize()
Type	getType() The attribute data type.
TypeInfo	getTypeInfo() Additional type information for specific attribute types.
Object	getValue() The value of a static attribute.
boolean	hasQualifier(String qualifierName)
boolean	isFactory()
boolean	isModifiedByUser()
boolean	isStatic() Checks whether the the attribute is "static".

Method Detail

getName

String getName()

The attribute name.

getType

Type getType()

The attribute data type.

isFactory

boolean isFactory()

Returns:

true if this attribute is created by the production, otherwise false

isModifiedByUser

boolean isModifiedByUser()

Returns:

true if this attribute is modified by user, otherwise false

getTypeInfo

TypeInfo getTypeInfo()

Additional type information for specific attribute types. Cast the return value to a specific type info interface.

Example:

      Attribute enumAttr = typeObjectDefinition.getAttribute(AttributesUtils.PROPERTY_ENUM);
      EnumInfo enumInfo = (EnumInfo)enumAttr.getTypeInfo();
      String enumName = enumInfo.getEnumName();
      

Returns:

TypeInfo, or null for types that have no type information.

getValue

Object getValue()
         throws AttributeNotStaticException

The value of a static attribute. Static means the attribute has a single value, not a value for each CI.

Throws:

AttributeNotStaticException - if the attribute is not static

getDefaultValue

Object getDefaultValue()
                throws AttributeStaticException

The default value of a non-static attribute.

Throws:

AttributeStaticException - if the attribute is static

getResolvedDefaultValue

Object getResolvedDefaultValue()

getDisplayLabel

String getDisplayLabel()

getDescription

String getDescription()

getSize

Integer getSize()

getQualifiers

Map<String,Qualifier> getQualifiers()

The qualifiers defined for the attribute.

Returns:

a read-only Map of qualifier name to qualifier object

hasQualifier

boolean hasQualifier(String qualifierName)

isStatic

boolean isStatic()

Checks whether the the attribute is "static". Static means the attribute has a single value, not a value for each CI.

Returns:

true if the attribute is "static"