com.genesyslab.ail
Interface CustomAttachedData

All Superinterfaces:
IdObject

public interface CustomAttachedData
extends IdObject

CustomAttachedData is a set of keys for interaction attached data. These keys come with preset values, among which the user can chose the value to assign as attached data to an interaction.


Nested Class Summary
static class CustomAttachedData.Type
          Constants that describe the types of CustomAttachedData.
 
Nested classes/interfaces inherited from interface com.genesyslab.ail.IdObject
IdObject.ObjectType
 
Method Summary
 java.util.Collection getCustomAttachedDataValues()
          Returns the preset values for this CustomAttachedData defined in the Configuration Layer.
 CustomAttachedDataValue getDefaultValue()
          Returns the default value of this enumerator, or null if there is no default value.
 java.lang.String getDescription()
          Returns the description of this CustomAttachedData defined in the Configuration Layer.
 java.lang.String getDisplayName()
          Returns the display name of this CustomAttachedData defined in the Configuration Layer.
 java.lang.String getName()
          Returns the name of this CustomAttachedData defined in the Configuration Layer.
 CustomAttachedData.Type getType()
          Returns the type of this CustomAttachedData defined in the Configuration Layer.
 
Methods inherited from interface com.genesyslab.ail.IdObject
getId, getObjectType
 

Method Detail

getName

java.lang.String getName()
Returns the name of this CustomAttachedData defined in the Configuration Layer.


getDisplayName

java.lang.String getDisplayName()
Returns the display name of this CustomAttachedData defined in the Configuration Layer. This display name should be used for GUI purposes.


getType

CustomAttachedData.Type getType()
Returns the type of this CustomAttachedData defined in the Configuration Layer.


getDescription

java.lang.String getDescription()
Returns the description of this CustomAttachedData defined in the Configuration Layer.


getCustomAttachedDataValues

java.util.Collection getCustomAttachedDataValues()
Returns the preset values for this CustomAttachedData defined in the Configuration Layer. When setting a value, it is recommended but not mandatory to use one of the preset values.

Returns:
a Collection of CustomAttachedDataValue

getDefaultValue

CustomAttachedDataValue getDefaultValue()
Returns the default value of this enumerator, or null if there is no default value.

Since:
7.6