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.AlreadyMemberException
static class	ProjectInvitationsManagement.IllegalInvitationException
static class	ProjectInvitationsManagement.NotProjectInvitation
static class	ProjectInvitationsManagement.ProjectMisconfiguredException

Method Summary

Modifier and Type	Method	Description
java.lang.String	addInvitation(ProjectInvitationParam param)	Ads invitation
java.util.List<ProjectInvitation>	getInvitations(java.lang.String projectPath)	Gets all project invitations
void	removeInvitation(java.lang.String projectPath, java.lang.String code)	Removes a single invitation
void	sendInvitation(java.lang.String projectPath, java.lang.String code)	Sends an invitation message to the invitation specified by the code.

Method Detail

addInvitation

java.lang.String addInvitation(ProjectInvitationParam param)
                        throws pl.edu.icm.unity.exceptions.EngineException

Ads invitation

Parameters:

param -

Returns:

Throws:

pl.edu.icm.unity.exceptions.EngineException

getInvitations

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

Gets all project invitations

Parameters:

projectPath -

Returns:

Throws:

pl.edu.icm.unity.exceptions.EngineException

removeInvitation

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

Removes a single invitation

Parameters:

code -

Throws:

pl.edu.icm.unity.exceptions.EngineException

sendInvitation

void sendInvitation(java.lang.String projectPath,
                    java.lang.String code)
             throws pl.edu.icm.unity.exceptions.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:

pl.edu.icm.unity.exceptions.EngineException