de.esoco.process

Interface ProcessScheduler

public interface ProcessScheduler

An interface for classes that perform the periodic scheduling of processes.

Method Summary

Modifier and Type	Method and Description
void	addScheduleProcess(Entity rProcessDescription) Adds the schedule process defined by the Entity to the management of the scheduler.
Entity	getScheduleProcessUser() Must be implemented by subclasses to provide access to the entity to be used as the schedule process user.
boolean	isProcessSchedulingEnabled() Returns TRUE if the process scheduler is enabled and FALSE otherwise.
void	notifyScheduleProcessChanged() Notify about a change or edit of a schedule process.
void	notifyScheduleProcessFinished(Process rProcess) Notify about a schedule process that has finished execution.
void	notifyScheduleProcessStarting(Process rProcess) Notify about a schedule process that is about to start execution.
void	removeScheduleProcess(java.lang.String sEntityId) Removes the process from the management of the scheduler.
void	resumeProcess(java.lang.Class<? extends ProcessDefinition> rProcessDefinitionClass) Resumes the execution of a process if it is currently suspended.
void	resumeScheduleProcess(java.lang.String sEntityId) Resumes the process defined by the Entity-Id.
void	runScheduleProcessNow(java.lang.String sEntityId) Runs the process defined by the Entity immediately.
void	suspendScheduleProcess(java.lang.String sEntityId) Stops the schedule process and suspends the execution of this process until resumeScheduleProcess is called.

Method Detail

addScheduleProcess

void addScheduleProcess(Entity rProcessDescription)

Adds the schedule process defined by the Entity to the management of the scheduler.

Parameters:

rProcessDescription - The Entity that defines the schedule process.

getScheduleProcessUser

Entity getScheduleProcessUser()

Must be implemented by subclasses to provide access to the entity to be used as the schedule process user.

Returns:

An entity instance that will be used as the user of schedule processes

isProcessSchedulingEnabled

boolean isProcessSchedulingEnabled()

Returns TRUE if the process scheduler is enabled and FALSE otherwise.

Returns:

TRUE if the process scheduler is enabled and FALSE otherwise.

notifyScheduleProcessChanged

void notifyScheduleProcessChanged()

Notify about a change or edit of a schedule process.

notifyScheduleProcessFinished

void notifyScheduleProcessFinished(Process rProcess)

Notify about a schedule process that has finished execution.

Parameters:

rProcess - The schedule process that has finished

notifyScheduleProcessStarting

void notifyScheduleProcessStarting(Process rProcess)

Notify about a schedule process that is about to start execution.

Parameters:

rProcess - The schedule process that is starting

removeScheduleProcess

void removeScheduleProcess(java.lang.String sEntityId)

Removes the process from the management of the scheduler.

Parameters:

sEntityId - ProcessDescription the Entity that defines the schedule process

resumeProcess

void resumeProcess(java.lang.Class<? extends ProcessDefinition> rProcessDefinitionClass)

Resumes the execution of a process if it is currently suspended. This is useful if a schedule process should be run immediately although it is in an idle state waiting the period time for the next execution.

Parameters:

rProcessDefinitionClass - The process description of the schedule process

resumeScheduleProcess

void resumeScheduleProcess(java.lang.String sEntityId)

Resumes the process defined by the Entity-Id.

Parameters:

sEntityId - The Id of the Entity that defines the process.

runScheduleProcessNow

void runScheduleProcessNow(java.lang.String sEntityId)

Runs the process defined by the Entity immediately.

Parameters:

sEntityId - rProcessDescription The Entity that defines the schedule process.

suspendScheduleProcess

void suspendScheduleProcess(java.lang.String sEntityId)

Stops the schedule process and suspends the execution of this process until resumeScheduleProcess is called.

Parameters:

sEntityId - The Id of the Entity that defines the process.