Package pl.edu.icm.unity.engine.api
Interface InvitationManagement
public interface InvitationManagement
Invitations to fill registration form management
- Author:
- K. Benedyczak
-
Method Summary
Modifier and TypeMethodDescriptionaddInvitation
(InvitationParam invitation) Associates a new invitation with a form.getInvitation
(String code) Retrieves an invitation by codevoid
removeInvitation
(String code) Removes a single invitationvoid
sendInvitation
(String code) Sends an invitation message to the invitation specified by the code.void
updateInvitation
(String code, InvitationParam invitation) Updates existing invitation.
-
Method Details
-
addInvitation
Associates a new invitation with a form. The invitation code is auto generated and returned- Parameters:
invitation
- invitation to be added- Returns:
- code assigned to the invitation
- Throws:
EngineException
-
updateInvitation
Updates existing invitation. The email address and registration form can not be changed.- Throws:
EngineException
-
sendInvitation
Sends an invitation message to the invitation specified by the code. In case when there is no such invitation, it has missing or invalid contact address or when the associated form has no message template for invitation this method throws exception.- Parameters:
code
-- Throws:
EngineException
-
removeInvitation
Removes a single invitation- Parameters:
code
-- Throws:
EngineException
-
getInvitations
- Returns:
- a list with all invitations
- Throws:
EngineException
-
getInvitation
Retrieves an invitation by code- Parameters:
code
- invitation code- Returns:
- an invitation with the given code. Note that the returned invitation may happen to be expired.
- Throws:
EngineException
- More specificallyWrongArgumentException
is thrown when there is no invitation with such code.
-