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 Type	Method	Description
String	addInvitation(InvitationParam invitation)	Associates a new invitation with a form.
InvitationWithCode	getInvitation(String code)	Retrieves an invitation by code
List<InvitationWithCode>	getInvitations()
void	removeInvitation(String code)	Removes a single invitation
void	sendInvitation(String code)	Sends an invitation message to the invitation specified by the code.
void	updateInvitation(String code, InvitationParam invitation)	Updates existing invitation.

Method Detail

addInvitation

String addInvitation(InvitationParam invitation)
              throws EngineException

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

void updateInvitation(String code,
                      InvitationParam invitation)
               throws EngineException

Updates existing invitation. The email address and registration form can not be changed.

Throws:

EngineException

sendInvitation

void sendInvitation(String code)
             throws EngineException

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

void removeInvitation(String code)
               throws EngineException

Removes a single invitation

Parameters:

code -

Throws:

EngineException

getInvitations

List<InvitationWithCode> getInvitations()
                                 throws EngineException

Returns:

a list with all invitations

Throws:

EngineException

getInvitation

InvitationWithCode getInvitation(String code)
                          throws EngineException

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 specifically WrongArgumentException is thrown when there is no invitation with such code.