com.whitestein.lsps.os.dto

Class SecurityRole

java.lang.Object

com.whitestein.lsps.os.dto.SecurityRole

All Implemented Interfaces:

java.io.Serializable

public final class SecurityRole
extends java.lang.Object
implements java.io.Serializable

Value object that holds security role's attributes. Instances of this class are immutable.

Since:

1.3

Author:

vgr

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SecurityRole() Creates new instance.
	SecurityRole(java.lang.Long id, java.lang.Long entityVersion, java.lang.String name, java.util.Collection<java.lang.String> rights) Creates new instance.
	SecurityRole(java.lang.String name) Creates new instance.
	SecurityRole(java.lang.String name, java.util.Collection<java.lang.String> rights) Creates new instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object)
java.lang.Long	getEntityVersion() Returns the entity version.
java.lang.Long	getId() Returns the id of the role.
java.lang.String	getName() Returns the name of the security role.
java.util.Set<java.lang.String>	getRights() Returns the set of rights that belong to the security role.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SecurityRole

protected SecurityRole()

Creates new instance.

SecurityRole

public SecurityRole(java.lang.String name)

Creates new instance.

Parameters:

name -

Throws:

java.lang.NullPointerException - if name is null

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

SecurityRole

public SecurityRole(java.lang.String name,
                    java.util.Collection<java.lang.String> rights)

Creates new instance.

Parameters:

name -

rights -

SecurityRole

public SecurityRole(java.lang.Long id,
                    java.lang.Long entityVersion,
                    java.lang.String name,
                    java.util.Collection<java.lang.String> rights)

Creates new instance.

Parameters:

id -

entityVersion -

name - The name of the security role (as their unique identifier). Cannot be blank.

rights - The set of rights that are about to belong to the security role. Cannot be null.

Throws:

java.lang.NullPointerException - (unchecked) If at least one from the arguments is null.

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

Method Detail

getId

public java.lang.Long getId()

Returns the id of the role.

Returns:

the id of the role

getEntityVersion

public java.lang.Long getEntityVersion()

Returns the entity version.

Returns:

the entity version

getName

public java.lang.String getName()

Returns the name of the security role.

Returns:

The name of the security role.

getRights

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

Returns the set of rights that belong to the security role.

Returns:

The set of rights that belong to the security role.

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object