fr.paris.lutece.portal.business.right
Class Right

java.lang.Object
  extended by fr.paris.lutece.portal.business.right.Right
All Implemented Interfaces:
Localizable, java.io.Serializable, java.lang.Comparable<Right>

public class Right
extends java.lang.Object
implements Localizable, java.lang.Comparable<Right>, java.io.Serializable

This class represents business objects right

See Also:
Serialized Form

Constructor Summary
Right()
           
 
Method Summary
 int compareTo(Right o)
          Compare the right with the specified right
 java.lang.String getDescription()
          Returns the description of this right.
 java.lang.String getDescriptionKey()
          Returns the description of this right.
 java.lang.String getDocumentationUrl()
          Returns the url of the documentation associated to the right.
 java.lang.String getFeatureGroup()
          Returns the feature group of this right.
 java.lang.String getIconUrl()
          Returns the url of the icon associated to the right.
 java.lang.String getId()
          Returns the identifier of this right
 int getLevel()
          Returns the level of this right.
 java.lang.String getName()
          Returns the name of this right.
 java.lang.String getNameKey()
          Returns the name of this right.
 int getOrder()
          Get the right order
 java.lang.String getPluginName()
          Returns the isUpdatable tag of this right ( 1 if the right is updatable, 0 if not ).
 java.lang.String getUrl()
          Returns the url of the jsp component which manages this right.
 void setDescriptionKey(java.lang.String strDescriptionKey)
          Sets the description of the right to the specified string.
 void setDocumentationUrl(java.lang.String strDocumentationUrl)
          Sets the url of the documentation associated to the right.
 void setFeatureGroup(java.lang.String strFeatureGroup)
          Sets the feature group of the right to the specified string.
 void setIconUrl(java.lang.String strIconUrl)
          Sets the url of the icon associated to the right.
 void setId(java.lang.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(java.util.Locale locale)
          set the local used by this right
 void setNameKey(java.lang.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(java.lang.String strPluginName)
          Sets the name of the right to the specified string.
 void setUrl(java.lang.String strUrl)
          Sets the url of the right to the specified string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Right

public Right()
Method Detail

setLocale

public void setLocale(java.util.Locale locale)
set the local used by this right

Specified by:
setLocale in interface Localizable
Parameters:
locale - the local to use

getId

public java.lang.String getId()
Returns the identifier of this right

Returns:
the identifier of this right

setId

public void setId(java.lang.String strId)
Sets the identifier of the right to the specified string.

Parameters:
strId - the new identifier

getNameKey

public java.lang.String getNameKey()
Returns the name of this right.

Returns:
the right name

getName

public java.lang.String getName()
Returns the name of this right.

Returns:
the right name

setNameKey

public void setNameKey(java.lang.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 java.lang.String getUrl()
Returns the url of the jsp component which manages this right.

Returns:
the right url function

setUrl

public void setUrl(java.lang.String strUrl)
Sets the url of the right to the specified string.

Parameters:
strUrl - the new url

getDescriptionKey

public java.lang.String getDescriptionKey()
Returns the description of this right.

Returns:
the right description

getDescription

public java.lang.String getDescription()
Returns the description of this right.

Returns:
the right description

setDescriptionKey

public void setDescriptionKey(java.lang.String strDescriptionKey)
Sets the description of the right to the specified string.

Parameters:
strDescriptionKey - the new description

getPluginName

public java.lang.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(java.lang.String strPluginName)
Sets the name of the right to the specified string.

Parameters:
strPluginName - the new name

getFeatureGroup

public java.lang.String getFeatureGroup()
Returns the feature group of this right.

Returns:
the right feature group
Since:
1.1.1

setFeatureGroup

public void setFeatureGroup(java.lang.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 java.lang.String getIconUrl()
Returns the url of the icon associated to the right.

Returns:
the icon url

setIconUrl

public void setIconUrl(java.lang.String strIconUrl)
Sets the url of the icon associated to the right.

Parameters:
strIconUrl - the new url

getDocumentationUrl

public java.lang.String getDocumentationUrl()
Returns the url of the documentation associated to the right.

Returns:
the _strDocumentationUrl

setDocumentationUrl

public void setDocumentationUrl(java.lang.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

compareTo

public int compareTo(Right o)
Compare the right with the specified right

Specified by:
compareTo in interface java.lang.Comparable<Right>
Parameters:
o - The right to be compared with the instanced right
Returns:
The result of comparison


Copyright © 2011 Mairie de Paris. All Rights Reserved.