it.eng.spagobi.engines.widget
Class SpagoBIAbstractInternalEngine

java.lang.Object
  extended by it.eng.spagobi.engines.widget.SpagoBIAbstractInternalEngine
All Implemented Interfaces:
InternalEngineIFace
Direct Known Subclasses:
SpagoBIWidgetInternalEngine

public abstract class SpagoBIAbstractInternalEngine
extends java.lang.Object
implements InternalEngineIFace

Author:
Andrea Gioia (andrea.gioia@eng.it)

Constructor Summary
SpagoBIAbstractInternalEngine()
           
 
Method Summary
abstract  void doCreateDocumentTemplate()
           
abstract  void doExecute()
           
abstract  void doExecuteSubObject()
           
abstract  void doModifyDocumentTemplate()
           
 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.
 it.eng.spagobi.tools.dataset.bo.IDataSet getDataSet()
           
 java.util.Locale getLocale()
           
protected  BIObject getObj()
           
protected  it.eng.spago.base.RequestContainer getRequestContainer()
           
protected  it.eng.spago.base.SourceBean getResponse()
           
protected  it.eng.spago.base.SessionContainer getSession()
           
protected  java.lang.Object getSubObjectInfo()
           
 byte[] getTemplate()
           
 org.json.JSONObject getTemplateAsJSONObject()
           
 java.lang.String getTemplateAsString()
           
 it.eng.spago.security.IEngUserProfile getUserProfile()
           
 void handleCreateDocumentTemplateException(java.lang.Throwable t)
           
 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 handleException(java.lang.Throwable t)
           
 void handleExecutionException(java.lang.Throwable t)
           
 void handleModifyDocumentTemplateException(java.lang.Throwable t)
           
 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.
 void handleSubObjectExecutionException(java.lang.Throwable t)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SpagoBIAbstractInternalEngine

public SpagoBIAbstractInternalEngine()
Method Detail

execute

public void execute(it.eng.spago.base.RequestContainer requestContainer,
                    BIObject obj,
                    it.eng.spago.base.SourceBean response)
             throws it.eng.spago.error.EMFUserError
Description copied from interface: InternalEngineIFace
Executes the document and populates the response.

Specified by:
execute in interface InternalEngineIFace
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

doExecute

public abstract void doExecute()

handleExecutionException

public void handleExecutionException(java.lang.Throwable t)

executeSubObject

public 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
Description copied from interface: InternalEngineIFace
Executes the subobject of the document and populates the response.

Specified by:
executeSubObject in interface InternalEngineIFace
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

doExecuteSubObject

public abstract void doExecuteSubObject()

handleSubObjectExecutionException

public void handleSubObjectExecutionException(java.lang.Throwable t)

handleNewDocumentTemplateCreation

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

Specified by:
handleNewDocumentTemplateCreation in interface InternalEngineIFace
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

doCreateDocumentTemplate

public abstract void doCreateDocumentTemplate()

handleCreateDocumentTemplateException

public void handleCreateDocumentTemplateException(java.lang.Throwable t)

handleDocumentTemplateEdit

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

Specified by:
handleDocumentTemplateEdit in interface InternalEngineIFace
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

doModifyDocumentTemplate

public abstract void doModifyDocumentTemplate()

handleModifyDocumentTemplateException

public void handleModifyDocumentTemplateException(java.lang.Throwable t)

handleException

public void handleException(java.lang.Throwable t)

getUserProfile

public it.eng.spago.security.IEngUserProfile getUserProfile()

getTemplateAsJSONObject

public org.json.JSONObject getTemplateAsJSONObject()
                                            throws org.json.JSONException
Throws:
org.json.JSONException

getTemplateAsString

public java.lang.String getTemplateAsString()

getTemplate

public byte[] getTemplate()

getDataSet

public it.eng.spagobi.tools.dataset.bo.IDataSet getDataSet()

getLocale

public java.util.Locale getLocale()

getRequestContainer

protected it.eng.spago.base.RequestContainer getRequestContainer()

getObj

protected BIObject getObj()

getResponse

protected it.eng.spago.base.SourceBean getResponse()

getSubObjectInfo

protected java.lang.Object getSubObjectInfo()

getSession

protected it.eng.spago.base.SessionContainer getSession()