com.genesyslab.ail
Interface HistoryItem

All Superinterfaces:
IdObject, InteractionSummary

public interface HistoryItem
extends InteractionSummary

An element of the History of a Contact. You can access the corresponding Interaction with InteractionSummary.getInteraction(). The ID of the corresponding Interaction is at IdObject.getId().

See Also:
History

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.genesyslab.ail.IdObject
IdObject.ObjectType
 
Method Summary
 java.util.LinkedList getChildren()
          Returns the children of this item as a LinkedList of HistoryItem.
 Contact getContact()
          Returns the contact of the Interaction represented by this history item.
 boolean isArchive()
          Returns true if this item belongs to the archive history.
 boolean isDone()
          Returns true if this interaction is terminated.
 
Methods inherited from interface com.genesyslab.ail.InteractionSummary
getCategoryId, getContactServerId, getDateCreated, getInteraction, getInteractionSubType, getInteractionType, getMediaType, getSender, getSubject, getType
 
Methods inherited from interface com.genesyslab.ail.IdObject
getId, getObjectType
 

Method Detail

isArchive

boolean isArchive()
Returns true if this item belongs to the archive history.

Returns:
true if this is an archive item.

getContact

Contact getContact()
                   throws RequestFailedException
Returns the contact of the Interaction represented by this history item.

Returns:
the Contact of this HistoryItem.
Throws:
InvalidParameterException - if the contact does not exist.
DatabaseServiceException - if the database service is out of order.
RequestFailedException - if request cannot proceed.

getChildren

java.util.LinkedList getChildren()
Returns the children of this item as a LinkedList of HistoryItem. Child Interactions are interactions that reply to another Interaction. For instance, an InteractionMailOut is a child of the InteractionMailIn it replies to.

Returns:
the HistoryItems, children of this one

isDone

boolean isDone()
Returns true if this interaction is terminated.