Right (Lutece 7.0.0-SNAPSHOT API)

java.lang.Object
- fr.paris.lutece.portal.business.right.Right

All Implemented Interfaces:

Localizable, Serializable, Comparable<Right>
```
public class Right
extends Object
implements Localizable, Comparable<Right>, Serializable
```
This class represents business objects right

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Right()

Constructors
Constructor and Description
`Right()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Right o)` Compare the right with the specified right
`boolean`	`equals(Object o)`
`String`	`getDescription()` Returns the description of this right if the i18nk exists; else return the key.
`String`	`getDescriptionKey()` Returns the description of this right.
`String`	`getDocumentationUrl()` Returns the url of the documentation associated to the right.
`String`	`getFeatureGroup()` Returns the feature group of this right.
`String`	`getIconUrl()` Returns the url of the icon associated to the right.
`String`	`getId()` Returns the identifier of this right
`int`	`getLevel()` Returns the level of this right.
`String`	`getName()` Returns the name of this right if the i18n key exists; else return the i18n key.
`String`	`getNameKey()` Returns the name of this right.
`int`	`getOrder()` Get the right order
`String`	`getPluginName()` Returns the isUpdatable tag of this right ( 1 if the right is updatable, 0 if not ).
`String`	`getUrl()` Returns the url of the jsp component which manages this right.
`int`	`hashCode()`
`boolean`	`isExternalFeature()` Get the external feature boolean
`void`	`setDescriptionKey(String strDescriptionKey)` Sets the description of the right to the specified string.
`void`	`setDocumentationUrl(String strDocumentationUrl)` Sets the url of the documentation associated to the right.
`void`	`setExternalFeature(boolean bExternalFeature)` Set the external feature boolean
`void`	`setFeatureGroup(String strFeatureGroup)` Sets the feature group of the right to the specified string.
`void`	`setIconUrl(String strIconUrl)` Sets the url of the icon associated to the right.
`void`	`setId(String strId)` Sets the identifier of the right to the specified string.
`void`	`setLevel(int nLevel)` Sets the level of the right to the specified int.
`void`	`setLocale(Locale locale)` Set the local used by this right
`void`	`setNameKey(String strNameKey)` Sets the name of the right to the specified string.
`void`	`setOrder(int nOrder)` Set the right order in feature group
`void`	`setPluginName(String strPluginName)` Sets the name of the right to the specified string.
`void`	`setUrl(String strUrl)` Sets the url of the right to the specified string.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Right
```
public Right()
```
- Method Detail
  - setLocale
```
public void setLocale(Locale locale)
```
    Set the local used by this right
    
    Specified by:
    
    setLocale in interface Localizable
    
    Parameters:
    
    locale - the local to use
  - getId
```
public String getId()
```
    Returns the identifier of this right
    
    Returns:
    
    the identifier of this right
  - setId
```
public void setId(String strId)
```
    Sets the identifier of the right to the specified string.
    
    Parameters:
    
    strId - the new identifier
  - getNameKey
```
public String getNameKey()
```
    Returns the name of this right.
    
    Returns:
    
    the right name
  - getName
```
public String getName()
```
    Returns the name of this right if the i18n key exists; else return the i18n key.
    
    Returns:
    
    the right name
  - setNameKey
```
public void setNameKey(String strNameKey)
```
    Sets the name of the right to the specified string.
    
    Parameters:
    
    strNameKey - the new name
  - getLevel
```
public int getLevel()
```
    Returns the level of this right.
    
    Returns:
    
    the right level
  - setLevel
```
public void setLevel(int nLevel)
```
    Sets the level of the right to the specified int.
    
    Parameters:
    
    nLevel - the new level
  - getUrl
```
public String getUrl()
```
    Returns the url of the jsp component which manages this right.
    
    Returns:
    
    the right url function
  - setUrl
```
public void setUrl(String strUrl)
```
    Sets the url of the right to the specified string.
    
    Parameters:
    
    strUrl - the new url
  - getDescriptionKey
```
public String getDescriptionKey()
```
    Returns the description of this right.
    
    Returns:
    
    the right description
  - getDescription
```
public String getDescription()
```
    Returns the description of this right if the i18nk exists; else return the key.
    
    Returns:
    
    the right description
  - setDescriptionKey
```
public void setDescriptionKey(String strDescriptionKey)
```
    Sets the description of the right to the specified string.
    
    Parameters:
    
    strDescriptionKey - the new description
  - getPluginName
```
public String getPluginName()
```
    Returns the isUpdatable tag of this right ( 1 if the right is updatable, 0 if not ).
    
    Returns:
    
    the is_upda
  - setPluginName
```
public void setPluginName(String strPluginName)
```
    Sets the name of the right to the specified string.
    
    Parameters:
    
    strPluginName - the new name
  - getFeatureGroup
```
public String getFeatureGroup()
```
    Returns the feature group of this right.
    
    Returns:
    
    the right feature group
    
    Since:
    
    1.1.1
  - setFeatureGroup
```
public void setFeatureGroup(String strFeatureGroup)
```
    Sets the feature group of the right to the specified string.
    
    Parameters:
    
    strFeatureGroup - the new feature group
    
    Since:
    
    1.1.1
  - getIconUrl
```
public String getIconUrl()
```
    Returns the url of the icon associated to the right.
    
    Returns:
    
    the icon url
  - setIconUrl
```
public void setIconUrl(String strIconUrl)
```
    Sets the url of the icon associated to the right.
    
    Parameters:
    
    strIconUrl - the new url
  - getDocumentationUrl
```
public String getDocumentationUrl()
```
    Returns the url of the documentation associated to the right.
    
    Returns:
    
    the _strDocumentationUrl
  - setDocumentationUrl
```
public void setDocumentationUrl(String strDocumentationUrl)
```
    Sets the url of the documentation associated to the right.
    
    Parameters:
    
    strDocumentationUrl - the _strDocumentationUrl to set
  - getOrder
```
public int getOrder()
```
    Get the right order
    
    Returns:
    
    the _order
  - setOrder
```
public void setOrder(int nOrder)
```
    Set the right order in feature group
    
    Parameters:
    
    nOrder - the _order to set
  - isExternalFeature
```
public boolean isExternalFeature()
```
    Get the external feature boolean
    
    Returns:
    
    the _isExternalFeature
  - setExternalFeature
```
public void setExternalFeature(boolean bExternalFeature)
```
    Set the external feature boolean
    
    Parameters:
    
    bExternalFeature - the _isExternalFeature to set
  - compareTo
```
public int compareTo(Right o)
```
    Compare the right with the specified right
    
    Specified by:
    
    compareTo in interface Comparable<Right>
    
    Parameters:
    
    o - The right to be compared with the instanced right
    
    Returns:
    
    The result of comparison
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Right

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Right

Method Detail

setLocale

getId

setId

getNameKey

getName

setNameKey

getLevel

setLevel

getUrl

setUrl

getDescriptionKey

getDescription

setDescriptionKey

getPluginName

setPluginName

getFeatureGroup

setFeatureGroup

getIconUrl

setIconUrl

getDocumentationUrl

setDocumentationUrl

getOrder

setOrder

isExternalFeature

setExternalFeature

compareTo

equals

hashCode