com.liferay.portal.kernel.security.permission.contributor

Interface RoleCollection

@ProviderType
public interface RoleCollection

RoleCollection is used as the argument to RoleContributor.contribute(RoleCollection). It holds the managed collection of roleIds starting with the initial set calculated from persisted role assignment and role inheritance.

Author:

Carlos Sierra Andrés, Raymond Augé

Method Summary

Modifier and Type	Method and Description
boolean	addRoleId(long roleId) Add a roleId to the collection.
long	getCompanyId() Get the companyId of the Company being checked.
long	getGroupId() Get the groupId of the Group currently being permission checked.
long[]	getInitialRoleIds() Get the initial set of roles calculated from persisted assignment and inheritance.
User	getUser()
UserBag	getUserBag()
boolean	hasRoleId(long roleId) Check if a Role is already in the collection by roleId.
boolean	isSignedIn() Returns true if the user is signed in.
boolean	removeRoleId(long roleId)

Method Detail

addRoleId

boolean addRoleId(long roleId)

Add a roleId to the collection.

Parameters:

roleId - to add to the collection

Returns:

true if the roleId was added to the collection

getCompanyId

long getCompanyId()

Get the companyId of the Company being checked.

Returns:

the companyId of the Company being checked

getGroupId

long getGroupId()

Get the groupId of the Group currently being permission checked.

Returns:

the groupId of the Group currently being permission checked

getInitialRoleIds

long[] getInitialRoleIds()

Get the initial set of roles calculated from persisted assignment and inheritance.

Returns:

the initial set of roles calculated from persisted assignment and inheritance

getUser

User getUser()

getUserBag

UserBag getUserBag()

hasRoleId

boolean hasRoleId(long roleId)

Check if a Role is already in the collection by roleId.

Parameters:

roleId - the roleId to check

Returns:

true of the Role is in the collection

isSignedIn

boolean isSignedIn()

Returns true if the user is signed in.

Returns:

true if the user is signed in; false otherwise

removeRoleId

boolean removeRoleId(long roleId)