com.genesyslab.ail.collaboration
Interface InteractionInvitationParentIn
- All Superinterfaces:
- AbstractInteraction, IdObject, Interaction, InteractionMail, InteractionMailIn, InteractionMultimedia, Possible, Savable
public interface InteractionInvitationParentIn
- extends InteractionMailIn
InteractionInvitationParentIn is an interaction for the collaboration feature.
This interface is used to manage an invitation sent to a participant from the parent point of view.
It provides the following actions:
- Monitor an invitation sent to the participant.
- Get the participant’s response (if any).
- Recall or remind invitations.
To get instances of this interface, call the InteractionMailOut.getSentInvitations()
method of the outgoing e-mail interaction involved in the collaboration session.
Do not use this InteractionInvitationParentIn interaction as an incoming e-mail;
use it to monitor the participant activity on the invitation.
Periodically test the collaboration status to take changes into account. To get the collaboration
status of an invitation, call the getCollaborationStatus() method.
To determine if the InteractionInvitationParentIn.Action.RECALL and
InteractionInvitationParentIn.Action.REMIND actions are available, test
the collaboration status of the invitation as following:
if((myInteractionInvitationParentIn.getCollaborationStatus() ==
InteractionInvitationIn.Status.ACCEPTED) ||
(myInteractionInvitationParentIn.getCollaborationStatus() ==
InteractionInvitationIn.Status.ACCEPTANCE_PENDING))
{
// The parent can take the REMIND or RECALL action on the
// interaction.
myInteractionInvitationParentIn.remind(myPlace);
} else {
// Collaboration status is DECLINED, FAILED, or FULFILLED
// REMIND or RECALL are not available
}
When the collaboration status is InteractionInvitationIn.Status.FULFILLED, get the response of
the corresponding participant by calling the getCollaborativeReply() method.
- See Also:
InteractionReplyOut
| Methods inherited from interface com.genesyslab.ail.InteractionMultimedia |
addSuggestedCategories, delete, getAvailableQueuesForChildInteraction, getAvailableQueuesForThisInteraction, getCategoryId, getExternalId, getInteractionSubtype, getInteractionType, getIsCategoryApproved, getMaxSubjectLength, getMediaType, getQueue, getSuggestedCategories, isMarkDoneAvailable, placeInQueue, setAttachedData, setAvailableQueuesForChildInteraction, setAvailableQueuesForThisInteraction, setCategoryId, setExternalId, setIsCategoryApproved, submit, transferAgent, transferPlace, transferQueue |
| Methods inherited from interface com.genesyslab.ail.Interaction |
answerCall, countOtherPendingInteractions, getContactId, getContentBinary, getContentBinaryMimeType, getContentBinarySize, getDateCreated, getDn, getEndDate, getMedia, getNotepad, getParentInteraction, getPlace, getStatus, getStructTextMimeType, getStructuredText, getSubject, getText, getType, getUserName, isDone, markDone, merge, releaseCall, save, setContactId, setContentBinary, setContentBinaryMimeType, setContentBinarySize, setNotepad, setStructTextMimeType, setStructuredText, setSubject, setText |
remind
void remind(Place _place)
throws RequestFailedException
- Reminds the invitation to the pending participants.
- Parameters:
_place - as Place.
- Throws:
RequestFailedException - if request cannot proceed.- Since:
- 7.0
recall
void recall(Place _place)
throws RequestFailedException
- Recalls the invitation.
- Parameters:
_place - as Place.
- Throws:
RequestFailedException - if request cannot not proceed.- Since:
- 7.0
getCollaborativeReply
InteractionReplyOut getCollaborativeReply()
throws RequestFailedException
- Gets the collaborative reply of this invitation if any.
- Returns:
InteractionReplyOut.
- Throws:
RequestFailedException - if request cannot proceed.- Since:
- 7.0
getCollaborationStatus
InteractionInvitationIn.Status getCollaborationStatus()
- Gets the collaboration status of this invitation.
- Returns:
InteractionInvitationIn.Status.- Since:
- 7.0