|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
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.
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 |
|---|
void addSortAttribute(InteractionAttributeMetaData attribute,
boolean reverse)
throws InvalidParameterException
attribute - as InteractionAttributeMetaDatareverse - as boolean, true if sort is reverse
InvalidParameterException - if attribute does not exist.void removeSortAttribute(InteractionAttributeMetaData attribute)
attribute - as InteractionAttributeMetaDatajava.util.Collection getSortAttributes()
SortableInteractionAttribute
that will be used for sorting data.
SortableInteractionAttributevoid setIndex(int index)
index - as intint getIndex()
intvoid setLength(int length)
length - as intint getLength()
int
void addRetrieveAttribute(InteractionAttributeMetaData attribute)
throws InvalidParameterException
attribute - as InteractionAttributeMetaData
InvalidParameterException - if attribute does not exist.void removeRetrieveAttribute(InteractionAttributeMetaData attribute)
attribute - as InteractionAttributeMetaDatajava.util.Collection getRetrieveAttributes()
InteractionAttributeMetaData
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||