it.eng.spagobi.bo.dao
Interface ILowFunctionalityDAO

All Known Implementing Classes:
LowFunctionalityDAOHibImpl

public interface ILowFunctionalityDAO

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

Author:
Zoppello

Method Summary
 void deleteInconsistentRoles(java.util.Set set)
           
 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.
 java.util.List loadAllLowFunctionalities(boolean recoverBIObjects)
          Loads all the functionalities
 java.util.List loadChildFunctionalities(java.lang.Integer parentId, boolean recoverBIObjects)
          Loads all the child functionalities of the given parent functionality
 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 loadSubLowFunctionalities(java.lang.String initialPath, boolean recoverBIObjects)
          Loads all the sub functionalities of the given initial path
 void modifyLowFunctionality(LowFunctionality aLowFunctionality)
          Implements the query to modify a low functionality.
 

Method Detail

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

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

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
Throws:
it.eng.spago.error.EMFUserError

deleteInconsistentRoles

void deleteInconsistentRoles(java.util.Set set)
                             throws it.eng.spago.error.EMFUserError
Throws:
it.eng.spago.error.EMFUserError

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

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

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