it.eng.spagobi.analiticalmodel.document.dao
Interface IBIObjectDAO

All Known Implementing Classes:
BIObjectDAOHibImpl

public interface IBIObjectDAO

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


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.
 void insertBIObject(BIObject obj, boolean loadParsDC)
          Implements the query to insert a BIObject and its template.
 void insertBIObject(BIObject obj, ObjTemplate objTemp)
          Implements the query to insert a BIObject and its template.
 void insertBIObject(BIObject obj, ObjTemplate objTemp, boolean loadParsDC)
          Implements the query to insert a BIObject and its template.
 java.util.List loadAllBIObjects()
          Loads all the BIObjects.
 java.util.List loadAllBIObjects(java.lang.String filterOrder)
          Loads all the BIObjects ordered by parameter column.
 java.util.List loadAllBIObjectsFromInitialPath(java.lang.String initialPath)
          Loads all the BIObjects that belong to sub functionalities of the given functionality path.
 java.util.List loadAllBIObjectsFromInitialPath(java.lang.String initialPath, java.lang.String filterOrder)
          Loads all the BIObjects that belong to sub functionalities of the given functionality path and ordered by parameter column.
 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.
 java.util.List loadBIObjects(java.lang.Integer folderID, it.eng.spago.security.IEngUserProfile profile)
          Loads all the BIObjects filtering with the input parameters.
 java.util.List loadBIObjects(java.lang.String type, java.lang.String state, java.lang.String folderPath)
          Loads all the BIObjects filtering with the input parameters.
 void modifyBIObject(BIObject obj)
          Implements the query to modify a BI Object.
 void modifyBIObject(BIObject obj, boolean loadParsDC)
          Implements the query to modify a BI Object.
 void modifyBIObject(BIObject obj, ObjTemplate objTemp)
          Implements the query to modify a BI Object and its template.
 void modifyBIObject(BIObject obj, ObjTemplate objTemp, boolean loadParsDC)
          Implements the query to modify a BI Object and its template.
 java.util.List searchBIObjects(java.lang.String valueFilter, java.lang.String typeFilter, java.lang.String columnFilter, java.lang.String isGlobal, java.lang.Integer nodeFilter, it.eng.spago.security.IEngUserProfile profile)
          Search objects with the features specified.
 

Method Detail

loadBIObjectForExecutionByIdAndRole

BIObject loadBIObjectForExecutionByIdAndRole(java.lang.Integer id,
                                             java.lang.String role)
                                             throws it.eng.spago.error.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:
it.eng.spago.error.EMFUserError - If an Exception occurs

loadBIObjectByLabel

BIObject loadBIObjectByLabel(java.lang.String label)
                             throws it.eng.spago.error.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:
it.eng.spago.error.EMFUserError - If an Exception occurs

loadBIObjectById

BIObject loadBIObjectById(java.lang.Integer biObjectID)
                          throws it.eng.spago.error.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:
it.eng.spago.error.EMFUserError - If an Exception occurs

loadBIObjectForDetail

BIObject loadBIObjectForDetail(java.lang.Integer id)
                               throws it.eng.spago.error.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 id
Returns:
The BI object detail information, stored into a BIObject
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurs

loadBIObjectForDetail

BIObject loadBIObjectForDetail(java.lang.String path)
                               throws it.eng.spago.error.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:
path - the path
Returns:
The BI object detail information, stored into a BIObject
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurs

loadBIObjectForTree

BIObject loadBIObjectForTree(java.lang.Integer id)
                             throws it.eng.spago.error.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 id
Returns:
The BI object tree information, stored into a BIObject
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurs

modifyBIObject

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

Parameters:
obj - the obj
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

modifyBIObject

void modifyBIObject(BIObject obj,
                    boolean loadParsDC)
                    throws it.eng.spago.error.EMFUserError
Implements the query to modify a BI Object. All information needed is stored into the input BIObject object.

Parameters:
obj - the obj
loadParsDC - the boolean that permit the loading of parameters of a document composition
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

modifyBIObject

void modifyBIObject(BIObject obj,
                    ObjTemplate objTemp)
                    throws it.eng.spago.error.EMFUserError
Implements the query to modify a BI Object and its template. All information needed is stored into the input BIObject and ObjTemplate objects.

Parameters:
objTemp - The template of the biobject
obj - the obj
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

modifyBIObject

void modifyBIObject(BIObject obj,
                    ObjTemplate objTemp,
                    boolean loadParsDC)
                    throws it.eng.spago.error.EMFUserError
Implements the query to modify a BI Object and its template. All information needed is stored into the input BIObject and ObjTemplate objects.

Parameters:
objTemp - The template of the biobject
obj - the obj
loadParsDC - the boolean that permit the loading of parameters of a document composition
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

insertBIObject

void insertBIObject(BIObject obj)
                    throws it.eng.spago.error.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:
it.eng.spago.error.EMFUserError - If an Exception occurred

insertBIObject

void insertBIObject(BIObject obj,
                    boolean loadParsDC)
                    throws it.eng.spago.error.EMFUserError
Implements the query to insert a BIObject and its template. All information needed is stored into the input BIObject and ObjTemplate objects.

Parameters:
obj - The object containing all insert information
loadParsDC - the boolean that permit the loading of parameters of a document composition
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

insertBIObject

void insertBIObject(BIObject obj,
                    ObjTemplate objTemp)
                    throws it.eng.spago.error.EMFUserError
Implements the query to insert a BIObject and its template. All information needed is stored into the input BIObject and ObjTemplate objects.

Parameters:
obj - The object containing all insert information
objTemp - The template of the biobject
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

insertBIObject

void insertBIObject(BIObject obj,
                    ObjTemplate objTemp,
                    boolean loadParsDC)
                    throws it.eng.spago.error.EMFUserError
Implements the query to insert a BIObject and its template. All information needed is stored into the input BIObject and ObjTemplate objects.

Parameters:
obj - The object containing all insert information
objTemp - The template of the biobject
loadParsDC - the boolean that permit the loading of parameters of a document composition
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

eraseBIObject

void eraseBIObject(BIObject obj,
                   java.lang.Integer idFunct)
                   throws it.eng.spago.error.EMFUserError
Deletes a BIObject from a functionality. If the functionality is not specified (i.e. idFunct == null), the method deletes the BIObject from all the functionalities. 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:
it.eng.spago.error.EMFUserError - If an Exception occurred

getCorrectRolesForExecution

java.util.List getCorrectRolesForExecution(java.lang.Integer id,
                                           it.eng.spago.security.IEngUserProfile profile)
                                           throws it.eng.spago.error.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:
it.eng.spago.error.EMFUserError - If an Exception occurred

getCorrectRolesForExecution

java.util.List getCorrectRolesForExecution(java.lang.Integer id)
                                           throws it.eng.spago.error.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:
it.eng.spago.error.EMFUserError - If an Exception occurred

getBIObjectParameters

java.util.List getBIObjectParameters(BIObject aBIObject)
                                     throws it.eng.spago.error.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:
it.eng.spago.error.EMFUserError - the EMF user error

loadAllBIObjects

java.util.List loadAllBIObjects()
                                throws it.eng.spago.error.EMFUserError
Loads all the BIObjects.

Returns:
the list of BIObjects
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

loadAllBIObjects

java.util.List loadAllBIObjects(java.lang.String filterOrder)
                                throws it.eng.spago.error.EMFUserError
Loads all the BIObjects ordered by parameter column.

Parameters:
filterOrder - the filter order
Returns:
the list of BIObjects
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

loadAllBIObjectsFromInitialPath

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

Parameters:
initialPath - the initial path
Returns:
the list of BIObjects
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

loadAllBIObjectsFromInitialPath

java.util.List loadAllBIObjectsFromInitialPath(java.lang.String initialPath,
                                               java.lang.String filterOrder)
                                               throws it.eng.spago.error.EMFUserError
Loads all the BIObjects that belong to sub functionalities of the given functionality path and ordered by parameter column.

Parameters:
initialPath - the initial path
filterOrder - the filter order
Returns:
the list of BIObjects
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

loadBIObjects

java.util.List loadBIObjects(java.lang.String type,
                             java.lang.String state,
                             java.lang.String folderPath)
                             throws it.eng.spago.error.EMFUserError
Loads all the BIObjects filtering with the input parameters.

Parameters:
type - the type of the biobjects (DASH/REPORT/OLAP...); if it is null, all types will be considered
state - the type of the biobjects (REL/DEV...); if it is null, all states will be considered
folderPath - the path of the folder; if it is null, all folders will be considered
Returns:
the list of BIObjects
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

loadBIObjects

java.util.List loadBIObjects(java.lang.Integer folderID,
                             it.eng.spago.security.IEngUserProfile profile)
                             throws it.eng.spago.error.EMFUserError
Loads all the BIObjects filtering with the input parameters.

Parameters:
folderID - the identifier of the folder; if it is null, all folders will be considered
profile - the user profile
Returns:
the list of BIObjects
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

searchBIObjects

java.util.List searchBIObjects(java.lang.String valueFilter,
                               java.lang.String typeFilter,
                               java.lang.String columnFilter,
                               java.lang.String isGlobal,
                               java.lang.Integer nodeFilter,
                               it.eng.spago.security.IEngUserProfile profile)
                               throws it.eng.spago.error.EMFUserError
Search objects with the features specified.

Parameters:
valueFilter - the value of the filter for the research
typeFilter - the type of the filter (the operator: equals, starts...)
columnFilter - the column on which the filter is applied
nodeFilter - the node (folder id) on which the filter is applied
profile - the profile of the user
Returns:
the list of BIObjects
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred