|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface HistoryManager
Manager of the contact histories stored in UCS database.
Note: If the DATABASE service is not available, that is, if UCS is not connected,
you cannot get features associated with UCS, that is, the history manager and contact histories.
| Method Summary | |
|---|---|
SearchInteractionTemplate |
createSearchInteractionTemplate()
Creates an empty SearchInteractionTemplate instance. |
History |
getHistory(Contact aContact,
SearchInteractionTemplate aSearchTemplate,
boolean _archive)
Returns the history of a contact. |
HistoryItem |
getHistoryItem(java.lang.String id)
Returns the history item with this ID. |
InteractionAttributeMetaData |
getInteractionAttributeMetaDataForOwnerId()
Creates an interaction attribute meta data InteractionAttributeMetaData instance
for ownerId. |
InteractionAttributeMetaData |
getInteractionAttributeMetaDataForStartDate()
Creates an Interaction attribute meta data InteractionAttributeMetaData instance
for StartDate. |
InteractionAttributeMetaData |
getInteractionAttributeMetaDataForSubject()
Creates an Interaction attribute meta data InteractionAttributeMetaData instance
for Subject. |
boolean |
isArchiveEnabled()
Returns true if Archive database is enable. |
| Method Detail |
|---|
History getHistory(Contact aContact,
SearchInteractionTemplate aSearchTemplate,
boolean _archive)
throws RequestFailedException
aContact - the contact as Contact instance.aSearchTemplate - as SearchInteractionTemplate How the history should be sorted._archive - false for current history, true for archive history.
History instance.
InvalidParameterException - if the parameters are null or invalid.
DatabaseServiceException - if the database service is out of order.
RequestFailedException - if the service cannot fulfill the request.SearchInteractionTemplate createSearchInteractionTemplate()
SearchInteractionTemplate instance.
SearchInteractionTemplate instance.InteractionAttributeMetaData getInteractionAttributeMetaDataForOwnerId()
InteractionAttributeMetaData instance
for ownerId.
It's a fake Interaction attribute meta data, it does not exist either in
Configuration Layer nor in Contact Server.
Its purpose is to offer a consistent data view for sorting attribute
in the search interaction template.
Do not use it for other operation.
InteractionAttributeMetaData instance for OwnerId.InteractionAttributeMetaData getInteractionAttributeMetaDataForSubject()
InteractionAttributeMetaData instance
for Subject.
It's a fake Interaction attribute meta data, it does not exist either in
Configuration Layer nor in Contact Server.
Its purpose is to offer a consistent data view for sorting attribute
in the search interaction template.
Do not use it for other operation.
InteractionAttributeMetaData instance for Subject.InteractionAttributeMetaData getInteractionAttributeMetaDataForStartDate()
InteractionAttributeMetaData instance
for StartDate.
It's a fake Interaction attribute meta data, it does not exist either in
Configuration Layer nor in Contact Server.
Its purpose is to offer a consistent data view for sorting attribute
in the search interaction template.
Do not use it for other operation.
InteractionAttributeMetaData instance for StartDate.HistoryItem getHistoryItem(java.lang.String id)
null if no HistoryItem with this ID
exists.
id - the ID of the HistoryItem.
HistoryItem with this ID, or
null.
boolean isArchiveEnabled()
throws RequestFailedException
DatabaseServiceException - if the database service is out of order.
RequestFailedException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||