it.eng.spagobi.bo.dao
Interface IEngineDAO

All Known Implementing Classes:
EngineDAOHibImpl, EngineDAOImpl

public interface IEngineDAO

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.
 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 loadAllEngines()
          Loads all detail information for all engines.
 Engine loadEngineByID(java.lang.Integer engineID)
          Loads all detail information for an engine identified by its engineID.
 void modifyEngine(Engine aEngine)
          Implements the query to modify an engine.
 

Method Detail

loadEngineByID

public Engine loadEngineByID(java.lang.Integer engineID)
                      throws 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:
EMFUserError - If an Exception occurred

loadAllEngines

public java.util.List loadAllEngines()
                              throws 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:
EMFUserError - If an Exception occurred

modifyEngine

public void modifyEngine(Engine aEngine)
                  throws 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:
EMFUserError - If an Exception occurred

insertEngine

public void insertEngine(Engine aEngine)
                  throws 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:
EMFUserError - If an Exception occurred

eraseEngine

public void eraseEngine(Engine aEngine)
                 throws 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:
EMFUserError - If an Exception occurred

hasBIObjAssociated

public boolean hasBIObjAssociated(java.lang.String engineId)
                           throws 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:
EMFUserError - If any exception occurred