Role (Pentaho Community Edition Project: mondrian 10.1.0.1-323 API)

All Known Implementing Classes:

DelegatingRole, RoleImpl
```
public interface Role
```
A Role is a collection of access rights to cubes, permissions, and so forth.
At present, the only way to create a role is programmatically. You then add appropriate permissions, and associate the role with a connection. Queries executed for the duration of the connection will be using the role for security control.
Mondrian does not have any notion of a 'user'. It is the client application's responsibility to create a role appropriate for the user who is establishing the connection.

Since:

Oct 5, 2002

Author:

jhyde

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static interface`	`Role.AllHierarchyAccess`	Represents the access that a role has to whole particular hierarchy.
`static interface`	`Role.HierarchyAccess`	Represents the access that a role has to a particular hierarchy.
`static class`	`Role.RollupPolicy`	Enumeration of the policies by which a cell is calculated if children of a member are not accessible.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`canAccess(OlapElement olapElement)`	Returns whether this role is allowed to see a given element.
`Access`	`getAccess(Cube cube)`	Returns the access this role has to a given cube.
`Access`	`getAccess(Dimension dimension)`	Returns the access this role has to a given dimension.
`Access`	`getAccess(Hierarchy hierarchy)`	Returns the access this role has to a given hierarchy.
`Access`	`getAccess(Level level)`	Returns the access this role has to a given level.
`Access`	`getAccess(Member member)`	Returns the access this role has to a given member.
`Access`	`getAccess(NamedSet set)`	Returns the access this role has to a given named set.
`Access`	`getAccess(Schema schema)`	Returns the access this role has to a given schema.
`Role.HierarchyAccess`	`getAccessDetails(Hierarchy hierarchy)`	Returns the details of this hierarchy's access, or null if the hierarchy has not been given explicit access.

- Method Detail
  - getAccess
```
Access getAccess(Schema schema)
```
    Returns the access this role has to a given schema.
  - getAccess
```
Access getAccess(Cube cube)
```
    Returns the access this role has to a given cube.
  - getAccess
```
Access getAccess(Dimension dimension)
```
    Returns the access this role has to a given dimension.
  - getAccess
```
Access getAccess(Hierarchy hierarchy)
```
    Returns the access this role has to a given hierarchy.
  - getAccessDetails
```
Role.HierarchyAccess getAccessDetails(Hierarchy hierarchy)
```
    Returns the details of this hierarchy's access, or null if the hierarchy has not been given explicit access.
  - getAccess
```
Access getAccess(Level level)
```
    Returns the access this role has to a given level.
  - getAccess
```
Access getAccess(Member member)
```
    Returns the access this role has to a given member.
  - getAccess
```
Access getAccess(NamedSet set)
```
    Returns the access this role has to a given named set.
  - canAccess
```
boolean canAccess(OlapElement olapElement)
```
    Returns whether this role is allowed to see a given element.