it.eng.spagobi.bo.dao
Interface IBIObjectDAO

All Known Implementing Classes:
BIObjectDAOHibImpl, BIObjectDAOImpl

public interface IBIObjectDAO

Defines the interfaces for all methods needed to insert, modify and deleting a BI object.

Author:
Zoppello

Method Summary
 void eraseBIObject(BIObject obj, java.lang.Integer idFunct)
          Deletes a BIObject from a functionality.
 java.util.List getBIObjectParameters(BIObject aBIObject)
          Gets the biparameters associated with to a biobject
 java.util.List getCorrectRolesForExecution(java.lang.Integer id)
          Gets the correct roles for Report execution, given only the Report's id.
 java.util.List getCorrectRolesForExecution(java.lang.Integer id, it.eng.spago.security.IEngUserProfile profile)
          Given the id for a report and the user profile, gets the corret roles for execution.
 void insertBIObject(BIObject obj)
          Implements the query to insert a BIObject.
 java.util.List loadAllBIObjects()
          Loads all the BIObjects
 java.util.List loadAllBIObjectsFromInitialPath(java.lang.String initialPath)
          Loads all the BIObjects that belong to sub functionalities of the given functionality path
 BIObject loadBIObjectById(java.lang.Integer biObjectID)
          Loads all detail information for a BI Object identified by its biObjectID identifier.
 BIObject loadBIObjectByLabel(java.lang.String label)
          Loads all detail information for a BI Object identified by its label identifier.
 BIObject loadBIObjectForDetail(java.lang.Integer id)
          Loads all detail information for a BI Object identified by its id identifier integer.
 BIObject loadBIObjectForDetail(java.lang.String path)
          Loads all detail information for a BI Object identified by its path in the cms.
 BIObject loadBIObjectForExecutionByIdAndRole(java.lang.Integer id, java.lang.String role)
          Loads all information for the execution of a BI Object identified by its id and its role.
 BIObject loadBIObjectForTree(java.lang.Integer id)
          Loads all tree information for a BI Object identified by its id identifier Integer.
 void modifyBIObject(BIObject obj)
          Implements the query to modify a BI Object.
 void modifyBIObjectWithoutVersioning(BIObject obj)
          Implements the query to modify a BI Object, but without updating versioning.
 

Method Detail

loadBIObjectForExecutionByIdAndRole

BIObject loadBIObjectForExecutionByIdAndRole(java.lang.Integer id,
                                             java.lang.String role)
                                             throws EMFUserError
Loads all information for the execution of a BI Object identified by its id and its role. All these information, achived by a query to the DB, are stored into a BIObject object, which is returned.

Parameters:
id - The BI object id
role - The BI object role
Returns:
The BIobject execution information, stored into a BIObject
Throws:
EMFUserError - If an Exception occurs

loadBIObjectByLabel

BIObject loadBIObjectByLabel(java.lang.String label)
                             throws EMFUserError
Loads all detail information for a BI Object identified by its label identifier. All these information, achived by a query to the DB, are stored into a BIObject object, which is returned.

Parameters:
label - The BI object label identifier
Returns:
The BI object detail information, stored into a BIObject
Throws:
EMFUserError - If an Exception occurs

loadBIObjectById

BIObject loadBIObjectById(java.lang.Integer biObjectID)
                          throws EMFUserError
Loads all detail information for a BI Object identified by its biObjectID identifier. All these information, achived by a query to the DB, are stored into a BIObject object, which is returned.

Parameters:
biObjectID - the BI object identifier
Returns:
The BI object detail information, stored into a BIObject
Throws:
EMFUserError - If an Exception occurs

loadBIObjectForDetail

BIObject loadBIObjectForDetail(java.lang.Integer id)
                               throws EMFUserError
Loads all detail information for a BI Object identified by its id identifier integer. All these information, achived by a query to the DB, are stored into a BIObject object, which is returned.

Parameters:
id - The Integer representing the BI object id
Returns:
The BI object detail information, stored into a BIObject
Throws:
EMFUserError - If an Exception occurs

loadBIObjectForDetail

BIObject loadBIObjectForDetail(java.lang.String path)
                               throws EMFUserError
Loads all detail information for a BI Object identified by its path in the cms. All these information, achived by a query to the DB, are stored into a BIObject object, which is returned.

Parameters:
id - The Integer representing the BI object id
Returns:
The BI object detail information, stored into a BIObject
Throws:
EMFUserError - If an Exception occurs

loadBIObjectForTree

BIObject loadBIObjectForTree(java.lang.Integer id)
                             throws EMFUserError
Loads all tree information for a BI Object identified by its id identifier Integer. All these information, achived by a query to the DB, are stored into a BIObject object, which is returned.

Parameters:
id - The Integer representing the BI object id
Returns:
The BI object tree information, stored into a BIObject
Throws:
EMFUserError - If an Exception occurs

modifyBIObject

void modifyBIObject(BIObject obj)
                    throws EMFUserError
Implements the query to modify a BI Object. All information needed is stored into the input BIObject object.

Parameters:
obj - The BIobject containing all modify information
Throws:
EMFUserError - If an Exception occurred

modifyBIObjectWithoutVersioning

void modifyBIObjectWithoutVersioning(BIObject obj)
                                     throws EMFUserError
Implements the query to modify a BI Object, but without updating versioning. All information needed is stored into the input BIObject object.

Parameters:
obj - The BIobject containing all modify information
Throws:
EMFUserError - If an Exception occurred

insertBIObject

void insertBIObject(BIObject obj)
                    throws EMFUserError
Implements the query to insert a BIObject. All information needed is stored into the input BIObject object.

Parameters:
obj - The object containing all insert information
Throws:
EMFUserError - If an Exception occurred

eraseBIObject

void eraseBIObject(BIObject obj,
                   java.lang.Integer idFunct)
                   throws EMFUserError
Deletes a BIObject from a functionality. Then, if the BIObject is no more referenced in any functionality, deletes it completely from db and from CMS

Parameters:
obj - The object containing all delete information
idFunct - The Integer representing the functionality id
Throws:
EMFUserError - If an Exception occurred

getCorrectRolesForExecution

java.util.List getCorrectRolesForExecution(java.lang.Integer id,
                                           it.eng.spago.security.IEngUserProfile profile)
                                           throws EMFUserError
Given the id for a report and the user profile, gets the corret roles for execution.

Parameters:
id - The Integer id for the report
profile - The user profile
Returns:
The list of correct roles for execution
Throws:
EMFUserError - If an Exception occurred

getCorrectRolesForExecution

java.util.List getCorrectRolesForExecution(java.lang.Integer id)
                                           throws EMFUserError
Gets the correct roles for Report execution, given only the Report's id.

Parameters:
id - The Integer id for the report
Returns:
The list of correct roles for execution
Throws:
EMFUserError - If an Exception occurred

getBIObjectParameters

java.util.List getBIObjectParameters(BIObject aBIObject)
                                     throws EMFUserError
Gets the biparameters associated with to a biobject

Parameters:
aBIObject - BIObject the biobject to analize
Returns:
List, list of the biparameters associated with the biobject
Throws:
EMFUserError

loadAllBIObjects

java.util.List loadAllBIObjects()
                                throws EMFUserError
Loads all the BIObjects

Returns:
the list of BIObjects
Throws:
EMFUserError - If an Exception occurred

loadAllBIObjectsFromInitialPath

java.util.List loadAllBIObjectsFromInitialPath(java.lang.String initialPath)
                                               throws EMFUserError
Loads all the BIObjects that belong to sub functionalities of the given functionality path

Returns:
the list of BIObjects
Throws:
EMFUserError - If an Exception occurred