it.eng.spagobi.tools.dataset.dao
Interface IDataSetDAO

All Known Implementing Classes:
DataSetDAOHibImpl

public interface IDataSetDAO

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


Method Summary
 java.lang.Integer countDatasets()
           
 void eraseDataSet(it.eng.spagobi.tools.dataset.bo.IDataSet aDataSet)
          Implements the query to erase a data Set.
 boolean hasBIObjAssociated(java.lang.String dsId)
          Tells if a data Set is associated to any BI Object.
 void insertDataSet(it.eng.spagobi.tools.dataset.bo.IDataSet aDataSet)
          Implements the query to insert a data Set.
 java.util.List loadAllDataSets()
          Loads all detail information for all data Sets.
 it.eng.spagobi.tools.dataset.bo.IDataSet loadDataSetByID(java.lang.Integer dsID)
          Loads all detail information for a data set identified by its dsID.
 it.eng.spagobi.tools.dataset.bo.IDataSet loadDataSetByLabel(java.lang.String label)
          Loads all detail information for data Set whose label is equal to label.
 java.util.List loadPagedDatasetList(java.lang.Integer offset, java.lang.Integer fetchSize)
           
 void modifyDataSet(it.eng.spagobi.tools.dataset.bo.IDataSet aDataSet)
          Implements the query to modify a data Set.
 

Method Detail

loadDataSetByID

it.eng.spagobi.tools.dataset.bo.IDataSet loadDataSetByID(java.lang.Integer dsID)
                                                         throws it.eng.spago.error.EMFUserError
Loads all detail information for a data set identified by its dsID. All these information, achived by a query to the DB, are stored into a dataset object, which is returned.

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

loadDataSetByLabel

it.eng.spagobi.tools.dataset.bo.IDataSet loadDataSetByLabel(java.lang.String label)
                                                            throws it.eng.spago.error.EMFUserError
Loads all detail information for data Set whose label is equal to label.

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

loadAllDataSets

java.util.List loadAllDataSets()
                               throws it.eng.spago.error.EMFUserError
Loads all detail information for all data Sets. For each of them, detail information is stored into a dataset object. After that, all data Sets are stored into a List, which is returned.

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

loadPagedDatasetList

java.util.List loadPagedDatasetList(java.lang.Integer offset,
                                    java.lang.Integer fetchSize)
                                    throws it.eng.spago.error.EMFUserError
Throws:
it.eng.spago.error.EMFUserError

countDatasets

java.lang.Integer countDatasets()
                                throws it.eng.spago.error.EMFUserError
Throws:
it.eng.spago.error.EMFUserError

modifyDataSet

void modifyDataSet(it.eng.spagobi.tools.dataset.bo.IDataSet aDataSet)
                   throws it.eng.spago.error.EMFUserError
Implements the query to modify a data Set. All information needed is stored into the input dataset object.

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

insertDataSet

void insertDataSet(it.eng.spagobi.tools.dataset.bo.IDataSet aDataSet)
                   throws it.eng.spago.error.EMFUserError
Implements the query to insert a data Set. All information needed is stored into the input dataset object.

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

eraseDataSet

void eraseDataSet(it.eng.spagobi.tools.dataset.bo.IDataSet aDataSet)
                  throws it.eng.spago.error.EMFUserError
Implements the query to erase a data Set. All information needed is stored into the input dataset object.

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

hasBIObjAssociated

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

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