org.pentaho.platform.engine.security.userroledao
Interface IPentahoRole

All Superinterfaces:

Serializable

All Known Implementing Classes:

PentahoRole

public interface IPentahoRole
extends Serializable

A role in the Pentaho platform. Contains a set of users to which the role is assigned. A role is also known as an authority.

Author:

mlowery

Method Summary

boolean	addUser(IPentahoUser user)
void	clearUsers()
String	getDescription()
String	getName()
Set<IPentahoUser>	getUsers()
boolean	removeUser(IPentahoUser user)
void	setDescription(String description)
void	setUsers(Set<IPentahoUser> users)

Method Detail

getName

String getName()

getDescription

String getDescription()

setDescription

void setDescription(String description)

getUsers

Set<IPentahoUser> getUsers()

setUsers

void setUsers(Set<IPentahoUser> users)

addUser

boolean addUser(IPentahoUser user)

Returns:

Same meaning as Set.add return value.

removeUser

boolean removeUser(IPentahoUser user)

Returns:

Same meaning as Set.remove return value.

clearUsers

void clearUsers()