org.alfresco.service.cmr.invitation

Interface InvitationService

All Known Implementing Classes:

InvitationServiceImpl

public interface InvitationService

The invitation service provides the ability to invite people to resources. For example adding a user to a shared web site. It manages the relationship between person, resource and requestType and may also pass along information such as who is to approve or the expected role of the user.

Author:

mrogers

Method Summary

Methods

Modifier and Type	Method and Description
Invitation	accept(String invitationId, String ticket) For a Nominated Invitation invitee accepts this invitation
Invitation	approve(String invitationId, String reason) Moderator approves this invitation
Invitation	cancel(String invitationId) cancel this request
Invitation	getInvitation(String invitationId) get an invitation from its invitation id
List<String>	getInvitationServiceWorkflowNames() Get the names of the workflows managed by the invitation service.
ModeratedInvitation	inviteModerated(String inviteeComments, String inviteeUserName, Invitation.ResourceType resourceType, String resourceName, String inviteeRole) Start the invitation process for a ModeratedInvitation
NominatedInvitation	inviteNominated(String inviteeUserName, Invitation.ResourceType resourceType, String resourceName, String inviteeRole, String acceptUrl, String rejectUrl) Start the invitation process for a NominatedInvitation for a user who does not yet have an Alfresco User Name The server path is calculated based on the sysAdmin parameters
NominatedInvitation	inviteNominated(String inviteeUserName, Invitation.ResourceType resourceType, String resourceName, String inviteeRole, String serverPath, String acceptUrl, String rejectUrl) Start the invitation process for a NominatedInvitation for a user who does not yet have an Alfresco User Name
NominatedInvitation	inviteNominated(String inviteeFirstName, String inviteeLastName, String inviteeEmail, Invitation.ResourceType resourceType, String resourceName, String inviteeRole, String acceptUrl, String rejectUrl) Start the invitation process for a NominatedInvitation for a user who does not yet have an Alfresco User NameA new user name will be generated as part of the invitation process.
NominatedInvitation	inviteNominated(String inviteeFirstName, String inviteeLastName, String inviteeEmail, Invitation.ResourceType resourceType, String resourceName, String inviteeRole, String serverPath, String acceptUrl, String rejectUrl) Start the invitation process for a NominatedInvitation for a user who does not yet have an Alfresco User NameA new user name will be generated as part of the invitation process.
boolean	isSendEmails()
List<Invitation>	listPendingInvitationsForInvitee(String invitee) list Invitations for a specific person
List<Invitation>	listPendingInvitationsForInvitee(String invitee, Invitation.ResourceType resourceType)
List<Invitation>	listPendingInvitationsForResource(Invitation.ResourceType resourceType, String resourceName) list Invitations for a specific resource
Invitation	reject(String invitationId, String reason) User or moderator rejects this request
List<Invitation>	searchInvitation(InvitationSearchCriteria criteria) search invitation
ModeratedInvitation	updateModeratedInvitation(String inviteeId, String siteShortName, String inviteeComments) Update the invitee comments for an existing moderated invitation

Method Detail

getInvitationServiceWorkflowNames

@NotAuditable
List<String> getInvitationServiceWorkflowNames()

Get the names of the workflows managed by the invitation service.

Returns:

the names of the workkflows managed by the invitation service.

inviteNominated

@Auditable(parameters={"inviteeUserName","resourceType","resourceName","inviteeRole","acceptUrl","rejectUrl"})
NominatedInvitation inviteNominated(String inviteeUserName,
                                            Invitation.ResourceType resourceType,
                                            String resourceName,
                                            String inviteeRole,
                                            String acceptUrl,
                                            String rejectUrl)

Start the invitation process for a NominatedInvitation for a user who does not yet have an Alfresco User Name The server path is calculated based on the sysAdmin parameters

Parameters:

inviteeUserName - Alfresco user name of who should be invited

ResourceType - resourceType

resourceName -

inviteeRole -

acceptUrl -

rejectUrl -

Returns:

the nominated invitation which will contain the invitationId and ticket which will uniqely identify this invitation for the rest of the workflow.

Throws:

InvitationException

InvitationExceptionUserError

InvitationExceptionForbidden

inviteNominated

@Auditable(parameters={"inviteeFirstName","inviteeLastName","inviteeEmail","resourceType","resourceName","inviteeRole","acceptUrl","rejectUrl"})
NominatedInvitation inviteNominated(String inviteeFirstName,
                                            String inviteeLastName,
                                            String inviteeEmail,
                                            Invitation.ResourceType resourceType,
                                            String resourceName,
                                            String inviteeRole,
                                            String acceptUrl,
                                            String rejectUrl)

Start the invitation process for a NominatedInvitation for a user who does not yet have an Alfresco User NameA new user name will be generated as part of the invitation process. The server path is calculated based on the sysAdmin parameters

Parameters:

inviteeFirstName -

inviteeLastName -

inviteeEmail -

Invitation.ResourceType - resourceType

resourceName -

inviteeRole -

acceptUrl -

rejectUrl -

Returns:

the nominated invitation which will contain the invitationId and ticket which will uniquely identify this invitation.

Throws:

InvitationException

InvitationExceptionUserError

InvitationExceptionForbidden

inviteNominated

@Auditable(parameters={"inviteeUserName","resourceType","resourceName","inviteeRole","serverPath","acceptUrl","rejectUrl"})
NominatedInvitation inviteNominated(String inviteeUserName,
                                            Invitation.ResourceType resourceType,
                                            String resourceName,
                                            String inviteeRole,
                                            String serverPath,
                                            String acceptUrl,
                                            String rejectUrl)

Start the invitation process for a NominatedInvitation for a user who does not yet have an Alfresco User Name

Parameters:

inviteeUserName - Alfresco user name of who should be invited

ResourceType - resourceType

resourceName -

inviteeRole -

serverPath -

acceptUrl -

rejectUrl -

Returns:

the nominated invitation which will contain the invitationId and ticket which will uniqely identify this invitation for the rest of the workflow.

Throws:

InvitationException

InvitationExceptionUserError

InvitationExceptionForbidden

inviteNominated

@Auditable(parameters={"inviteeFirstName","inviteeLastName","inviteeEmail","resourceType","resourceName","inviteeRole","serverPath","acceptUrl","rejectUrl"})
NominatedInvitation inviteNominated(String inviteeFirstName,
                                            String inviteeLastName,
                                            String inviteeEmail,
                                            Invitation.ResourceType resourceType,
                                            String resourceName,
                                            String inviteeRole,
                                            String serverPath,
                                            String acceptUrl,
                                            String rejectUrl)

Start the invitation process for a NominatedInvitation for a user who does not yet have an Alfresco User NameA new user name will be generated as part of the invitation process.

Parameters:

inviteeFirstName -

inviteeLastName -

inviteeEmail -

Invitation.ResourceType - resourceType

resourceName -

inviteeRole -

serverPath -

acceptUrl -

rejectUrl -

Returns:

the nominated invitation which will contain the invitationId and ticket which will uniquely identify this invitation.

Throws:

InvitationException

InvitationExceptionUserError

InvitationExceptionForbidden

inviteModerated

@Auditable(parameters={"inviteeComments","inviteeUserName","resourceType","resourceName","inviteeRole"})
ModeratedInvitation inviteModerated(String inviteeComments,
                                            String inviteeUserName,
                                            Invitation.ResourceType resourceType,
                                            String resourceName,
                                            String inviteeRole)

Start the invitation process for a ModeratedInvitation

Parameters:

inviteeUserName - who is to be invited

Invitation.ResourceType - resourceType what resource type ?

resourceName - which resource

inviteeRole - which role ?

updateModeratedInvitation

@Auditable(parameters={"inviteeId","siteShortName","inviteeComments"})
ModeratedInvitation updateModeratedInvitation(String inviteeId,
                                                      String siteShortName,
                                                      String inviteeComments)

Update the invitee comments for an existing moderated invitation

Parameters:

inviteeId -

siteShortName -

inviteeComments -

Returns:

the invitation

accept

@Auditable(parameters={"invitationId","reason"})
Invitation accept(String invitationId,
                          String ticket)

For a Nominated Invitation invitee accepts this invitation

Parameters:

request -

ticket -

Returns:

the invitation

approve

@Auditable(parameters={"invitationId","reason"})
Invitation approve(String invitationId,
                           String reason)

Moderator approves this invitation

Parameters:

invitationId - the request to approve

reason - - comments about the acceptance

reject

@Auditable(parameters={"invitationId","reason"})
Invitation reject(String invitationId,
                          String reason)

User or moderator rejects this request

Parameters:

invitationId -

reason -

cancel

@Auditable(parameters="invitationId")
Invitation cancel(String invitationId)

cancel this request

getInvitation

@NotAuditable
Invitation getInvitation(String invitationId)

get an invitation from its invitation id

Parameters:

invitationId; -

listPendingInvitationsForInvitee

@NotAuditable
List<Invitation> listPendingInvitationsForInvitee(String invitee)

list Invitations for a specific person

listPendingInvitationsForInvitee

@NotAuditable
List<Invitation> listPendingInvitationsForInvitee(String invitee,
                                                             Invitation.ResourceType resourceType)

listPendingInvitationsForResource

@NotAuditable
List<Invitation> listPendingInvitationsForResource(Invitation.ResourceType resourceType,
                                                              String resourceName)

list Invitations for a specific resource

Parameters:

resourceType -

resourceName -

searchInvitation

@NotAuditable
List<Invitation> searchInvitation(InvitationSearchCriteria criteria)

search invitation

Parameters:

criteria -

Returns:

the list of invitations

isSendEmails

@NotAuditable
boolean isSendEmails()

Returns:

true if emails are sent on invite.