it.eng.spagobi.analiticalmodel.functionalitytree.dao
Interface ILowFunctionalityDAO

All Superinterfaces:
ISpagoBIDao
All Known Implementing Classes:
LowFunctionalityDAOHibImpl

public interface ILowFunctionalityDAO
extends ISpagoBIDao

Defines the interfaces for all methods needed to insert, modify and deleting a low functionality.


Method Summary
 boolean checkUserRootExists(java.lang.String username)
          Check user root exists.
 void deleteInconsistentRoles(java.util.Set set)
          Delete inconsistent roles.
 void eraseLowFunctionality(LowFunctionality aLowFunctionality, it.eng.spago.security.IEngUserProfile profile)
          Implements the query to erase a low functionality.
 java.lang.Integer existByCode(java.lang.String code)
          Control if exist a functionality with the given code.
 boolean hasChild(java.lang.Integer id)
          Control if the functionality with the given id has childs.
 void insertLowFunctionality(LowFunctionality aLowFunctionality, it.eng.spago.security.IEngUserProfile profile)
          Implements the query to insert a low functionality.
 void insertUserFunctionality(UserFunctionality userfunct)
          Insert user functionality.
 java.util.List loadAllLowFunctionalities(boolean recoverBIObjects)
          Loads all the functionalities.
 java.util.List loadAllUserFunct()
          Load all functionalities with type USER_FUNCT
 java.util.List loadChildFunctionalities(java.lang.Integer parentId, boolean recoverBIObjects)
          Loads all the child functionalities of the given parent functionality.
 LowFunctionality loadLowFunctionalityByCode(java.lang.String code, boolean recoverBIObjects)
          Loads all information for a low functionality identified by its code.
 LowFunctionality loadLowFunctionalityByID(java.lang.Integer functionalityID, boolean recoverBIObjects)
          Loads all information for a low functionality identified by its functionalityID.
 LowFunctionality loadLowFunctionalityByPath(java.lang.String functionalityPath, boolean recoverBIObjects)
          Loads all information for a low functionality identified by its functionalityPath.
 java.util.List loadLowFunctionalityList(java.util.List functionalityIDs)
          Load low functionality list by id List
 java.util.List loadParentFunctionalities(java.lang.Integer functId, java.lang.Integer rootFolderID)
          Load all fathers functionalities to root level.
 LowFunctionality loadRootLowFunctionality(boolean recoverBIObjects)
          Loads the root functionality.
 java.util.List loadSubLowFunctionalities(java.lang.String initialPath, boolean recoverBIObjects)
          Loads all the sub functionalities of the given initial path.
 java.util.List loadUserFunctionalities(java.lang.Integer parentId, boolean recoverBIObjects, it.eng.spago.security.IEngUserProfile profile)
          Loads the user's functionalities.
 java.util.List loadUserFunctionalitiesFiltered(java.lang.Integer parentId, boolean recoverBIObjects, it.eng.spago.security.IEngUserProfile profile, java.lang.String permission)
          Load all functionalities associated the user roles.
 void modifyLowFunctionality(LowFunctionality aLowFunctionality)
          Implements the query to modify a low functionality.
 void moveDownLowFunctionality(java.lang.Integer functionalityID)
          Moves down the functionality specified by the id at input in the functionalities tree.
 void moveUpLowFunctionality(java.lang.Integer functionalityID)
          Moves up the functionality specified by the id at input in the functionalities tree.
 
Methods inherited from interface it.eng.spagobi.commons.dao.ISpagoBIDao
getUserProfile, setTenant, setUserID, setUserProfile
 

Method Detail

checkUserRootExists

boolean checkUserRootExists(java.lang.String username)
                            throws it.eng.spago.error.EMFUserError
Check user root exists.

Parameters:
username - the username
Returns:
true, if successful
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

insertUserFunctionality

void insertUserFunctionality(UserFunctionality userfunct)
                             throws it.eng.spago.error.EMFUserError
Insert user functionality.

Parameters:
userfunct - the userfunct
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

loadLowFunctionalityByID

LowFunctionality loadLowFunctionalityByID(java.lang.Integer functionalityID,
                                          boolean recoverBIObjects)
                                          throws it.eng.spago.error.EMFUserError
Loads all information for a low functionality identified by its functionalityID. All these information, are stored into a LowFunctionality object, which is returned.

Parameters:
functionalityID - The id for the low functionality to load
recoverBIObjects - If true the LowFunctionality at output will have the list of contained BIObject objects
Returns:
A LowFunctionality object containing all loaded information
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

loadLowFunctionalityByCode

LowFunctionality loadLowFunctionalityByCode(java.lang.String code,
                                            boolean recoverBIObjects)
                                            throws it.eng.spago.error.EMFUserError
Loads all information for a low functionality identified by its code. All these information, are stored into a LowFunctionality object, which is returned.

Parameters:
code - The code for the low functionality to load
recoverBIObjects - If true the LowFunctionality at output will have the list of contained BIObject objects
Returns:
A LowFunctionality object containing all loaded information
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

loadLowFunctionalityList

java.util.List loadLowFunctionalityList(java.util.List functionalityIDs)
                                        throws it.eng.spago.error.EMFUserError
Load low functionality list by id List

Parameters:
functionalityIDs - the functionality id List
Returns:
the low functionalities List
Throws:
it.eng.spago.error.EMFUserError - the EMF user error
See Also:
it.eng.spagobi.analiticalmodel.functionalitytree.dao.ILowFunctionalityDAO#loadLowFunctionalityByID(java.lang.Integer)

loadLowFunctionalityByPath

LowFunctionality loadLowFunctionalityByPath(java.lang.String functionalityPath,
                                            boolean recoverBIObjects)
                                            throws it.eng.spago.error.EMFUserError
Loads all information for a low functionality identified by its functionalityPath. All these information, are stored into a LowFunctionality object, which is returned.

Parameters:
functionalityPath - The path for the low functionality to load
recoverBIObjects - If true the LowFunctionality at output will have the list of contained BIObject objects
Returns:
A LowFunctionality object containing all loaded information
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

modifyLowFunctionality

void modifyLowFunctionality(LowFunctionality aLowFunctionality)
                            throws it.eng.spago.error.EMFUserError
Implements the query to modify a low functionality. All information needed is stored into the input LowFunctionality object.

Parameters:
aLowFunctionality - The object containing all modify information
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

insertLowFunctionality

void insertLowFunctionality(LowFunctionality aLowFunctionality,
                            it.eng.spago.security.IEngUserProfile profile)
                            throws it.eng.spago.error.EMFUserError
Implements the query to insert a low functionality. All information needed is stored into the input LowFunctionality object.

Parameters:
aLowFunctionality - The object containing all insert information
profile - the profile
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

eraseLowFunctionality

void eraseLowFunctionality(LowFunctionality aLowFunctionality,
                           it.eng.spago.security.IEngUserProfile profile)
                           throws it.eng.spago.error.EMFUserError
Implements the query to erase a low functionality. All information needed is stored into the input LowFunctionality object.

Parameters:
aLowFunctionality - The object containing all erase information
profile - the profile
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

existByCode

java.lang.Integer existByCode(java.lang.String code)
                              throws it.eng.spago.error.EMFUserError
Control if exist a functionality with the given code.

Parameters:
code - The code of the functionality
Returns:
The functionality ID
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

hasChild

boolean hasChild(java.lang.Integer id)
                 throws it.eng.spago.error.EMFUserError
Control if the functionality with the given id has childs.

Parameters:
id - Integer id of the functionality
Returns:
true, if checks for child
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

deleteInconsistentRoles

void deleteInconsistentRoles(java.util.Set set)
                             throws it.eng.spago.error.EMFUserError
Delete inconsistent roles.

Parameters:
set - the set
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

loadAllLowFunctionalities

java.util.List loadAllLowFunctionalities(boolean recoverBIObjects)
                                         throws it.eng.spago.error.EMFUserError
Loads all the functionalities.

Parameters:
recoverBIObjects - If true each LowFunctionality at output will have the list of contained BIObject objects
Returns:
the list of functionalities
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

loadSubLowFunctionalities

java.util.List loadSubLowFunctionalities(java.lang.String initialPath,
                                         boolean recoverBIObjects)
                                         throws it.eng.spago.error.EMFUserError
Loads all the sub functionalities of the given initial path.

Parameters:
initialPath - The String representing the initial path
recoverBIObjects - If true each LowFunctionality at output will have the list of contained BIObject objects
Returns:
the list of functionalities
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

loadChildFunctionalities

java.util.List loadChildFunctionalities(java.lang.Integer parentId,
                                        boolean recoverBIObjects)
                                        throws it.eng.spago.error.EMFUserError
Loads all the child functionalities of the given parent functionality.

Parameters:
parentId - The Integer representing the parent id
recoverBIObjects - If true each LowFunctionality at output will have the list of contained BIObject objects
Returns:
the list of functionalities
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

loadRootLowFunctionality

LowFunctionality loadRootLowFunctionality(boolean recoverBIObjects)
                                          throws it.eng.spago.error.EMFUserError
Loads the root functionality.

Parameters:
recoverBIObjects - If true each LowFunctionality at output will have the list of contained BIObject objects
Returns:
the root functionality
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

moveUpLowFunctionality

void moveUpLowFunctionality(java.lang.Integer functionalityID)
                            throws it.eng.spago.error.EMFUserError
Moves up the functionality specified by the id at input in the functionalities tree.

Parameters:
functionalityID - the functionality id
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

moveDownLowFunctionality

void moveDownLowFunctionality(java.lang.Integer functionalityID)
                              throws it.eng.spago.error.EMFUserError
Moves down the functionality specified by the id at input in the functionalities tree.

Parameters:
functionalityID - the functionality id
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

loadUserFunctionalities

java.util.List loadUserFunctionalities(java.lang.Integer parentId,
                                       boolean recoverBIObjects,
                                       it.eng.spago.security.IEngUserProfile profile)
                                       throws it.eng.spago.error.EMFUserError
Loads the user's functionalities.

Parameters:
onlyFirstLevel - If true returns only first level functionalities, if else all
recoverBIObjects - If true each LowFunctionality at output will have the list of contained BIObject objects
profile - the user profile
Returns:
the root functionality
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

loadUserFunctionalitiesFiltered

java.util.List loadUserFunctionalitiesFiltered(java.lang.Integer parentId,
                                               boolean recoverBIObjects,
                                               it.eng.spago.security.IEngUserProfile profile,
                                               java.lang.String permission)
                                               throws it.eng.spago.error.EMFUserError
Load all functionalities associated the user roles.

Parameters:
onlyFirstLevel - limits functionalities to first level
recoverBIObjects - the recover bi objects
Returns:
the list
Throws:
it.eng.spago.error.EMFUserError - the EMF user error
See Also:
loadAllLowFunctionalities(boolean)

loadParentFunctionalities

java.util.List loadParentFunctionalities(java.lang.Integer functId,
                                         java.lang.Integer rootFolderID)
                                         throws it.eng.spago.error.EMFUserError
Load all fathers functionalities to root level.

Parameters:
functId - the identifier of functionality child
Returns:
the list
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

loadAllUserFunct

java.util.List loadAllUserFunct()
                                throws it.eng.spago.error.EMFUserError
Load all functionalities with type USER_FUNCT

Returns:
the list
Throws:
it.eng.spago.error.EMFUserError - the EMF user error