Package org.pentaho.platform.engine.services

Class BaseRequestHandler

java.lang.Object

org.pentaho.platform.engine.services.BaseRequestHandler

All Implemented Interfaces:

org.pentaho.platform.api.engine.IActionCompleteListener, org.pentaho.platform.api.engine.IActionRequestHandler

public class BaseRequestHandler
extends Object
implements org.pentaho.platform.api.engine.IActionRequestHandler, org.pentaho.platform.api.engine.IActionCompleteListener

Field Summary

Fields

Modifier and Type	Field	Description
protected org.pentaho.platform.api.engine.ICreateFeedbackParameterCallback	createFeedbackParameterCallback
protected boolean	forcePrompt
protected boolean	instanceEnds
static int	ON_TIMEOUT_CANCEL
static int	ON_TIMEOUT_RETURN
protected String	parameterXsl
protected String	processId
protected org.pentaho.platform.api.engine.IRuntimeContext	runtime
protected org.pentaho.platform.api.engine.IPentahoSession	session
protected org.pentaho.platform.api.engine.IPentahoUrlFactory	urlFactory

Constructor Summary

Constructors

Constructor	Description
BaseRequestHandler(org.pentaho.platform.api.engine.IPentahoSession session, String instanceId, org.pentaho.platform.api.engine.IOutputHandler outputHandler, org.pentaho.platform.api.engine.IParameterProvider parameterProvider, org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory)

Method Summary

Modifier and Type	Method	Description
void	actionComplete(org.pentaho.platform.api.engine.IRuntimeContext completedRuntime)
void	dispose()
String	getActionPath()
String	getInstanceId()
List	getMessages()
org.pentaho.platform.api.engine.IOutputHandler	getOutputHandler()
HashMap	getParameterProviders()
org.pentaho.platform.api.engine.IRuntimeContext	getRuntime(String requestHandle)
org.pentaho.platform.api.engine.IRuntimeContext	handleActionAsyncRequest()
org.pentaho.platform.api.engine.IRuntimeContext	handleActionRequest(int timeout, int timeoutType)
void	setActionPath(String actionPath)
void	setCreateFeedbackParameterCallback(org.pentaho.platform.api.engine.ICreateFeedbackParameterCallback createFeedbackParameterCallback)
void	setForcePrompt(boolean forcePrompt)
void	setInstanceEnds(boolean instanceEnds)
void	setInstanceId(String instanceId)
void	setOutputHandler(org.pentaho.platform.api.engine.IOutputHandler outputHandler)
void	setParameterProvider(String name, org.pentaho.platform.api.engine.IParameterProvider parameterProvider)
void	setParameterXsl(String xsl)
void	setProcessId(String processId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ON_TIMEOUT_CANCEL

public static final int ON_TIMEOUT_CANCEL

See Also:

Constant Field Values

ON_TIMEOUT_RETURN

public static final int ON_TIMEOUT_RETURN

See Also:

Constant Field Values

urlFactory

protected org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory

processId

protected String processId

session

protected org.pentaho.platform.api.engine.IPentahoSession session

instanceEnds

protected boolean instanceEnds

forcePrompt

protected boolean forcePrompt

parameterXsl

protected String parameterXsl

runtime

protected org.pentaho.platform.api.engine.IRuntimeContext runtime

createFeedbackParameterCallback

protected org.pentaho.platform.api.engine.ICreateFeedbackParameterCallback createFeedbackParameterCallback

Constructor Detail

BaseRequestHandler

public BaseRequestHandler(org.pentaho.platform.api.engine.IPentahoSession session,
                          String instanceId,
                          org.pentaho.platform.api.engine.IOutputHandler outputHandler,
                          org.pentaho.platform.api.engine.IParameterProvider parameterProvider,
                          org.pentaho.platform.api.engine.IPentahoUrlFactory urlFactory)

Method Detail

getMessages

public List getMessages()

Specified by:

getMessages in interface org.pentaho.platform.api.engine.IActionRequestHandler

setInstanceEnds

public void setInstanceEnds(boolean instanceEnds)

setParameterProvider

public void setParameterProvider(String name,
                                 org.pentaho.platform.api.engine.IParameterProvider parameterProvider)

getParameterProviders

public HashMap getParameterProviders()

setOutputHandler

public void setOutputHandler(org.pentaho.platform.api.engine.IOutputHandler outputHandler)

setProcessId

public void setProcessId(String processId)

setInstanceId

public void setInstanceId(String instanceId)

getInstanceId

public String getInstanceId()

handleActionRequest

public org.pentaho.platform.api.engine.IRuntimeContext handleActionRequest(int timeout,
                                                                           int timeoutType)

Specified by:

handleActionRequest in interface org.pentaho.platform.api.engine.IActionRequestHandler

dispose

public void dispose()

handleActionAsyncRequest

public org.pentaho.platform.api.engine.IRuntimeContext handleActionAsyncRequest()

Specified by:

handleActionAsyncRequest in interface org.pentaho.platform.api.engine.IActionRequestHandler

getRuntime

public org.pentaho.platform.api.engine.IRuntimeContext getRuntime(String requestHandle)

Specified by:

getRuntime in interface org.pentaho.platform.api.engine.IActionRequestHandler

actionComplete

public void actionComplete(org.pentaho.platform.api.engine.IRuntimeContext completedRuntime)

Specified by:

actionComplete in interface org.pentaho.platform.api.engine.IActionCompleteListener

getOutputHandler

public org.pentaho.platform.api.engine.IOutputHandler getOutputHandler()

setForcePrompt

public void setForcePrompt(boolean forcePrompt)

Specified by:

setForcePrompt in interface org.pentaho.platform.api.engine.IActionRequestHandler

setParameterXsl

public void setParameterXsl(String xsl)

getActionPath

public String getActionPath()

setActionPath

public void setActionPath(String actionPath)

setCreateFeedbackParameterCallback

public void setCreateFeedbackParameterCallback(org.pentaho.platform.api.engine.ICreateFeedbackParameterCallback createFeedbackParameterCallback)

Specified by:

setCreateFeedbackParameterCallback in interface org.pentaho.platform.api.engine.IActionRequestHandler