com.genesyslab.ail
Interface HistoryManager


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

getHistory

History getHistory(Contact aContact,
                   SearchInteractionTemplate aSearchTemplate,
                   boolean _archive)
                   throws RequestFailedException
Returns the history of a contact.

Parameters:
aContact - the contact as Contact instance.
aSearchTemplate - as SearchInteractionTemplate How the history should be sorted.
_archive - false for current history, true for archive history.
Returns:
the history as History instance.
Throws:
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.

createSearchInteractionTemplate

SearchInteractionTemplate createSearchInteractionTemplate()
Creates an empty SearchInteractionTemplate instance.

Returns:
an empty SearchInteractionTemplate instance.

getInteractionAttributeMetaDataForOwnerId

InteractionAttributeMetaData getInteractionAttributeMetaDataForOwnerId()
Creates an interaction attribute meta data 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.

Returns:
an InteractionAttributeMetaData instance for OwnerId.

getInteractionAttributeMetaDataForSubject

InteractionAttributeMetaData getInteractionAttributeMetaDataForSubject()
Creates an Interaction attribute meta data 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.

Returns:
an InteractionAttributeMetaData instance for Subject.

getInteractionAttributeMetaDataForStartDate

InteractionAttributeMetaData getInteractionAttributeMetaDataForStartDate()
Creates an Interaction attribute meta data 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.

Returns:
an InteractionAttributeMetaData instance for StartDate.

getHistoryItem

HistoryItem getHistoryItem(java.lang.String id)
Returns the history item with this ID. Returns null if no HistoryItem with this ID exists.

Parameters:
id - the ID of the HistoryItem.
Returns:
the HistoryItem with this ID, or null.

isArchiveEnabled

boolean isArchiveEnabled()
                         throws RequestFailedException
Returns true if Archive database is enable.

Returns:
true if Archive database is enable.
Throws:
DatabaseServiceException - if the database service is out of order.
RequestFailedException