com.genesyslab.ail
Interface ContactAttributeMetaData

All Superinterfaces:
IdObject

public interface ContactAttributeMetaData
extends IdObject

ContactAttributeMetaData is a facility for application to add new information in Contact (customer data) for specific purposes. ContactAttributeMetaData is defined in the Configuration Layer in the Business Attributes/Contact Attributes enumerator folder.

See Also:
ContactManager

Nested Class Summary
static class ContactAttributeMetaData.Type
          Constants that describe the possible types of ContactAttributeMetaData.
 
Nested classes/interfaces inherited from interface com.genesyslab.ail.IdObject
IdObject.ObjectType
 
Method Summary
 ContactAttributeValue createValue(byte[] aValue)
          Returns a binary-typed contact attribute value for this ContactAttributeMetaData as a ContactAttributeValue for byte array value according to the type.
 ContactAttributeValue createValue(java.util.Date aValue)
          Returns a date-typed contact attribute value for this ContactAttributeMetaData as a ContactAttributeValue for Date value according to the type.
 ContactAttributeValue createValue(java.lang.String aValue)
          Returns a string-typed contact attribute value for this ContactAttributeMetaData as a ContactAttributeValue for String value according to the type.
 java.lang.String getDisplayName()
          Returns the display name of this ContactAttributeMetaData as a String.
 java.lang.String getFormat()
          Returns the format of this attribute ContactAttributeMetaData as a String.
 java.util.Date getModifiedDate()
          Returns the modified date of this attribute ContactAttributeMetaData as a Date.
 java.lang.String getName()
          Returns the name of this ContactAttributeMetaData as a String.
 java.util.Collection getPredefinedValues()
          Returns a Collection of predefined contact attribute values or null for this ContactAttributeMetaData as a Collection of ContactAttributeValue.
 ContactAttributeMetaData.Type getType()
          Returns the type of this ContactAttributeMetaData as a Type.
 boolean isActive()
          Returns the active status of this ContactAttributeMetaData as a boolean.
 boolean isCaseSensitive()
          Returns the case sensitive status of this ContactAttributeMetaData as a boolean.
 boolean isSearchable()
          Returns the searchability of this ContactAttributeMetaData as a boolean.
 boolean isSortable()
          Returns the sortability of this ContactAttributeMetaData as a boolean.
 
Methods inherited from interface com.genesyslab.ail.IdObject
getId, getObjectType
 

Method Detail

getName

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

Returns:
the name as String.

getType

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

Returns:
the type as Type.

isSearchable

boolean isSearchable()
Returns the searchability of this ContactAttributeMetaData as a boolean.

Returns:
status as boolean, true if searchable.

isSortable

boolean isSortable()
Returns the sortability of this ContactAttributeMetaData as a boolean.

Returns:
status as boolean, true if sortable.

getDisplayName

java.lang.String getDisplayName()
Returns the display name of this ContactAttributeMetaData as a String.

Returns:
the display name as String.

isActive

boolean isActive()
Returns the active status of this ContactAttributeMetaData as a boolean.

Returns:
status as boolean, true if active.

isCaseSensitive

boolean isCaseSensitive()
Returns the case sensitive status of this ContactAttributeMetaData as a boolean.

Returns:
status as boolean, true if case sensitive.

getFormat

java.lang.String getFormat()
Returns the format of this attribute ContactAttributeMetaData as a String.

Returns:
the format as String.

getModifiedDate

java.util.Date getModifiedDate()
Returns the modified date of this attribute ContactAttributeMetaData as a Date.

Returns:
the date as Date.

createValue

ContactAttributeValue createValue(java.lang.String aValue)
                                  throws RequestFailedException
Returns a string-typed contact attribute value for this ContactAttributeMetaData as a ContactAttributeValue for String value according to the type.

Parameters:
aValue - a String value.
Returns:
a value as ContactAttributeValue.
Throws:
RequestFailedException - if request cannot proceed.

createValue

ContactAttributeValue createValue(java.util.Date aValue)
                                  throws RequestFailedException
Returns a date-typed contact attribute value for this ContactAttributeMetaData as a ContactAttributeValue for Date value according to the type.

Parameters:
aValue - a Date value.
Returns:
a value as ContactAttributeValue.
Throws:
RequestFailedException - if request cannot proceed.

createValue

ContactAttributeValue createValue(byte[] aValue)
                                  throws RequestFailedException
Returns a binary-typed contact attribute value for this ContactAttributeMetaData as a ContactAttributeValue for byte array value according to the type.

Parameters:
aValue - a byte array value.
Returns:
a value as ContactAttributeValue.
Throws:
RequestFailedException - if request cannot proceed.

getPredefinedValues

java.util.Collection getPredefinedValues()
Returns a Collection of predefined contact attribute values or null for this ContactAttributeMetaData as a Collection of ContactAttributeValue. For example: Title ContactAttributeMetaData returns a Collection of 3 ContactAttributeValues with: "M", "Mme", "Mlle".

Returns:
Collection of ContactAttributeValue