it.eng.spagobi.bo.dao
Interface IAuditDAO

All Known Implementing Classes:
DbAuditImpl

public interface IAuditDAO


Method Summary
 void eraseAudit(java.lang.Integer id)
          Erase the audit record with the specified id
 void insertAudit(SbiAudit aSbiAudit)
          Insert an audit record as per the SbiAudit object at input
 java.util.List loadAllAudits()
          Returns the list of all audit records
 SbiAudit loadAuditByID(java.lang.Integer id)
          Loads all detail information for an audit record identified by its id.
 java.util.List loadAuditsByDocumentLabel(java.lang.String documentLabel)
          Returns the list of all audit records relevant to the document with the specified label at input
 java.util.List loadAuditsByEngineLabel(java.lang.String engineLabel)
          Returns the list of all audit records relevant to the engine with the specified label at input
 java.util.List loadAuditsByUserName(java.lang.String userName)
          Returns the list of all audit records relevant to the user with the specified name at input
 void modifyAudit(SbiAudit aSbiAudit)
          Modify an audit record as per the SbiAudit object at input
 

Method Detail

loadAllAudits

java.util.List loadAllAudits()
                             throws it.eng.spago.error.EMFUserError
Returns the list of all audit records

Returns:
A List object consisting of SbiAudit objects
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

loadAuditsByUserName

java.util.List loadAuditsByUserName(java.lang.String userName)
                                    throws it.eng.spago.error.EMFUserError
Returns the list of all audit records relevant to the user with the specified name at input

Parameters:
userName - The user name
Returns:
A List object consisting of SbiAudit objects relevant to the user specified at input
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

loadAuditsByDocumentLabel

java.util.List loadAuditsByDocumentLabel(java.lang.String documentLabel)
                                         throws it.eng.spago.error.EMFUserError
Returns the list of all audit records relevant to the document with the specified label at input

Parameters:
documentLabel - The document label
Returns:
A List object consisting of SbiAudit objects relevant to the document specified at input
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

loadAuditsByEngineLabel

java.util.List loadAuditsByEngineLabel(java.lang.String engineLabel)
                                       throws it.eng.spago.error.EMFUserError
Returns the list of all audit records relevant to the engine with the specified label at input

Parameters:
engineLabel - The engine label
Returns:
A List object consisting of SbiAudit objects relevant to the engine specified at input
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

loadAuditByID

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

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

insertAudit

void insertAudit(SbiAudit aSbiAudit)
                 throws it.eng.spago.error.EMFUserError
Insert an audit record as per the SbiAudit object at input

Parameters:
aSbiAudit - The SbiAudit object for the audit record to insert
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

modifyAudit

void modifyAudit(SbiAudit aSbiAudit)
                 throws it.eng.spago.error.EMFUserError
Modify an audit record as per the SbiAudit object at input

Parameters:
aSbiAudit - The SbiAudit object for the audit record to modify
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred

eraseAudit

void eraseAudit(java.lang.Integer id)
                throws it.eng.spago.error.EMFUserError
Erase the audit record with the specified id

Parameters:
id - The id of the audit record to be erased
Throws:
it.eng.spago.error.EMFUserError - If an Exception occurred