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

All Known Implementing Classes:
UnitService

public interface IUnitService

IUnitService


Field Summary
static String BEAN_UNIT_SERVICE
           
 
Method Summary
 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> getAllUnits(boolean bGetAdditionalInfos)
          Get all units
 List<IAction> getListActions(String strActionType, Locale locale, Unit unit, fr.paris.lutece.portal.business.user.AdminUser user)
          Get the list of actions
 Unit getRootUnit(boolean bGetAdditionalInfos)
          Get the root unit
 List<Unit> getSubUnits(int nIdUnit, boolean bGetAdditionalInfos)
          Get the sub units from a given id unit
 fr.paris.lutece.util.ReferenceList getSubUnitsAsReferenceList(int nIdUnit, Locale locale)
          Get the 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()
          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)
          See isAuthorized(Unit, String, AdminUser)
 boolean isAuthorized(Unit unit, String strPermission, fr.paris.lutece.portal.business.user.AdminUser user)
          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 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 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

getListActions

List<IAction> getListActions(String strActionType,
                             Locale locale,
                             Unit unit,
                             fr.paris.lutece.portal.business.user.AdminUser user)
Get the list of actions

Parameters:
strActionType - the action type
locale - the locale
unit - the unit
user - the user
Returns:
a list of IAction

getSubUnitsAsReferenceList

fr.paris.lutece.util.ReferenceList getSubUnitsAsReferenceList(int nIdUnit,
                                                              Locale locale)
Get the sub units as a ReferenceList

Parameters:
nIdUnit - the id unit
locale - the locale
Returns:
a ReferenceList

getXMLUnits

String getXMLUnits()
Get the XML units

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)
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 :

Parameters:
unit - the unit
strPermission - the permission
user - the user
Returns:
true if he is authorized, false otherwise

isAuthorized

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

Parameters:
strIdResource - the id resource
strPermission - the permission
user - the user
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.


Copyright © 2013 Mairie de Paris. All Rights Reserved.