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

All Superinterfaces:
ISpagoBIDao
All Known Implementing Classes:
ViewpointDAOHimpl

public interface IViewpointDAO
extends ISpagoBIDao

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

Author:
Giachino

Method Summary
 void eraseViewpoint(java.lang.Integer ID)
          Implements the query to erase a viewpoint.
 void insertViewpoint(Viewpoint viewpoint)
          Implements the query to insert a viewpoint.
 java.util.List loadAccessibleViewpointsByObjId(java.lang.Integer objId, it.eng.spago.security.IEngUserProfile userProfile)
          Loads all detail information for all viewpoints of a object specified accessibile to the user profile at input.
 java.util.List loadAllViewpoints()
          Loads all detail information for all viewpoints.
 java.util.List loadAllViewpointsByObjID(java.lang.Integer objId)
          Loads all detail information for all viewpoints of a object specified.
 Viewpoint loadViewpointByID(java.lang.Integer id)
          Loads all detail information for a viewpoint identified by its id.
 Viewpoint loadViewpointByNameAndBIObjectId(java.lang.String name, java.lang.Integer biobjectId)
          Loads all detail information for a viewpoint identified by its name and relevant document identifier.
 
Methods inherited from interface it.eng.spagobi.commons.dao.ISpagoBIDao
getUserProfile, setUserID, setUserProfile
 

Method Detail

loadAllViewpoints

java.util.List loadAllViewpoints()
                                 throws it.eng.spago.error.EMFUserError
Loads all detail information for all viewpoints. For each of them, detail information is stored into a ViewPoint object. After that, all value constraints are stored into a List, which is returned.

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

loadAllViewpointsByObjID

java.util.List loadAllViewpointsByObjID(java.lang.Integer objId)
                                        throws it.eng.spago.error.EMFUserError
Loads all detail information for all viewpoints of a object specified. For each of them, detail information is stored into a ViewPoint object. After that, all value constraints are stored into a List, which is returned.

Parameters:
objId - the obj id
Returns:
A list containing all viewpoints objects
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

loadViewpointByID

Viewpoint loadViewpointByID(java.lang.Integer id)
                            throws it.eng.spago.error.EMFUserError
Loads all detail information for a viewpoint identified by its id. All these information are stored into a Viewpoint object, which is returned.

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

loadViewpointByNameAndBIObjectId

Viewpoint loadViewpointByNameAndBIObjectId(java.lang.String name,
                                           java.lang.Integer biobjectId)
                                           throws it.eng.spago.error.EMFUserError
Loads all detail information for a viewpoint identified by its name and relevant document identifier. All these information are stored into a Viewpoint object, which is returned.

Parameters:
name - The name for the viewpoint to load
name - The id of the document
Returns:
A Viewpoint object containing all loaded information
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

eraseViewpoint

void eraseViewpoint(java.lang.Integer ID)
                    throws it.eng.spago.error.EMFUserError
Implements the query to erase a viewpoint. All information needed is stored into the input Viewpoint object.

Parameters:
ID - The identifier of viewpoint
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

insertViewpoint

void insertViewpoint(Viewpoint viewpoint)
                     throws it.eng.spago.error.EMFUserError
Implements the query to insert a viewpoint. All information needed is stored into the input Viewpoint object.

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

loadAccessibleViewpointsByObjId

java.util.List loadAccessibleViewpointsByObjId(java.lang.Integer objId,
                                               it.eng.spago.security.IEngUserProfile userProfile)
                                               throws it.eng.spago.error.EMFUserError
Loads all detail information for all viewpoints of a object specified accessibile to the user profile at input. For each of them, detail information is stored into a ViewPoint object. After that, all value constraints are stored into a List, which is returned.

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