it.eng.spagobi.engines.config.dao
Interface IEngineDAO

All Superinterfaces:
ISpagoBIDao
All Known Implementing Classes:
EngineDAOHibImpl

public interface IEngineDAO
extends ISpagoBIDao

Defines the interfaces for all methods needed to insert, modify and deleting an engine.

Author:
Zoppello

Method Summary
 void eraseEngine(Engine aEngine)
          Implements the query to erase an engine.
 java.util.List getAssociatedExporters(Engine engineId)
          Get all the associated Exporters
 boolean hasBIObjAssociated(java.lang.String engineId)
          Tells if an engine is associated to any BI Object.
 void insertEngine(Engine aEngine)
          Implements the query to insert an engine.
 java.util.List<Engine> loadAllEngines()
          Loads all detail information for all engines.
 java.util.List<Engine> loadAllEnginesForBIObjectType(java.lang.String biobjectType)
          Loads all detail information for all engines compatible to the BIObject type specified at input.
 Engine loadEngineByID(java.lang.Integer engineID)
          Loads all detail information for an engine identified by its engineID.
 Engine loadEngineByLabel(java.lang.String engineLabel)
          Loads all detail information for an engine identified by its engineLabel.
 void modifyEngine(Engine aEngine)
          Implements the query to modify an engine.
 
Methods inherited from interface it.eng.spagobi.commons.dao.ISpagoBIDao
getUserProfile, setUserID, setUserProfile
 

Method Detail

loadEngineByID

Engine loadEngineByID(java.lang.Integer engineID)
                      throws it.eng.spago.error.EMFUserError
Loads all detail information for an engine identified by its engineID. All these information, achived by a query to the DB, are stored into an engine object, which is returned.

Parameters:
engineID - The id for the engine to load
Returns:
An engine object containing all loaded information
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

loadEngineByLabel

Engine loadEngineByLabel(java.lang.String engineLabel)
                         throws it.eng.spago.error.EMFUserError
Loads all detail information for an engine identified by its engineLabel. All these information, achived by a query to the DB, are stored into an engine object, which is returned.

Parameters:
engineLabel - The label for the engine to load
Returns:
An engine object containing all loaded information
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

loadAllEngines

java.util.List<Engine> loadAllEngines()
                                      throws it.eng.spago.error.EMFUserError
Loads all detail information for all engines. For each of them, detail information is stored into an engine object. After that, all engines are stored into a List, which is returned.

Returns:
A list containing all engine objects
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

loadAllEnginesForBIObjectType

java.util.List<Engine> loadAllEnginesForBIObjectType(java.lang.String biobjectType)
                                                     throws it.eng.spago.error.EMFUserError
Loads all detail information for all engines compatible to the BIObject type specified at input. For each of them, detail information is stored into an engine object. After that, all engines are stored into a List, which is returned.

Parameters:
biobjectType - the biobject type
Returns:
A list containing all engine objects compatible with the BIObject type passed at input
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

modifyEngine

void modifyEngine(Engine aEngine)
                  throws it.eng.spago.error.EMFUserError
Implements the query to modify an engine. All information needed is stored into the input engine object.

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

insertEngine

void insertEngine(Engine aEngine)
                  throws it.eng.spago.error.EMFUserError
Implements the query to insert an engine. All information needed is stored into the input engine object.

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

eraseEngine

void eraseEngine(Engine aEngine)
                 throws it.eng.spago.error.EMFUserError
Implements the query to erase an engine. All information needed is stored into the input engine object.

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

hasBIObjAssociated

boolean hasBIObjAssociated(java.lang.String engineId)
                           throws it.eng.spago.error.EMFUserError
Tells if an engine is associated to any BI Object. It is useful because an engine cannot be deleted if it is used by one or more BI Objects.

Parameters:
engineId - The engine identifier
Returns:
True if the engine is used by one or more objects, else false
Throws:
it.eng.spago.error.EMFUserError - If any exception occurred

getAssociatedExporters

java.util.List getAssociatedExporters(Engine engineId)
                                      throws it.eng.spago.error.EMFUserError
Get all the associated Exporters

Parameters:
engineId - The engine identifier
Returns:
The list of associated Exporters
Throws:
it.eng.spago.error.EMFUserError - If any exception occurred