com.whitestein.lsps.orgstructure.entity

Class SecurityRole

java.lang.Object

com.whitestein.lsps.common.AbstractEntity

com.whitestein.lsps.common.VersionedAbstractEntity

com.whitestein.lsps.orgstructure.entity.SecurityRole

All Implemented Interfaces:

EntityWithId<java.lang.Long>, java.io.Serializable

@Entity
public class SecurityRole
extends com.whitestein.lsps.common.VersionedAbstractEntity
implements java.io.Serializable

Persistent entity representing a security role. Security role can be defined as a logical composition (or a set) of security rights.

Since:

1.3

Author:

vgr

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIND Query name.
static java.lang.String	FIND_ALL Query name.

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

SEQUENCE_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SecurityRole() Constructor needed for JPA-specific purposes.
	SecurityRole(java.lang.String name) Create new SecurityRole instance with the name property set to the value given by the name argument.

Method Summary

Modifier and Type	Method and Description
SecurityRole	addRight(java.lang.String rightName) Adds the right specified be given rightName argument to the set of rights that belong to this security role.
boolean	equals(java.lang.Object obj)
java.lang.String	getName() Returns the name of the security role.
java.util.Set<java.lang.String>	getRights() Returns a set of rights that are assigned to this security role.
int	hashCode()
boolean	hasRight(java.lang.String right) Returns true if this security role has given right assigned, otherwise returns false.
Right	removeRight(java.lang.String rightName) Removes the right identified by given rightName and returns the Right instance (JPA entity) that has just been removed.
void	setName(java.lang.String name) Sets the name of the security role.
java.lang.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, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FIND

public static final java.lang.String FIND

Query name.

See Also:

Constant Field Values

FIND_ALL

public static final java.lang.String FIND_ALL

Query name.

See Also:

Constant Field Values

Constructor Detail

SecurityRole

protected SecurityRole()

Constructor needed for JPA-specific purposes.

SecurityRole

public SecurityRole(java.lang.String name)

Create new SecurityRole instance with the name property set to the value given by the name argument.

Parameters:

name - The name of the security role. Cannot be blank.

Throws:

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

java.lang.IllegalArgumentException - (unchecked) If the name argument contains just whitespace characters.

Method Detail

getName

public java.lang.String getName()

Returns the name of the security role.

Returns:

The name of the security role.

setName

public void setName(java.lang.String name)

Sets the name of the security role. If the name is already set, the security role will be renamed to the new name.

Parameters:

name - The new name of the security role. Cannot be blank.

Throws:

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

java.lang.IllegalArgumentException - (unchecked) If the name argument contains just whitespace characters.

getRights

public java.util.Set<java.lang.String> getRights()

Returns a set of rights that are assigned to this security role.

Returns:

A set of rights that are assigned to this security role.

hasRight

public boolean hasRight(java.lang.String right)

Returns true if this security role has given right assigned, otherwise returns false.

Parameters:

right - The name of the right to check for presence.

Returns:

true if this security role has given right assigned, otherwise returns false.

addRight

public SecurityRole addRight(java.lang.String rightName)

Adds the right specified be given rightName argument to the set of rights that belong to this security role. Returns this SecurityRole instance.

Parameters:

rightName - The name of the right to add to the security role.

Returns:

This SecurityRole instance.

removeRight

public Right removeRight(java.lang.String rightName)

Removes the right identified by given rightName and returns the Right instance (JPA entity) that has just been removed.

Parameters:

rightName - The name of the right to remove from this security role.

Returns:

Removed Right instance (JPA entity).

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object