it.eng.spagobi.engines
Interface InternalEngineIFace

All Known Implementing Classes:
SpagoBIAbstractInternalEngine, SpagoBIChartInternalEngine, SpagoBIDashboardInternalEngine, SpagoBIDocumentCompositionInternalEngine, SpagoBIDossierInternalEngine, SpagoBIKpiInternalEngine, SpagoBIOfficeDocumentInternalEngine, SpagoBIWidgetInternalEngine

public interface InternalEngineIFace

Defines the interface for internal engines.

Author:
Zerbetto

Method Summary
 void execute(it.eng.spago.base.RequestContainer requestContainer, BIObject obj, it.eng.spago.base.SourceBean response)
          Executes the document and populates the response.
 void executeSubObject(it.eng.spago.base.RequestContainer requestContainer, BIObject obj, it.eng.spago.base.SourceBean response, java.lang.Object subObjectInfo)
          Executes the subobject of the document and populates the response.
 void handleDocumentTemplateEdit(it.eng.spago.base.RequestContainer requestContainer, BIObject obj, it.eng.spago.base.SourceBean response)
          Handles the request for the modification of the current document template.
 void handleNewDocumentTemplateCreation(it.eng.spago.base.RequestContainer requestContainer, BIObject obj, it.eng.spago.base.SourceBean response)
          Handles the request for the creation of a new document template.
 

Method Detail

execute

void execute(it.eng.spago.base.RequestContainer requestContainer,
             BIObject obj,
             it.eng.spago.base.SourceBean response)
             throws it.eng.spago.error.EMFUserError
Executes the document and populates the response.

Parameters:
requestContainer - The RequestContainer object (the session can be retrieved from this object)
obj - The BIObject representing the document to be executed
response - The response SourceBean to be populated
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

executeSubObject

void executeSubObject(it.eng.spago.base.RequestContainer requestContainer,
                      BIObject obj,
                      it.eng.spago.base.SourceBean response,
                      java.lang.Object subObjectInfo)
                      throws it.eng.spago.error.EMFUserError
Executes the subobject of the document and populates the response.

Parameters:
requestContainer - The RequestContainer object (the session can be retrieved from this object)
obj - The BIObject representing the document
response - The response SourceBean to be populated
subObjectInfo - An object describing the subobject to be executed
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

handleNewDocumentTemplateCreation

void handleNewDocumentTemplateCreation(it.eng.spago.base.RequestContainer requestContainer,
                                       BIObject obj,
                                       it.eng.spago.base.SourceBean response)
                                       throws it.eng.spago.error.EMFUserError,
                                              InvalidOperationRequest
Handles the request for the creation of a new document template.

Parameters:
requestContainer - The RequestContainer object (the session can be retrieved from this object)
obj - The BIObject representing the document
response - The response SourceBean to be populated
Throws:
it.eng.spago.error.EMFUserError - the EMF user error
InvalidOperationRequest - the invalid operation request

handleDocumentTemplateEdit

void handleDocumentTemplateEdit(it.eng.spago.base.RequestContainer requestContainer,
                                BIObject obj,
                                it.eng.spago.base.SourceBean response)
                                throws it.eng.spago.error.EMFUserError,
                                       InvalidOperationRequest
Handles the request for the modification of the current document template.

Parameters:
requestContainer - The RequestContainer object (the session can be retrieved from this object)
obj - The BIObject representing the document
response - The response SourceBean to be populated
Throws:
it.eng.spago.error.EMFUserError - the EMF user error
InvalidOperationRequest - the invalid operation request