org.alfresco.service.cmr.invitation

Interface Invitation

All Known Subinterfaces:

ModeratedInvitation, NominatedInvitation

public interface Invitation

The invitation request is a command object for who, needs to be added or removed from which resource with which attributes. Invitations are processed by the InvitationService

See Also:

InvitationService

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Invitation.InvitationType What type of invitation are we? (Just Web site for now)
static class	Invitation.ResourceType What sort of Resource Web Project, Web Site, Node (Just Web site for now)

Method Summary

Methods

Modifier and Type	Method and Description
Invitation.InvitationType	getInvitationType() What sort of invitation is this ?
java.lang.String	getInviteeUserName() Who wants to be added
java.lang.String	getInviteId() What is the unique reference for this invitation ?
java.lang.String	getResourceName() What is the resource name ?
Invitation.ResourceType	getResourceType() What sort of resource is it, for example a WEB_SITE?
java.lang.String	getRoleName() Which role to be added with

Method Detail

getResourceType

Invitation.ResourceType getResourceType()

What sort of resource is it, for example a WEB_SITE?

Returns:

the resource type

getResourceName

java.lang.String getResourceName()

What is the resource name ?

Returns:

the name of the resource

getInviteId

java.lang.String getInviteId()

What is the unique reference for this invitation ?

Returns:

the unique reference for this invitation

getInvitationType

Invitation.InvitationType getInvitationType()

What sort of invitation is this ?

getInviteeUserName

java.lang.String getInviteeUserName()

Who wants to be added

Returns:

inviteeUserName

getRoleName

java.lang.String getRoleName()

Which role to be added with

Returns:

the roleName