com.genesyslab.ail
Interface ContactAttributeValue

All Superinterfaces:
IdObject

public interface ContactAttributeValue
extends IdObject

ContactAttributeValue contains a value for a specific ContactAttributeMetaData.

Note: If the DATABASE service is not available, that is, if UCS is not connected, you cannot get features associated with UCS, that is, interfaces for contact attribute values.

See Also:
ContactManager

Nested Class Summary
static class ContactAttributeValue.Type
          Constants that describe the types of ContactAttributeValue.
 
Nested classes/interfaces inherited from interface com.genesyslab.ail.IdObject
IdObject.ObjectType
 
Method Summary
 java.lang.String getAttributeId()
          Returns the ContactAttributeMetaData identifier of this ContactAttributeValue as a String.
 java.lang.String getAttributeName()
          Returns the ContactAttributeMetaData name of this ContactAttributeValue as a String.
 byte[] getBinValue()
          Returns the binary value of this ContactAttributeValue as a byte array according to the type.
 java.util.Date getDateValue()
          Returns the date value of this ContactAttributeValue as a Date according to the type.
 java.lang.String getDescription()
          Returns the description of this ContactAttributeValue as a String.
 java.lang.String getMimeType()
          Returns the MIME type of the binary value of this ContactAttributeValue as a String.
 java.lang.String getStrValue()
          Returns the string value of this ContactAttributeValue as a String according to the type.
 ContactAttributeValue.Type getType()
          Returns the type of this ContactAttributeValue as a Type.
 boolean isPredefinedValue()
          Returns the predefined status of this ContactAttributeValue as a boolean.
 boolean isPrimary()
          Returns the primary status of this ContactAttributeValue as a boolean.
 void setBinValue(byte[] value)
          Sets the binary value of this ContactAttributeValue as a byte array according to the type.
 void setDateValue(java.util.Date value)
          Sets the date value of this ContactAttributeValue as a Date according to the type.
 void setDescription(java.lang.String string)
          Sets the description of this ContactAttributeValue as a String.
 void setId(java.lang.String anId)
          Sets the unique identifier of the contact attribute value (this is the ContactServerID of the value).
 void setMimeType(java.lang.String aMIMEType)
          Sets the MIME type for the binary value of this ContactAttributeValue as a String.
 void setPrimary(boolean value)
          Sets the primary status of this ContactAttributeValue as a boolean.
 void setStrValue(java.lang.String value)
          Sets the string value of this ContactAttributeValue as a String according to the type.
 
Methods inherited from interface com.genesyslab.ail.IdObject
getId, getObjectType
 

Method Detail

getType

ContactAttributeValue.Type getType()
Returns the type of this ContactAttributeValue as a Type.

Returns:
the type as ContactAttributeValue.Type.

getStrValue

java.lang.String getStrValue()
Returns the string value of this ContactAttributeValue as a String according to the type. For a predefined value, returns the Configuration Layer display name.

Returns:
a value as String.

setStrValue

void setStrValue(java.lang.String value)
Sets the string value of this ContactAttributeValue as a String according to the type.

Parameters:
value - object string value.

getBinValue

byte[] getBinValue()
Returns the binary value of this ContactAttributeValue as a byte array according to the type.

Returns:
a value as byte array.

setBinValue

void setBinValue(byte[] value)
Sets the binary value of this ContactAttributeValue as a byte array according to the type.

Parameters:
value - a byte array value.

getDateValue

java.util.Date getDateValue()
Returns the date value of this ContactAttributeValue as a Date according to the type.

Returns:
a date as Date.

setDateValue

void setDateValue(java.util.Date value)
Sets the date value of this ContactAttributeValue as a Date according to the type.

Parameters:
value - a date value.

getDescription

java.lang.String getDescription()
Returns the description of this ContactAttributeValue as a String. For a predefined value, returns the Configuration Layer description.

Returns:
a description as String.

setDescription

void setDescription(java.lang.String string)
Sets the description of this ContactAttributeValue as a String.

Parameters:
string - value.

isPrimary

boolean isPrimary()
Returns the primary status of this ContactAttributeValue as a boolean. For a predefined value, returns true if the Configuration Layer value is set to 'default'.

Returns:
status as boolean.

setPrimary

void setPrimary(boolean value)
Sets the primary status of this ContactAttributeValue as a boolean.

Parameters:
value - boolean value.

getAttributeName

java.lang.String getAttributeName()
Returns the ContactAttributeMetaData name of this ContactAttributeValue as a String.

Returns:
a name as String.

getAttributeId

java.lang.String getAttributeId()
Returns the ContactAttributeMetaData identifier of this ContactAttributeValue as a String.

Returns:
an ID as String.

getMimeType

java.lang.String getMimeType()
Returns the MIME type of the binary value of this ContactAttributeValue as a String.

Returns:
a Mime Type as String.

setMimeType

void setMimeType(java.lang.String aMIMEType)
Sets the MIME type for the binary value of this ContactAttributeValue as a String.

Parameters:
aMIMEType - Mime Type as String.

setId

void setId(java.lang.String anId)
Sets the unique identifier of the contact attribute value (this is the ContactServerID of the value). To be distinguished from attributeId that is the unique identifier of the contact attribute Enumerator.

Parameters:
anId - an identifier as String.

isPredefinedValue

boolean isPredefinedValue()
Returns the predefined status of this ContactAttributeValue as a boolean. For a predefined value, returns true.

Returns:
status as boolean, true if predefined value.