com.sssw.cm.task.api
Interface EbiDocExpireTask

All Superinterfaces:

EbiElement, EbiTask, EbiTask, Serializable

public interface EbiDocExpireTask

extends EbiTask

This interface defines a Document Expirer Task.

Fields inherited from interface com.sssw.fw.task.api.EbiTask

TASK_OBJECT_ID

Method Summary

void	doAllReady(boolean doit) Tells the task to process all Documents that are ready to be expired, based on the values of their EXPIRATIONDATE property.
void	forceExpire(boolean force) Tells the task to force expiration by overriding the Documents' EXPIRATIONDATE values.
boolean	isForcedExpiration() Tells whether the task is to force expiration by overriding the Documents' EXPIRATIONDATE values.
boolean	mustDoAllReady() Tells whether or not the task is to process all Documents that are ready to be expired, based on the values of their EXPIRATIONDATE property.

Methods implemented from interface com.sssw.cm.task.api.EbiTask

getScope, getSourceRepositoryName, mustUseAnd, setScope, setSourceRepositoryName, useAnd

Methods implemented from interface com.sssw.fw.task.api.EbiTask

doTask, enable, execute, fromXML, getContext, getDescription, getLaunchTime, getName, getSinceLast, getTaskType, getTimesRan, getUserObject, isEnabled, isOfType, isStarted, setContext, setDescription, setLaunchTime, setName, setSinceLast, setTaskType, setTimesRan, setUserObject, start, stop

Methods implemented from interface com.sssw.fw.api.EbiElement

getType

Method Detail

doAllReady

public void doAllReady(boolean doit)

Tells the task to process all Documents that are ready to be expired, based on the values of their EXPIRATIONDATE property.

Parameters:

doit - if true, process all the ready Documents

forceExpire

public void forceExpire(boolean force)

Tells the task to force expiration by overriding the Documents' EXPIRATIONDATE values.

Parameters:

force - if true, force expiration

mustDoAllReady

public boolean mustDoAllReady()

Tells whether or not the task is to process all Documents that are ready to be expired, based on the values of their EXPIRATIONDATE property.

Returns:

true if the task is to process all the ready Documents

isForcedExpiration

public boolean isForcedExpiration()

Tells whether the task is to force expiration by overriding the Documents' EXPIRATIONDATE values.

Returns:

true if the task is to force expiration