com.ibm.pim.attribute
Interface AttributeDefinitionProperty


public interface AttributeDefinitionProperty

This interface provides methods to define and modify properties of an attribute An AttributeDefinitionProperty can have single or multiple values depending on the property type.

Since:
6.0.0

Nested Class Summary
static class AttributeDefinitionProperty.Name
          All possible property names of an attribute definition.
 
Field Summary
static java.lang.String copyright
           
 
Method Summary
 AttributeDefinitionProperty.Name getName()
          Returns the type of this AttributeDefinitionProperty
 java.lang.String getValue()
          Returns the String value of this AttributeDefinition property.
 java.util.Collection<java.lang.String> getValues()
          Returns a java.util.Collection containing the String values of this AttributeDefinition property.
 boolean isSingleValued()
          Determine whether the AttributeDefinitionProperty has single or multiple values.
 void setValue(java.lang.Object value)
          Sets the value of this attribute
 void setValues(java.util.List<java.lang.Object> values)
          Sets the values of a property, if the property in question can have multiple values
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

getValue

java.lang.String getValue()
Returns the String value of this AttributeDefinition property. If the property has multiple values then it will return the first value.

Returns:
String - The attribute value as a String
Throws:
PIMInternalException - If an internal error occurs

getValues

java.util.Collection<java.lang.String> getValues()
Returns a java.util.Collection containing the String values of this AttributeDefinition property.

Returns:
Collection of String objects containing values
Throws:
PIMInternalException - If an internal error occurs

isSingleValued

boolean isSingleValued()
Determine whether the AttributeDefinitionProperty has single or multiple values. If it returns true then use getAttributeValue() otherwise getAttributeValues().

Returns:
true if attribute has only one value, otherwise false.
Throws:
PIMInternalException - If an internal error occurs

getName

AttributeDefinitionProperty.Name getName()
Returns the type of this AttributeDefinitionProperty

Returns:
Type - Type of this property
Throws:
PIMInternalException - If an internal error occurs

setValue

void setValue(java.lang.Object value)
Sets the value of this attribute

Parameters:
value - object
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use

setValues

void setValues(java.util.List<java.lang.Object> values)
Sets the values of a property, if the property in question can have multiple values

Parameters:
values - List of values
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use