com.whitestein.lsps.orgstructure.entity

Class Role

java.lang.Object

com.whitestein.lsps.common.AbstractEntity

com.whitestein.lsps.common.VersionedAbstractEntity

com.whitestein.lsps.orgstructure.entity.Role

All Implemented Interfaces:

EntityWithId<Long>

@Entity
public class Role
extends com.whitestein.lsps.common.VersionedAbstractEntity

Persistent entity representing a role.

Since:

1.1

Author:

rba

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIND_ALL Query name.
static String	FIND_FOR_PERSON Query name.

Fields inherited from class com.whitestein.lsps.common.AbstractEntity

SEQUENCE_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Role() Constructor needed for JPA-specific purposes.
	Role(RoleName roleName, Collection<RoleUnitParameter> parameters) Creates new instance.
	Role(RoleName roleName, RoleUnitName roleUnitName) Creates new instance.
	Role(RoleName roleName, RoleUnitParameter... parameters) Creates new instance.

Method Summary

Modifier and Type	Method and Description
boolean	containsParameter(String name) Returns true if the role parameters contain a parameter for given string name, otherwise returns false.
RoleUnitName	getFullName() Converts this role into a RoleUnitName instance and returns instance.
String	getParameter(String name) Returns the value of the parameter that this role contains.
Map<String,String>	getParameters() Returns a collection of parameters that belong to this role.
String	getPersonId() Returns the owning personId.
RoleName	getRoleName() Returns the RoleName instance this role is linked to.
void	removePersonId() Removes the owning person.
void	setPersonId(String personId) Sets the owning personId.
String	toString()

Methods inherited from class com.whitestein.lsps.common.VersionedAbstractEntity

getEntityVersion, setEntityVersion

Methods inherited from class com.whitestein.lsps.common.AbstractEntity

getId, setId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FIND_ALL

public static final String FIND_ALL

Query name.

See Also:

Constant Field Values

FIND_FOR_PERSON

public static final String FIND_FOR_PERSON

Query name.

See Also:

Constant Field Values

Constructor Detail

Role

protected Role()

Constructor needed for JPA-specific purposes.

Role

public Role(RoleName roleName,
            RoleUnitParameter... parameters)

Creates new instance.

Parameters:

roleName -

parameters -

Throws:

NullPointerException - if roleName is null.

Role

public Role(RoleName roleName,
            Collection<RoleUnitParameter> parameters)

Creates new instance.

Parameters:

roleName -

parameters -

Throws:

NullPointerException - if roleName is null

IllegalArgumentException - if any parameter in parameters is not contained in roleName

Role

public Role(RoleName roleName,
            RoleUnitName roleUnitName)

Creates new instance.

Parameters:

roleName -

roleUnitName -

Throws:

NullPointerException - if roleName is null

IllegalArgumentException - if any parameter in parameters is not contained in roleName or if roleUnitName differs in the role name

Method Detail

getRoleName

public RoleName getRoleName()

Returns the RoleName instance this role is linked to.

Returns:

The RoleName instance this role is linked to.

getFullName

public RoleUnitName getFullName()

Converts this role into a RoleUnitName instance and returns instance. Returned RoleUnitName instance will contain all the information the role has (i.e. the module name, the local role name, and the set of parameters, if the role is a parametric one).

Returns:

RoleUnitName instance.

getParameters

public Map<String,String> getParameters()

Returns a collection of parameters that belong to this role.

Returns:

A collection of parameters that belong to this role.

getParameter

public String getParameter(String name)

Returns the value of the parameter that this role contains. The parameter is identified by its name given as an argument.

Parameters:

name - The name of the parameter. Cannot be null.

Returns:

The value of the parameter specified by given name or null if the role does not contain such parameter.

Throws:

NullPointerException - (unchecked) If the name argument is null.

containsParameter

public boolean containsParameter(String name)

Returns true if the role parameters contain a parameter for given string name, otherwise returns false.

Parameters:

name - The name of the parameter.

Returns:

true if the role parameters contain a parameter for given string name, otherwise returns false.

Throws:

NullPointerException - (unchecked) If the name argument is null.

getPersonId

public String getPersonId()

Returns the owning personId.

Returns:

the owning personId

setPersonId

public void setPersonId(String personId)

Sets the owning personId.

Parameters:

personId - The owning personId. Cannot be null.

Throws:

NullPointerException - (unchecked) If person is null.

IllegalStateException - (unchecked) If this role already has owning person.

removePersonId

public void removePersonId()

Removes the owning person.

Throws:

IllegalStateException - (unchecked) If this role has no owning person.

toString

public String toString()

Overrides:

toString in class Object