net.sf.basedb.core
Class PluginRequest.RequestImpl

java.lang.Object
  net.sf.basedb.core.PluginRequest.RequestImpl

All Implemented Interfaces:

Request

Enclosing class:

PluginRequest<P extends Plugin>

 class PluginRequest.RequestImpl
extends Object
implements Request

An implementation of the Request interface that is passed to the plugin.

Field Summary

private boolean

allowImmediateExecution

Fields inherited from interface net.sf.basedb.core.plugin.Request

COMMAND_CONFIGURE_JOB, COMMAND_CONFIGURE_PLUGIN, COMMAND_EXECUTE

Constructor Summary

PluginRequest.RequestImpl(boolean allowImmediateExecution)

Method Summary

String	getCommand() The command the plugin should execute.
Object	getParameterValue(String name) Get the value for the parameter with the specified name.
List<?>	getParameterValues(String name) Get the values for the parameter with the specified name.
boolean	isAllowedImmediateExecution() If this plugin has been allowed immediate execution or not.

Methods inherited from class java.lang.Object

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

Field Detail

allowImmediateExecution

private final boolean allowImmediateExecution

Constructor Detail

PluginRequest.RequestImpl

PluginRequest.RequestImpl(boolean allowImmediateExecution)

Method Detail

getCommand

public String getCommand()

Description copied from interface: Request

The command the plugin should execute. This value is one of the predefined constants above, or some other value that is supported by the specific plugin.

Specified by:

getCommand in interface Request

getParameterValue

public Object getParameterValue(String name)

Description copied from interface: Request

Get the value for the parameter with the specified name.

Specified by:

getParameterValue in interface Request

Parameters:

name - The name of the parameter

Returns:

An object with the value, or null if no value is given

getParameterValues

public List<?> getParameterValues(String name)

Description copied from interface: Request

Get the values for the parameter with the specified name.

Specified by:

getParameterValues in interface Request

Parameters:

name - The name of the parameter

Returns:

An object with the value, or null if no value is given

isAllowedImmediateExecution

public boolean isAllowedImmediateExecution()

Description copied from interface: Request

If this plugin has been allowed immediate execution or not. If this is true the plugin may end a job configuration sequence with Response.setExecuteImmediately(String, Job.ExecutionTime, boolean) or, if the plugin is a ImmediateDownloadExporter, Response.setDownloadImmediately(String, Job.ExecutionTime, boolean).

Specified by:

isAllowedImmediateExecution in interface Request

Returns:

TRUE if it is allowed, FALSE otherwise