mondrian.olap
Interface Role

All Known Implementing Classes:

DelegatingRole, RoleImpl, UnionRoleImpl

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 b.

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

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

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.

Pre-condition:

schema != null

Post-condition:

return == Access.ALL || return == Access.NONE || return == Access.ALL_DIMENSIONS

getAccess

Access getAccess(Cube cube)

Returns the access this role has to a given cube.

Pre-condition:

cube != null

Post-condition:

return == Access.ALL || return == Access.NONE

getAccess

Access getAccess(Dimension dimension)

Returns the access this role has to a given dimension.

Pre-condition:

dimension != null

Post-condition:

Access.instance().isValid(return)

getAccess

Access getAccess(Hierarchy hierarchy)

Returns the access this role has to a given hierarchy.

Pre-condition:

hierarchy != null

Post-condition:

return == Access.NONE || return == Access.ALL || return == Access.CUSTOM

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.

Pre-condition:

hierarchy != null

getAccess

Access getAccess(Level level)

Returns the access this role has to a given level.

Pre-condition:

level != null

Post-condition:

Access.instance().isValid(return)

getAccess

Access getAccess(Member member)

Returns the access this role has to a given member.

Pre-condition:

member != null, isMutable()

Post-condition:

return == Access.NONE || return == Access.ALL || return == Access.CUSTOM

getAccess

Access getAccess(NamedSet set)

Returns the access this role has to a given named set.

Pre-condition:

set != null, isMutable()

Post-condition:

return == Access.NONE || return == Access.ALL

canAccess

boolean canAccess(OlapElement olapElement)

Returns whether this role is allowed to see a given element.

Pre-condition:

olapElement != null