com.genesyslab.ail
Interface SearchInteractionTemplate


public interface SearchInteractionTemplate

A template for interactions searches. It defines a list of attributes used to sort the interactions and a list of attributes to retrieve for those interactions.

See Also:

Note: If the {@link ServiceStatus.Type#DATABASE DATABASE} service is not available, that is, if UCS is not connected, you cannot use features associated with UCS, that is, interaction search.


Method Summary
 void addRetrieveAttribute(InteractionAttributeMetaData attribute)
          Adds an interaction meta data to the list of retrieved attributes.
 void addSortAttribute(InteractionAttributeMetaData attribute, boolean reverse)
          Adds an interaction meta data to the list of sorted attributes.
 int getIndex()
          Gets the index of the first sorted interations to obtain.
 int getLength()
          Gets the number of sorted interations to obtain.
 java.util.Collection getRetrieveAttributes()
          Gets the collection of interaction meta data that will be retrieved.
 java.util.Collection getSortAttributes()
          Gets the collection of SortableInteractionAttribute that will be used for sorting data.
 void removeRetrieveAttribute(InteractionAttributeMetaData attribute)
          Removes an interaction meta data to the list of retrieved attributes.
 void removeSortAttribute(InteractionAttributeMetaData attribute)
          Removes an interaction meta data to the list of sorted attributes.
 void setIndex(int index)
          Sets the index of the first sorted interations to get.
 void setLength(int length)
          Sets the number of sorted interations to get.
 

Method Detail

addSortAttribute

void addSortAttribute(InteractionAttributeMetaData attribute,
                      boolean reverse)
                      throws InvalidParameterException
Adds an interaction meta data to the list of sorted attributes.

Parameters:
attribute - as InteractionAttributeMetaData
reverse - as boolean, true if sort is reverse
Throws:
InvalidParameterException - if attribute does not exist.

removeSortAttribute

void removeSortAttribute(InteractionAttributeMetaData attribute)
Removes an interaction meta data to the list of sorted attributes.

Parameters:
attribute - as InteractionAttributeMetaData

getSortAttributes

java.util.Collection getSortAttributes()
Gets the collection of SortableInteractionAttribute that will be used for sorting data.

Returns:
Collection of SortableInteractionAttribute

setIndex

void setIndex(int index)
Sets the index of the first sorted interations to get.

Parameters:
index - as int

getIndex

int getIndex()
Gets the index of the first sorted interations to obtain.

Returns:
index as int

setLength

void setLength(int length)
Sets the number of sorted interations to get.

Parameters:
length - as int

getLength

int getLength()
Gets the number of sorted interations to obtain.

Returns:
length as int

addRetrieveAttribute

void addRetrieveAttribute(InteractionAttributeMetaData attribute)
                          throws InvalidParameterException
Adds an interaction meta data to the list of retrieved attributes.

Parameters:
attribute - as InteractionAttributeMetaData
Throws:
InvalidParameterException - if attribute does not exist.

removeRetrieveAttribute

void removeRetrieveAttribute(InteractionAttributeMetaData attribute)
Removes an interaction meta data to the list of retrieved attributes.

Parameters:
attribute - as InteractionAttributeMetaData

getRetrieveAttributes

java.util.Collection getRetrieveAttributes()
Gets the collection of interaction meta data that will be retrieved.

Returns:
Collection of InteractionAttributeMetaData