atg.userdirectory

Interface RelativeRole

All Superinterfaces:

DirectoryPrincipal, java.security.Principal, Role

public interface RelativeRole
extends Role

A RelativeRole is an role that represents the fullfillment of some function relative to a specific principal.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getFunctionName() Return the logical name of the function whose fulfillment this relative role represents.
DirectoryPrincipal	getTargetPrincipal() Return the principal to which this relative role pertains.

Methods inherited from interface atg.userdirectory.Role

getAccessRights, getAssigneeOrganizations, getAssigneeOrganizationsSortOnName, getAssignees, getAssigneeUsers, getAssigneeUsersSortOnEmailAddress, getAssigneeUsersSortOnFirstName, getAssigneeUsersSortOnLastName, getAssigneeUsersSortOnLogin, getParentFolder, getTemplateRoles, isAssignable, isAssignedTo, remove

Methods inherited from interface atg.userdirectory.DirectoryPrincipal

createRelativeRole, getDescription, getEffectivePrincipals, getMembers, getOrganizationMembersSortOnName, getPrimaryKey, getRelativeRole, getRelativeRoles, getUserDirectory, getUserMembersSortOnEmailAddress, getUserMembersSortOnFirstName, getUserMembersSortOnLastName, getUserMembersSortOnLogin, hasMember

Methods inherited from interface java.security.Principal

equals, getName, hashCode, toString

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Method Detail

getTargetPrincipal

DirectoryPrincipal getTargetPrincipal()

Return the principal to which this relative role pertains.

Returns:

the relative role's principal.

getFunctionName

java.lang.String getFunctionName()

Return the logical name of the function whose fulfillment this relative role represents.

Returns:

a String that gives the logical function name.