org.opencastproject.security.api

Class JaxbRole

java.lang.Object

org.opencastproject.security.api.JaxbRole

All Implemented Interfaces:

Role

public final class JaxbRole
extends Object
implements Role

A simple user model.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencastproject.security.api.Role

Role.Target, Role.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description The description
protected String	name The role name
protected JaxbOrganization	organization
protected String	organizationId
protected Role.Type	type

Constructor Summary

Constructors

Constructor and Description
JaxbRole() No-arg constructor needed by JAXB
JaxbRole(String name, JaxbOrganization organization) Constructs a role with the specified name and organization.
JaxbRole(String name, JaxbOrganization organization, String description) Constructs a role with the specified name, organization and description.
JaxbRole(String name, JaxbOrganization organization, String description, Role.Type type) Constructs a role with the specified name, organization, description, and persistence settings.
JaxbRole(String name, String organizationId, String description, Role.Type type) Constructs a role with the specified name, organization identifier, description, and persistence settings.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static JaxbRole	fromRole(Role role)
String	getDescription() Gets the role description
String	getName() Gets the role name
String	getOrganizationId() Returns the role's organization identifier.
Role.Type	getType() Returns the role's Role.Type
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

The role name

description

protected String description

The description

organization

protected JaxbOrganization organization

organizationId

protected String organizationId

type

protected Role.Type type

Constructor Detail

JaxbRole

public JaxbRole()

No-arg constructor needed by JAXB

JaxbRole

public JaxbRole(String name,
                JaxbOrganization organization)
         throws IllegalArgumentException

Constructs a role with the specified name and organization.

Parameters:

name - the name

organization - the organization

Throws:

IllegalArgumentException

JaxbRole

public JaxbRole(String name,
                JaxbOrganization organization,
                String description)
         throws IllegalArgumentException

Constructs a role with the specified name, organization and description.

Parameters:

name - the name

organization - the organization

description - the description

Throws:

IllegalArgumentException

JaxbRole

public JaxbRole(String name,
                JaxbOrganization organization,
                String description,
                Role.Type type)
         throws IllegalArgumentException

Constructs a role with the specified name, organization, description, and persistence settings.

Parameters:

name - the name

organization - the organization

description - the description

type - the role type

Throws:

IllegalArgumentException

JaxbRole

public JaxbRole(String name,
                String organizationId,
                String description,
                Role.Type type)
         throws IllegalArgumentException

Constructs a role with the specified name, organization identifier, description, and persistence settings.

Parameters:

name - the name

organizationId - the organization identifier

description - the description

type - the role type

Throws:

IllegalArgumentException

Method Detail

fromRole

public static JaxbRole fromRole(Role role)

getName

public String getName()

Gets the role name

Specified by:

getName in interface Role

Returns:

the role name

See Also:

Role.getName()

getDescription

public String getDescription()

Gets the role description

Specified by:

getDescription in interface Role

Returns:

the role description

See Also:

Role.getDescription()

getOrganizationId

public String getOrganizationId()

Returns the role's organization identifier.

Specified by:

getOrganizationId in interface Role

Returns:

the organization identifier

getType

public Role.Type getType()

Returns the role's Role.Type

Specified by:

getType in interface Role

Returns:

the type

See Also:

Role.getType()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()