Package org.imixs.workflow.engine.adminp
Interface JobHandler
-
- All Known Implementing Classes:
JobHandlerRebuildIndex
,JobHandlerRenameUser
,JobHandlerUpgradeWorkitems
public interface JobHandler
-
-
Field Summary
Fields Modifier and Type Field Description static String
ISCOMPLETED
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ItemCollection
run(ItemCollection job)
Called by the AdminPService.
-
-
-
Field Detail
-
ISCOMPLETED
static final String ISCOMPLETED
- See Also:
- Constant Field Values
-
-
Method Detail
-
run
ItemCollection run(ItemCollection job) throws AdminPException
Called by the AdminPService. The JobHandler returns the job description with pre defined fields to signal the status. The AdminPService will terminate the job in cases the job is complete. Otherwise the AdminPServcie will wait for the next timeout.Fields:
- type - fixed to value 'adminp'
- job - the job type/name, defined by handler
- $WorkflowStatus - status controlled by AdminP Service
- $WorkflowSummary - summary of job description
- isCompleted - boolean indicates if job is completed - controlled by job handler
- Parameters:
job
- description- Returns:
- updated job description
- Throws:
AdminPException
-
-