net.officefloor.frame.impl.execute.duty

Class DutyJob<W extends Work,I,A extends Enum<A>>

java.lang.Object

net.officefloor.frame.impl.execute.linkedlistset.AbstractLinkedListSetEntry<JobNode,JobSequence>

net.officefloor.frame.impl.execute.job.AbstractJobContainer<W,AdministratorMetaData<I,A>>

net.officefloor.frame.impl.execute.duty.DutyJob<W,I,A>

All Implemented Interfaces:

JobExecuteContext, ContainerContext, JobNode, LinkedListSetEntry<JobNode,JobSequence>, Job

public class DutyJob<W extends Work,I,A extends Enum<A>>
extends AbstractJobContainer<W,AdministratorMetaData<I,A>>

Duty implementation for a Job.

Author:

Daniel Sagenschneider

Field Summary

Fields inherited from class net.officefloor.frame.impl.execute.job.AbstractJobContainer

ASYNCHRONOUS_FLOW_TEAM_IDENTIFIER, flow, nodeMetaData, workContainer

Constructor Summary

Constructors

Constructor and Description
DutyJob(JobSequence flow, WorkContainer<W> workContainer, AdministratorMetaData<I,A> adminMetaData, TaskDutyAssociation<A> taskDutyAssociation, JobNode parallelOwner, TaskMetaData<?,?,?> administeringTaskMetaData) Initiate.

Method Summary

Modifier and Type	Method and Description
protected Object	executeJob(JobExecuteContext context, JobContext jobContext, JobNodeActivateSet activateSet) Overridden by specific container to execute the Job.
protected void	loadJobName(StringBuilder message) Loads the Job name to the message.

Methods inherited from class net.officefloor.frame.impl.execute.job.AbstractJobContainer

activateJob, addGovernanceActivity, addSetupTask, cancelJob, clearNodes, doFlow, doJob, flagJobToWait, getEscalationProcedure, getJobSequence, getLinkedListSetOwner, getNextJob, getNextNode, getParallelNode, getParallelOwner, getProcessIdentifier, isJobNodeComplete, joinFlow, setJobComplete, setNextJob, setNextNode, setParallelNode, setParallelOwner

Methods inherited from class net.officefloor.frame.impl.execute.linkedlistset.AbstractLinkedListSetEntry

getNext, getPrev, setNext, setPrev

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.frame.internal.structure.LinkedListSetEntry

getNext, getPrev, setNext, setPrev

Constructor Detail

DutyJob

public DutyJob(JobSequence flow,
               WorkContainer<W> workContainer,
               AdministratorMetaData<I,A> adminMetaData,
               TaskDutyAssociation<A> taskDutyAssociation,
               JobNode parallelOwner,
               TaskMetaData<?,?,?> administeringTaskMetaData)

Initiate.

Parameters:

flow - JobSequence.

workContainer - WorkContainer.

adminMetaData - AdministratorMetaData.

taskDutyAssociation - TaskDutyAssociation.

parallelOwner - Parallel owning JobNode.

administeringTaskMetaData - TaskMetaData of the Task being administered.

Method Detail

loadJobName

protected void loadJobName(StringBuilder message)

Description copied from class: AbstractJobContainer

Loads the Job name to the message.

Specified by:

loadJobName in class AbstractJobContainer<W extends Work,AdministratorMetaData<I,A extends Enum<A>>>

Parameters:

message - Message to receive the Job name.

executeJob

protected Object executeJob(JobExecuteContext context,
                            JobContext jobContext,
                            JobNodeActivateSet activateSet)
                     throws Throwable

Description copied from class: AbstractJobContainer

Overridden by specific container to execute the Job.

Specified by:

executeJob in class AbstractJobContainer<W extends Work,AdministratorMetaData<I,A extends Enum<A>>>

Parameters:

context - JobExecuteContext.

jobContext - JobContext.

activateSet - JobNodeActivateSet.

Returns:

Parameter for the next Job.

Throws:

Throwable - If failure in executing the Job.