[Index]

stop


A job which stops another job.

Normally The stop job will not complete until the job it is stopping is in a not executing state. Therefore if the stop job is attempting to stop a parent job of itself the stop job could block indefinitely. This case is detected and the job enters an Exception state.


Property Summary

job Job to stop
name A name, can be any text.
stop This flag is set by the stop method and should be examined by any Stoppable jobs in their processing loops.

Example Summary

Example 1 Examples elsewhere.

Property Detail

job

Configured ByATTRIBUTE
AccessREAD_WRITE
RequiredYes.

Job to stop

name

Configured ByATTRIBUTE
AccessREAD_WRITE
RequiredNo.

A name, can be any text.

stop

AccessREAD_ONLY
RequiredRead Only.

This flag is set by the stop method and should be examined by any Stoppable jobs in their processing loops.


Examples

Example 1

Examples elsewhere.


(c) R Gordon Ltd 2005 - Present