RoleContainer (Cyclos 4.16.19 Scripting API Documentation)

All Known Subinterfaces:

SessionData

All Known Implementing Classes:

AbstractSessionData, AccessClientSessionData, BasicUser, DirectUserSessionData, GuestSessionData, OidcSessionData, Operator, ScriptSessionData, StatefulUserSessionData, StatelessUserSessionData, SystemSessionData, User, UserSessionData
```
public interface RoleContainer
```
Defines an object that contains user roles

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`boolean`	`isAdmin()`	Returns whether the `Role.ADMIN` is granted
`boolean`	`isAliasOperator()`	Returns whether the `Role.ALIAS_OPERATOR` is granted
`boolean`	`isBroker()`	Returns whether the `Role.BROKER` is granted
`boolean`	`isGlobalAdmin()`	Returns whether the `Role.GLOBAL_ADMIN` is granted Returns true if the user is the "root" user.
`boolean`	`isMember()`	Returns whether the `Role.MEMBER` is granted
`default boolean`	`isMemberOnly()`	Returns true if the logged user has only `Role` member.
`boolean`	`isNetworkAdmin()`	Returns whether the `Role.NETWORK_ADMIN` is granted
`boolean`	`isOperator()`	Returns whether the `Role.OPERATOR` is granted
`boolean`	`isRestrictedOperator()`	Returns whether the `Role.RESTRICTED_OPERATOR` is granted
`boolean`	`isUserManager()`	Returns whether the `Role.ADMIN` or `Role.BROKER` roles are granted

- Method Detail
  - isAdmin
```
boolean isAdmin()
```
    Returns whether the Role.ADMIN is granted
  - isAliasOperator
```
boolean isAliasOperator()
```
    Returns whether the Role.ALIAS_OPERATOR is granted
  - isBroker
```
boolean isBroker()
```
    Returns whether the Role.BROKER is granted
  - isGlobalAdmin
```
boolean isGlobalAdmin()
```
    Returns whether the Role.GLOBAL_ADMIN is granted Returns true if the user is the "root" user. For multi-networks administrators it returns false
    
    See Also:
    
    isGlobalAdmin()
  - isMember
```
boolean isMember()
```
    Returns whether the Role.MEMBER is granted
  - isMemberOnly
```
default boolean isMemberOnly()
```
    Returns true if the logged user has only Role member.
  - isNetworkAdmin
```
boolean isNetworkAdmin()
```
    Returns whether the Role.NETWORK_ADMIN is granted
  - isOperator
```
boolean isOperator()
```
    Returns whether the Role.OPERATOR is granted
  - isRestrictedOperator
```
boolean isRestrictedOperator()
```
    Returns whether the Role.RESTRICTED_OPERATOR is granted
  - isUserManager
```
boolean isUserManager()
```
    Returns whether the Role.ADMIN or Role.BROKER roles are granted