Package org.ametys.core.right

Class Right

java.lang.Object

org.ametys.core.right.Right

public class Right
extends Object

A right in a runtime application.
A right can also be considered as a boolean permission : a given user has or does not have the right to do something.

Field Summary

Fields

Modifier and Type	Field	Description
private I18nizableText	_category
private String	_declaration
private I18nizableText	_description
private String	_id
private I18nizableText	_label

Constructor Summary

Constructors

Constructor	Description
Right(String id, I18nizableText label, I18nizableText description, I18nizableText category, String declaration)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object object)
I18nizableText	getCategory()	Returns the i18n category of this Right
String	getDeclaration()	Returns the declaration of this Right
I18nizableText	getDescription()	Returns the i18n description of this Right
String	getId()	Returns the unique Id of this Right
I18nizableText	getLabel()	Returns the i18n label of this Right
int	hashCode()
Map<String,Object>	toJSON()	Represents this Right as JSON
void	toSAX(ContentHandler ch)	Represents this Right as SAX events

Methods inherited from class java.lang.Object

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

Field Detail

_id

private final String _id

_label

private final I18nizableText _label

_description

private final I18nizableText _description

_category

private final I18nizableText _category

_declaration

private final String _declaration

Constructor Detail

Right

Right(String id,
      I18nizableText label,
      I18nizableText description,
      I18nizableText category,
      String declaration)

Constructor.

Parameters:

id - the unique Id of this right

label - the i18n label of this Right

description - the i18n description of the usage of this right

category - the i18n cateogry of the usage of this right

declaration - the declaration source (for debug purposes)

Method Detail

getId

public String getId()

Returns the unique Id of this Right

Returns:

the unique Id of this Right

getLabel

public I18nizableText getLabel()

Returns the i18n label of this Right

Returns:

the i18n label of this Right

getDescription

public I18nizableText getDescription()

Returns the i18n description of this Right

Returns:

the i18n description of this Right

getCategory

public I18nizableText getCategory()

Returns the i18n category of this Right

Returns:

the i18n category of this Right

getDeclaration

public String getDeclaration()

Returns the declaration of this Right

Returns:

the declaration

toSAX

public void toSAX(ContentHandler ch)
           throws SAXException

Represents this Right as SAX events

Parameters:

ch - the ContentHandler to process SAX events

Throws:

SAXException - if an error occurs

toJSON

public Map<String,Object> toJSON()

Represents this Right as JSON

Returns:

the right in JSON format

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object