it.eng.spagobi.analiticalmodel.document.handlers
Class ExecutionInstance

java.lang.Object
  extended by it.eng.spagobi.analiticalmodel.document.handlers.ExecutionInstance

public class ExecutionInstance
extends java.lang.Object

This class represents a document execution instance. This contains the following attributes: 1. execution flow id: it is the id of an execution flow (execution in cross navigation mode share the same flow id) 2. execution id: single execution id, it is unique for a single execution 3. the BIObject being executed 4. the execution role 4. the execution modality

Author:
zerbetto

Constructor Summary
ExecutionInstance(it.eng.spago.security.IEngUserProfile userProfile, java.lang.String flowId, java.lang.String executionId, java.lang.Integer biobjectId, java.lang.String executionRole, java.lang.String executionModality)
          Instantiates a new execution instance.
ExecutionInstance(it.eng.spago.security.IEngUserProfile userProfile, java.lang.String flowId, java.lang.String executionId, java.lang.Integer biobjectId, java.lang.String executionRole, java.lang.String executionModality, boolean displayToolbar)
           
ExecutionInstance(it.eng.spago.security.IEngUserProfile userProfile, java.lang.String flowId, java.lang.String executionId, java.lang.Integer biobjectId, java.lang.String executionRole, java.lang.String executionModality, boolean displayToolbar, boolean displaySliders)
           
 
Method Summary
 void changeExecutionRole(java.lang.String newRole)
           
 boolean displaySliders()
           
 boolean displayToolbar()
           
 boolean equals(java.lang.Object another)
           
 void eraseParametersValues()
           
 BIObject getBIObject()
          Gets the bI object.
 java.util.Calendar getCalendar()
          Gets the calendar.
 java.lang.String getExecutionId()
          Gets the execution id.
 java.lang.String getExecutionModality()
          Gets the execution modality.
 java.lang.String getExecutionRole()
          Gets the current execution role.
 java.lang.String getExecutionUrl(java.util.Locale locale)
           
 java.lang.String getFlowId()
          Gets the flow id.
 java.util.List getParametersErrors()
           
 Snapshot getSnapshot()
           
 java.lang.String getSnapshotUrl()
           
 SubObject getSubObject()
           
 java.lang.String getSubObjectUrl(java.util.Locale locale)
           
 boolean isDirectExecution()
           
 void refreshBIObjectWithSDKParameters(it.eng.spagobi.sdk.documents.bo.SDKDocumentParameter[] parameters)
          This method is called by SDK to execute a document; it takes as input a list of SDK parameters, each with its own set of values and fill the BiObject object
 void refreshParametersValues(org.json.JSONObject jsonObject, boolean transientMode)
           
 void refreshParametersValues(java.util.Map parametersMap, boolean transientMode)
           
 void refreshParametersValues(it.eng.spago.base.SourceBean request, boolean transientMode)
           
 void setDisplaySliders(boolean displaySliders)
           
 void setDisplayToolbar(boolean displayToolbar)
           
 void setParameterValues(java.lang.String userProvidedParametersStr, boolean transientMode)
           
 void setSnapshot(Snapshot snapshot)
           
 void setSubObject(SubObject subObject)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ExecutionInstance

public ExecutionInstance(it.eng.spago.security.IEngUserProfile userProfile,
                         java.lang.String flowId,
                         java.lang.String executionId,
                         java.lang.Integer biobjectId,
                         java.lang.String executionRole,
                         java.lang.String executionModality)
                  throws java.lang.Exception
Instantiates a new execution instance.

Parameters:
flowId - the flow id
executionId - the execution id
obj - the obj
executionRole - the execution role
Throws:
java.lang.Exception

ExecutionInstance

public ExecutionInstance(it.eng.spago.security.IEngUserProfile userProfile,
                         java.lang.String flowId,
                         java.lang.String executionId,
                         java.lang.Integer biobjectId,
                         java.lang.String executionRole,
                         java.lang.String executionModality,
                         boolean displayToolbar)
                  throws java.lang.Exception
Throws:
java.lang.Exception

ExecutionInstance

public ExecutionInstance(it.eng.spago.security.IEngUserProfile userProfile,
                         java.lang.String flowId,
                         java.lang.String executionId,
                         java.lang.Integer biobjectId,
                         java.lang.String executionRole,
                         java.lang.String executionModality,
                         boolean displayToolbar,
                         boolean displaySliders)
                  throws java.lang.Exception
Throws:
java.lang.Exception
Method Detail

changeExecutionRole

public void changeExecutionRole(java.lang.String newRole)
                         throws java.lang.Exception
Throws:
java.lang.Exception

isDirectExecution

public boolean isDirectExecution()

setParameterValues

public void setParameterValues(java.lang.String userProvidedParametersStr,
                               boolean transientMode)

refreshParametersValues

public void refreshParametersValues(it.eng.spago.base.SourceBean request,
                                    boolean transientMode)

refreshParametersValues

public void refreshParametersValues(org.json.JSONObject jsonObject,
                                    boolean transientMode)

refreshParametersValues

public void refreshParametersValues(java.util.Map parametersMap,
                                    boolean transientMode)

getParametersErrors

public java.util.List getParametersErrors()
                                   throws java.lang.Exception
Throws:
java.lang.Exception

eraseParametersValues

public void eraseParametersValues()

getSnapshotUrl

public java.lang.String getSnapshotUrl()

getSubObjectUrl

public java.lang.String getSubObjectUrl(java.util.Locale locale)

refreshBIObjectWithSDKParameters

public void refreshBIObjectWithSDKParameters(it.eng.spagobi.sdk.documents.bo.SDKDocumentParameter[] parameters)
This method is called by SDK to execute a document; it takes as input a list of SDK parameters, each with its own set of values and fill the BiObject object

Parameters:
obj - The Bi Object
parameters - an array of SDKDocumentParameter

getExecutionUrl

public java.lang.String getExecutionUrl(java.util.Locale locale)

getExecutionId

public java.lang.String getExecutionId()
Gets the execution id.

Returns:
the execution id

getFlowId

public java.lang.String getFlowId()
Gets the flow id.

Returns:
the flow id

getBIObject

public BIObject getBIObject()
Gets the bI object.

Returns:
the bI object

getCalendar

public java.util.Calendar getCalendar()
Gets the calendar.

Returns:
the calendar

getExecutionRole

public java.lang.String getExecutionRole()
Gets the current execution role.

Returns:
the execution role

getExecutionModality

public java.lang.String getExecutionModality()
Gets the execution modality.

Returns:
the execution modality

displayToolbar

public boolean displayToolbar()

setDisplayToolbar

public void setDisplayToolbar(boolean displayToolbar)

displaySliders

public boolean displaySliders()

setDisplaySliders

public void setDisplaySliders(boolean displaySliders)

getSubObject

public SubObject getSubObject()

setSubObject

public void setSubObject(SubObject subObject)

getSnapshot

public Snapshot getSnapshot()

setSnapshot

public void setSnapshot(Snapshot snapshot)

equals

public boolean equals(java.lang.Object another)
Overrides:
equals in class java.lang.Object