fr.paris.lutece.portal.business.right

Class RightHome

java.lang.Object

fr.paris.lutece.portal.business.right.RightHome

public final class RightHome
extends Object

This class provides instances management methods (create, find, ...) for Right objects

Method Summary

Modifier and Type	Method and Description
static int	changeRightOrder(Right right, int nNewOrder) Change the order in a Right
static boolean	checkFeatureOrders(String strFeatureGroup) Check feature orders and return false if at least one order is twice
static Right	create(Right right) Creation of an instance of an admin right
static void	deleteEntryFromList(String strFeatureGroup, int nOrderId) Delete entry (specify by nOrderId)
static Right	findByPrimaryKey(String strKey) Returns an instance of an admin right whose identifier is specified in parameter
static Collection<Right>	getExternalRightList()
static Collection<Right>	getRightsList() Loads the data of all the rights and returns them in form of a collection
static Collection<Right>	getRightsList(int nLevel) Loads the data of all the rights with level greater or equal than nLevel and returns them in form of a collection
static Collection<Right>	getRightsList(String strFeatureGroup) Loads the data of all the rights with the specified feature group and returns them in form of a collection
static void	reinitFeatureOrders(String strFeatureGroup) Reinitialize feature order groups
static void	remove(String strId) Remove the admin right whose identifier is specified in parameter
static Right	update(Right right) Update of the admin right which is specified

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static Right create(Right right)

Creation of an instance of an admin right

Parameters:

right - An instance of an admin right which contains the informations to store

Returns:

The instance of an admin right which has been created with its primary key.

update

public static Right update(Right right)

Update of the admin right which is specified

Parameters:

right - The instance of the admin right which contains the data to store

Returns:

The instance of the admin right which has been updated

remove

public static void remove(String strId)

Remove the admin right whose identifier is specified in parameter

Parameters:

strId - The identifier of the admin right to remove

findByPrimaryKey

public static Right findByPrimaryKey(String strKey)

Returns an instance of an admin right whose identifier is specified in parameter

Parameters:

strKey - The admin right primary key

Returns:

an instance of an admin right

getRightsList

public static Collection<Right> getRightsList()

Loads the data of all the rights and returns them in form of a collection

Returns:

the collection which contains the data of all the rights

getRightsList

public static Collection<Right> getRightsList(int nLevel)

Loads the data of all the rights with level greater or equal than nLevel and returns them in form of a collection

Parameters:

nLevel - The right's level

Returns:

the collection which contains the data of all the rights

getRightsList

public static Collection<Right> getRightsList(String strFeatureGroup)

Loads the data of all the rights with the specified feature group and returns them in form of a collection

Parameters:

strFeatureGroup - the name of the feature group

Returns:

the collection which contains the data of all the rights

changeRightOrder

public static int changeRightOrder(Right right,
                                   int nNewOrder)

Change the order in a Right

Parameters:

right - The right to update order

nNewOrder - The new place in the list or END_OF_LIST to place Right at the end

Returns:

The new order

deleteEntryFromList

public static void deleteEntryFromList(String strFeatureGroup,
                                       int nOrderId)

Delete entry (specify by nOrderId)

Parameters:

strFeatureGroup - The FeatureGroup impacted

nOrderId - The order to delete

reinitFeatureOrders

public static void reinitFeatureOrders(String strFeatureGroup)

Reinitialize feature order groups

Parameters:

strFeatureGroup - The feature group key

checkFeatureOrders

public static boolean checkFeatureOrders(String strFeatureGroup)

Check feature orders and return false if at least one order is twice

Parameters:

strFeatureGroup - The feature group key

Returns:

true if order list is ok, false else.

getExternalRightList

public static Collection<Right> getExternalRightList()