fr.paris.lutece.plugins.unittree.service.unit

Interface IUnitService

All Known Implementing Classes:

UnitService

public interface IUnitService

IUnitService

Field Summary

Fields

Modifier and Type	Field and Description
static String	BEAN_UNIT_SERVICE

Method Summary

Modifier and Type	Method and Description
boolean	canCreateSubUnit(int nIdUnit) Check if the given id unit, we can create sub unit.
int	createUnit(Unit unit, javax.servlet.http.HttpServletRequest request) Create a unit
List<Unit>	findBySectorId(int nIdSector) Find by sector id
List<Unit>	getAllSubUnits(Unit unit, boolean bGetAdditionalInfos) Get all the sub units in the unit tree from the specified unit
List<Unit>	getAllUnits(boolean bGetAdditionalInfos) Get all units
List<IAction>	getListActions(String strActionType, Locale locale, Unit unit, fr.paris.lutece.portal.business.user.AdminUser user, UnittreeRBACRecursiveType recursiveType) Get the list of actions
List<Unit>	getListParentUnits(Unit unit) Get the unit parent list, from a given unit.
Unit	getRootUnit(boolean bGetAdditionalInfos) Get the root unit
List<Unit>	getSubUnits(int nIdUnit, boolean bGetAdditionalInfos) Get the direct sub units from a given id unit
fr.paris.lutece.util.ReferenceList	getSubUnitsAsReferenceList(int nIdUnit, Locale locale) Get the direct sub units as a ReferenceList
Source	getTreeXsl() Get the XSL of the tree
Unit	getUnit(int nIdUnit, boolean bGetAdditionalInfos) Get the unit
List<Unit>	getUnitsByIdUser(int nIdUser, boolean bGetAdditionalInfos) Get the unit by id user
List<Unit>	getUnitsFirstLevel(boolean bGetAdditionalInfos) Get the units first level
List<Unit>	getUnitWithNoChildren() Return all the Unit with no children (level 0)
String	getXMLUnits(fr.paris.lutece.portal.business.user.AdminUser user) Get the XML units
boolean	hasSubUnits(int nIdUnit) Check if the given id unit has sub units
boolean	isAuthorized(String strIdResource, String strPermission, fr.paris.lutece.portal.business.user.AdminUser user, UnittreeRBACRecursiveType recursiveType) See #isAuthorized(Unit, String, AdminUser)
boolean	isAuthorized(Unit unit, String strPermission, fr.paris.lutece.portal.business.user.AdminUser user, UnittreeRBACRecursiveType recursiveType) Check if the given user is authorized to do the action for a given unit.
boolean	isParent(Unit unitParent, Unit unitRef) Check if the first unit in parameter is parent of the second unit in parameter
boolean	isUnitInList(Unit unitToCheck, Collection<Unit> listUnits) Check if an unit is in a given list of unit
boolean	moveSubTree(Unit unitToMove, Unit newUnitParent) Change the parent of a unit.
void	removeUnit(int nIdUnit, javax.servlet.http.HttpServletRequest request) Remove the unit only if the unit does not have sub units
void	updateUnit(Unit unit, javax.servlet.http.HttpServletRequest request) Update the unit

Field Detail

BEAN_UNIT_SERVICE

static final String BEAN_UNIT_SERVICE

See Also:

Constant Field Values

Method Detail

getUnit

Unit getUnit(int nIdUnit,
             boolean bGetAdditionalInfos)

Get the unit

Parameters:

nIdUnit - the id unit

bGetAdditionalInfos - true if it must get the additional infos

Returns:

an instance of Unit

getRootUnit

Unit getRootUnit(boolean bGetAdditionalInfos)

Get the root unit

Parameters:

bGetAdditionalInfos - true if it must get the ids sector

Returns:

an instance of Unit

getUnitsByIdUser

List<Unit> getUnitsByIdUser(int nIdUser,
                            boolean bGetAdditionalInfos)

Get the unit by id user

Parameters:

nIdUser - the id user

bGetAdditionalInfos - true if it must get the ids sector

Returns:

a list of Unit

getAllUnits

List<Unit> getAllUnits(boolean bGetAdditionalInfos)

Get all units

Parameters:

bGetAdditionalInfos - true if it must get the ids sector

Returns:

a list of Unit

getUnitsFirstLevel

List<Unit> getUnitsFirstLevel(boolean bGetAdditionalInfos)

Get the units first level

Parameters:

bGetAdditionalInfos - true if it must get the ids sector

Returns:

a list of Unit

getSubUnits

List<Unit> getSubUnits(int nIdUnit,
                       boolean bGetAdditionalInfos)

Get the direct sub units from a given id unit

Parameters:

nIdUnit - the id unit

bGetAdditionalInfos - true if it must get the ids sector

Returns:

a list of Unit

getListParentUnits

List<Unit> getListParentUnits(Unit unit)

Get the unit parent list, from a given unit. The unit itselft is included

Parameters:

unit - the unit

Returns:

the list of parent units.

getAllSubUnits

List<Unit> getAllSubUnits(Unit unit,
                          boolean bGetAdditionalInfos)

Get all the sub units in the unit tree from the specified unit

Parameters:

unit - the unit

bGetAdditionalInfos - true if it must get the ids sector

Returns:

a list of Unit

getListActions

List<IAction> getListActions(String strActionType,
                             Locale locale,
                             Unit unit,
                             fr.paris.lutece.portal.business.user.AdminUser user,
                             UnittreeRBACRecursiveType recursiveType)

Get the list of actions

Parameters:

strActionType - the action type

locale - the locale

unit - the unit

user - the user

recursiveType - the recursive type

Returns:

a list of IAction

getSubUnitsAsReferenceList

fr.paris.lutece.util.ReferenceList getSubUnitsAsReferenceList(int nIdUnit,
                                                              Locale locale)

Get the direct sub units as a ReferenceList

Parameters:

nIdUnit - the id unit

locale - the locale

Returns:

a ReferenceList

getXMLUnits

String getXMLUnits(fr.paris.lutece.portal.business.user.AdminUser user)

Get the XML units

Parameters:

user - the admin user

Returns:

an XML

getTreeXsl

Source getTreeXsl()

Get the XSL of the tree

Returns:

the XSL

findBySectorId

List<Unit> findBySectorId(int nIdSector)

Find by sector id

Parameters:

nIdSector - id sector

Returns:

list of Unit found

getUnitWithNoChildren

List<Unit> getUnitWithNoChildren()

Return all the Unit with no children (level 0)

Returns:

all the Unit with no children (level 0)

hasSubUnits

boolean hasSubUnits(int nIdUnit)

Check if the given id unit has sub units

Parameters:

nIdUnit - the id unit

Returns:

true if the unit has sub units, false otherwise

isParent

boolean isParent(Unit unitParent,
                 Unit unitRef)

Check if the first unit in parameter is parent of the second unit in parameter

Parameters:

unitParent - the parent unit

unitRef - the unit to check

Returns:

true if there is a parent link between those two units

canCreateSubUnit

boolean canCreateSubUnit(int nIdUnit)

Check if the given id unit, we can create sub unit.
Return false if the unit does not have sub units and has sectors

Parameters:

nIdUnit - the id unit

Returns:

true if we can create sub unit, false otherwise

isAuthorized

boolean isAuthorized(Unit unit,
                     String strPermission,
                     fr.paris.lutece.portal.business.user.AdminUser user,
                     UnittreeRBACRecursiveType recursiveType)

Check if the given user is authorized to do the action for a given unit.
This method calls the service RBACService to check the permission. However, the resource on which the permission must be checked is not necessarily the given unit. It may be a parent unit of the given unit.
There are 5 cases to handle :

• 1) The given user is admin => The user is always authorized
• 2) The given user does not belong to any unit => The user is not authorized
• 3) The given user belongs to the given unit => Check with RBACService with the given unit
• 4) The given user belongs to a parent unit of the given unit => Check with RBACService with the parent unit
• 5) The given user belongs to an unit who is not a parent unit of the given unit => The user is not authorized

Parameters:

unit - the unit

strPermission - the permission

user - the user

recursiveType - the recursive type of RBAC

Returns:

true if he is authorized, false otherwise

isAuthorized

boolean isAuthorized(String strIdResource,
                     String strPermission,
                     fr.paris.lutece.portal.business.user.AdminUser user,
                     UnittreeRBACRecursiveType recursiveType)

See #isAuthorized(Unit, String, AdminUser)

Parameters:

strIdResource - the id resource

strPermission - the permission

user - the user

recursiveType - the recursive type of RBAC

Returns:

true if he is authorized, false otherwise

createUnit

@Transactional(value="unittree.transactionManager")
int createUnit(Unit unit,
                                                                   javax.servlet.http.HttpServletRequest request)
                                                            throws UnitErrorException

Create a unit

Parameters:

unit - the unit

request - the HTTP request

Returns:

the id unit

Throws:

UnitErrorException - exception if there is an application error

updateUnit

@Transactional(value="unittree.transactionManager")
void updateUnit(Unit unit,
                                                                    javax.servlet.http.HttpServletRequest request)
                                                             throws UnitErrorException

Update the unit

Parameters:

unit - the unit

request - the HTTP request

Throws:

UnitErrorException - exception if there is an application error

removeUnit

@Transactional(value="unittree.transactionManager")
void removeUnit(int nIdUnit,
                                                                    javax.servlet.http.HttpServletRequest request)

Remove the unit only if the unit does not have sub units

Parameters:

nIdUnit - the id unit

request - the HTTP request

moveSubTree

@Transactional(value="unittree.transactionManager")
boolean moveSubTree(Unit unitToMove,
                                                                        Unit newUnitParent)

Change the parent of a unit.

Parameters:

unitToMove - The unit to change the parent of.

newUnitParent - The new parent of the unit

Returns:

True if the sub tree was successfully move, false if the new parent is a child of the unit.

isUnitInList

boolean isUnitInList(Unit unitToCheck,
                     Collection<Unit> listUnits)

Check if an unit is in a given list of unit

Parameters:

unitToCheck - the unit to check

listUnits - the list of units

Returns:

true if the unit is in the given list, false otherwise