org.oddjob.jobs.tasks

Class TaskRequest

java.lang.Object

org.oddjob.framework.extend.BaseComponent

org.oddjob.framework.extend.BasePrimary

org.oddjob.framework.extend.SimpleJob

org.oddjob.framework.extend.SerializableJob

org.oddjob.jobs.tasks.TaskRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, ArooaContextAware, ArooaSessionAware, Forceable, PropertyChangeNotifier, Iconic, LogEnabled, Resettable, Stateful, Stoppable

public class TaskRequest
extends SerializableJob
implements Stoppable

Description

This job requests a task be performed with optional properties.

Example

Greeting people by name. Three Task Requests call the TaskExecutionService with different names.

<oddjob>
    <job>
        <sequential>
            <jobs>
                <task-service id="hello-service">
                    <requests>
                        <input-text prompt="Name" property="some.name"/>
                    </requests>
                    <job>
                        <echo>Hello ${some.name}.</echo>
                    </job>
                </task-service>
                <task-request taskExecutor="${hello-service}">
                    <properties>
                        <properties>
                            <values>
                                <value key="some.name" value="Rod"/>
                            </values>
                        </properties>
                    </properties>
                </task-request>
                <task-request taskExecutor="${hello-service}">
                    <properties>
                        <properties>
                            <values>
                                <value key="some.name" value="Jane"/>
                            </values>
                        </properties>
                    </properties>
                </task-request>
                <task-request taskExecutor="${hello-service}">
                    <properties>
                        <properties>
                            <values>
                                <value key="some.name" value="Freddy"/>
                            </values>
                        </properties>
                    </properties>
                </task-request>
            </jobs>
        </sequential>
    </job>
</oddjob>

See Also:

Serialized Form

Author:

Rob

Field Summary

Fields inherited from class org.oddjob.framework.extend.SimpleJob

stop

Constructor Summary

Constructors

Constructor and Description
TaskRequest()

Method Summary

Modifier and Type	Method and Description
protected int	execute() Execute this job.
java.util.Properties	getProperties()
java.lang.Object	getResponse()
TaskExecutor	getTaskExecutor() Get the job.
boolean	isJoin()
protected void	onStop() Allow sub classes to do something on stop.
void	setJoin(boolean join)
void	setProperties(java.util.Properties properties)
void	setTaskExecutor(TaskExecutor node) Set the stop node directly.

Methods inherited from class org.oddjob.framework.extend.SimpleJob

fireDestroyedState, force, getStateChanger, hardReset, iconHelper, isStop, onDestroy, onReset, run, sleep, softReset, stateHandler, stop

Methods inherited from class org.oddjob.framework.extend.BasePrimary

configure, getName, logger, logger, loggerName, save, setName, toString

Methods inherited from class org.oddjob.framework.extend.BaseComponent

addIconListener, addPropertyChangeListener, addStateListener, configure, destroy, firePropertyChange, getArooaSession, iconForId, initialise, lastStateEvent, onConfigured, onInitialised, removeIconListener, removePropertyChangeListener, removeStateListener, save, setArooaContext, setArooaSession

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.oddjob.Stoppable

stop

Methods inherited from interface org.oddjob.Stateful

addStateListener, lastStateEvent, removeStateListener

Constructor Detail

TaskRequest

public TaskRequest()

Method Detail

setTaskExecutor

public void setTaskExecutor(TaskExecutor node)

Set the stop node directly.

Parameters:

node - The job.

getTaskExecutor

public TaskExecutor getTaskExecutor()

Get the job.

Returns:

The node.

execute

protected int execute()
               throws java.lang.Exception

Description copied from class: SimpleJob

Execute this job.

Specified by:

execute in class SimpleJob

Returns:

0 if the job is complete, anything else otherwise.

Throws:

java.lang.Exception - If the unexpected occurs.

onStop

protected void onStop()
               throws FailedToStopException

Description copied from class: SimpleJob

Allow sub classes to do something on stop.

Overrides:

onStop in class SimpleJob

Throws:

FailedToStopException

isJoin

public boolean isJoin()

setJoin

public void setJoin(boolean join)

getProperties

public java.util.Properties getProperties()

setProperties

public void setProperties(java.util.Properties properties)

getResponse

public java.lang.Object getResponse()