com.infoengine.SAK
Interface CheckpointProcessor

All Known Implementing Classes:

BasicCheckpointProcessor

public interface CheckpointProcessor

Method Summary

Task	recoverState(String uniqueIdentifier) Recovers the saved state of a task.
void	removeState(String uniqueIdentifier) Removes all state information that might have been saved for a task.
void	saveState(String uniqueIdentifier, Task task) Saves the state of a task.

Method Detail

saveState

public void saveState(String uniqueIdentifier,
                      Task task)
               throws IEException

Saves the state of a task.

Parameters:

uniqueIdentifier - The unique identifier assigned to the task instance whose state is being saved.

task - The task instance.

Throws:

IEException - if the state was not saved successfully.

recoverState

public Task recoverState(String uniqueIdentifier)
                  throws IEException

Recovers the saved state of a task.

Parameters:

uniqueIdentifier - The unique identifier assigned to the task instance whose state is being recovered.

Returns:

A Task object containing the recovered VDB and context collections.

Throws:

IEException - if the state was not recovered successfully.

removeState

public void removeState(String uniqueIdentifier)
                 throws IEException

Removes all state information that might have been saved for a task. Normally, this method will be called only when a task is complete.

Parameters:

uniqueIdentifier - The unique identifier assigned to the task instance whose saved state is being removed.

Throws:

IEException - if the state was not removed successfully.