com.helger.photon.basic.security.role

Interface IRoleContainer

All Known Subinterfaces:

IUserGroup

All Known Implementing Classes:

UserGroup

public interface IRoleContainer

Base read-only interface for objects containing roles.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsRoleID(String sRoleID) Check if the passed role is contained in this container.
Set<String>	getAllContainedRoleIDs()
int	getContainedRoleCount()
boolean	hasContainedRoles()

Method Detail

hasContainedRoles

boolean hasContainedRoles()

Returns:

true if at least one role is contained, false otherwise.

getContainedRoleCount

@Nonnegative
int getContainedRoleCount()

Returns:

The number of contained roles. Always ≥ 0.

getAllContainedRoleIDs

@Nonnull
@ReturnsMutableCopy
Set<String> getAllContainedRoleIDs()

Returns:

A non-nullbut maybe empty set of all assigned role IDs.

containsRoleID

boolean containsRoleID(String sRoleID)

Check if the passed role is contained in this container.

Parameters:

sRoleID - The role ID to check. May be null.

Returns:

true if the role is contained in this container, false otherwise.