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)
          Implements the query to erase a BI Object.
 void fillBIObjectTemplate(BIObject obj)
          Given a BIObject at input, fills it with template information.
 java.util.List getCorrectRolesForExecution(java.lang.String pathReport)
          Gets the correct roles for Report execution, given only the Report's path.
 java.util.List getCorrectRolesForExecution(java.lang.String pathReport, it.eng.spago.security.IEngUserProfile profile)
          Given the path String for a report and th User profile, gets the corret roles for execution.
 void insertBIObject(BIObject obj)
          Implements the query to insert a BIObject.
 BIObject loadBIObjectForDetail(java.lang.Integer biObjectID)
          Loads all detail information for a BI Object identified by its biObjectID identifier.
 BIObject loadBIObjectForDetail(java.lang.String path)
          Loads all detail information for a BI Object identified by its path identifier string.
 BIObject loadBIObjectForExecutionByPathAndRole(java.lang.String path, java.lang.String role)
          Loads all information for the execution of a BI Object identified by its path and its role.
 BIObject loadBIObjectForTree(java.lang.String path)
          Loads all tree information for a BI Object identified by its path identifier string.
 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

loadBIObjectForExecutionByPathAndRole

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

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

loadBIObjectForDetail

public BIObject loadBIObjectForDetail(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

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

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

loadBIObjectForTree

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

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

modifyBIObject

public 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

public 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

public 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

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

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

fillBIObjectTemplate

public void fillBIObjectTemplate(BIObject obj)
Given a BIObject at input, fills it with template information.

Parameters:
obj - The object to fill template information in.

getCorrectRolesForExecution

public java.util.List getCorrectRolesForExecution(java.lang.String pathReport,
                                                  it.eng.spago.security.IEngUserProfile profile)
                                           throws EMFUserError
Given the path String for a report and th User profile, gets the corret roles for execution.

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

getCorrectRolesForExecution

public java.util.List getCorrectRolesForExecution(java.lang.String pathReport)
                                           throws EMFUserError
Gets the correct roles for Report execution, given only the Report's path.

Parameters:
pathReport - The String path for the report
Returns:
The list of correct roles for execution
Throws:
EMFUserError - If an Exception occurred