|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
---|---|
Invitation |
accept(java.lang.String invitationId,
java.lang.String ticket)
For a Nominated Invitation invitee accepts this invitation |
Invitation |
approve(java.lang.String invitationId,
java.lang.String reason)
Moderator approves this invitation |
Invitation |
cancel(java.lang.String invitationId)
cancel this request |
Invitation |
getInvitation(java.lang.String invitationId)
get an invitation from its invitation id |
java.util.List |
getInvitationServiceWorkflowNames()
Get the names of the workflows managed by the invitation service. |
ModeratedInvitation |
inviteModerated(java.lang.String inviteeComments,
java.lang.String inviteeUserName,
Invitation.ResourceType resourceType,
java.lang.String resourceName,
java.lang.String inviteeRole)
Start the invitation process for a ModeratedInvitation |
NominatedInvitation |
inviteNominated(java.lang.String inviteeUserName,
Invitation.ResourceType resourceType,
java.lang.String resourceName,
java.lang.String inviteeRole,
java.lang.String serverPath,
java.lang.String acceptUrl,
java.lang.String rejectUrl)
Start the invitation process for a NominatedInvitation for a user who does not yet have an Alfresco User Name |
NominatedInvitation |
inviteNominated(java.lang.String inviteeFirstName,
java.lang.String inviteeLastName,
java.lang.String inviteeEmail,
Invitation.ResourceType resourceType,
java.lang.String resourceName,
java.lang.String inviteeRole,
java.lang.String serverPath,
java.lang.String acceptUrl,
java.lang.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()
|
java.util.List |
listPendingInvitationsForInvitee(java.lang.String invitee)
list Invitations for a specific person |
java.util.List |
listPendingInvitationsForResource(Invitation.ResourceType resourceType,
java.lang.String resourceName)
list Invitations for a specific resource |
Invitation |
reject(java.lang.String invitationId,
java.lang.String reason)
User or moderator rejects this request |
java.util.List |
searchInvitation(InvitationSearchCriteria criteria)
search invitation |
Method Detail |
---|
@NotAuditable java.util.List getInvitationServiceWorkflowNames()
@Auditable(parameters={"inviteeUserName", "resourceType", "resourceName", "inviteeRole", "serverPath", "acceptUrl", "rejectUrl"}) NominatedInvitation inviteNominated(java.lang.String inviteeUserName, Invitation.ResourceType resourceType, java.lang.String resourceName, java.lang.String inviteeRole, java.lang.String serverPath, java.lang.String acceptUrl, java.lang.String rejectUrl)
inviteeUserName
- Alfresco user name of who should be invitedResourceType
- resourceTyperesourceName
- inviteeRole
- serverPath
- acceptUrl
- rejectUrl
-
InvitationException
InvitationExceptionUserError
InvitationExceptionForbidden
@Auditable(parameters={"inviteeFirstName", "inviteeLastName", "inviteeEmail", "resourceType", "resourceName", "inviteeRole", "serverPath", "acceptUrl", "rejectUrl"}) NominatedInvitation inviteNominated(java.lang.String inviteeFirstName, java.lang.String inviteeLastName, java.lang.String inviteeEmail, Invitation.ResourceType resourceType, java.lang.String resourceName, java.lang.String inviteeRole, java.lang.String serverPath, java.lang.String acceptUrl, java.lang.String rejectUrl)
inviteeFirstName
- inviteeLastName
- inviteeEmail
- Invitation.ResourceType
- resourceTyperesourceName
- inviteeRole
- serverPath
- acceptUrl
- rejectUrl
-
InvitationException
InvitationExceptionUserError
InvitationExceptionForbidden
@Auditable(parameters={"inviteeComments", "inviteeUserName", "resourceType", "resourceName", "inviteeRole"}) ModeratedInvitation inviteModerated(java.lang.String inviteeComments, java.lang.String inviteeUserName, Invitation.ResourceType resourceType, java.lang.String resourceName, java.lang.String inviteeRole)
inviteeUserName
- who is to be invitedInvitation.ResourceType
- resourceType what resource type ?resourceName
- which resourceinviteeRole
- which role ?@Auditable(parameters={"invitationId", "reason"}) Invitation accept(java.lang.String invitationId, java.lang.String ticket)
request
- ticket
-
@Auditable(parameters={"invitationId", "reason"}) Invitation approve(java.lang.String invitationId, java.lang.String reason)
invitationId
- the request to approvereason
- - comments about the acceptance@Auditable(parameters={"invitationId", "reason"}) Invitation reject(java.lang.String invitationId, java.lang.String reason)
invitationId
- reason
- @Auditable(parameters="invitationId") Invitation cancel(java.lang.String invitationId)
@NotAuditable Invitation getInvitation(java.lang.String invitationId)
invitationId;
- @NotAuditable java.util.List listPendingInvitationsForInvitee(java.lang.String invitee)
@NotAuditable java.util.List listPendingInvitationsForResource(Invitation.ResourceType resourceType, java.lang.String resourceName)
resourceType
- resourceName
- @NotAuditable java.util.List searchInvitation(InvitationSearchCriteria criteria)
criteria
-
@NotAuditable boolean isSendEmails()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |