Package pl.edu.icm.unity.engine.api.project

Interface ProjectInvitationsManagement

public interface ProjectInvitationsManagement

Internal engine API for project invitations management

Author:

P.Piernik

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ProjectInvitationsManagement.IllegalInvitationException
static class	ProjectInvitationsManagement.NotProjectInvitation
static class	ProjectInvitationsManagement.ProjectMisconfiguredException

Method Summary

Modifier and Type	Method	Description
ProjectAddInvitationResult	addInvitations(Set<ProjectInvitationParam> param)	Ads invitations
List<ProjectInvitation>	getInvitations(String projectPath)	Gets all project invitations
void	reinvite(String projectPath, String code)	Creates and sends a new invitation based on the invitation specified by the code, and removes the old invitation.
void	removeInvitation(String projectPath, String code)	Removes a single invitation
void	resendInvitation(String projectPath, String code)	Sends the existing invitation message again.

Method Details

addInvitations

ProjectAddInvitationResult addInvitations(Set<ProjectInvitationParam> param)
                                   throws pl.edu.icm.unity.base.exceptions.EngineException

Ads invitations

Parameters:

param -

Returns:

Throws:

pl.edu.icm.unity.base.exceptions.EngineException

getInvitations

List<ProjectInvitation> getInvitations(String projectPath)
                                throws pl.edu.icm.unity.base.exceptions.EngineException

Gets all project invitations

Parameters:

projectPath -

Returns:

Throws:

pl.edu.icm.unity.base.exceptions.EngineException

removeInvitation

void removeInvitation(String projectPath,
 String code)
               throws pl.edu.icm.unity.base.exceptions.EngineException

Removes a single invitation

Parameters:

code -

Throws:

pl.edu.icm.unity.base.exceptions.EngineException

resendInvitation

void resendInvitation(String projectPath,
 String code)
               throws pl.edu.icm.unity.base.exceptions.EngineException

Sends the existing invitation message again. The invitation must remain valid for at least ProjectInvitation.MINIMUM_RESEND_VALIDITY. 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:

pl.edu.icm.unity.base.exceptions.EngineException

reinvite

void reinvite(String projectPath,
 String code)
       throws pl.edu.icm.unity.base.exceptions.EngineException

Creates and sends a new invitation based on the invitation specified by the code, and removes the old invitation. The new invitation has a new code and its validity period starts when this method is called.

Parameters:

code -

Throws:

pl.edu.icm.unity.base.exceptions.EngineException