com.sssw.cm.task.api
Interface EbiDocJanitorTask

All Superinterfaces:

EbiElement, EbiTask, EbiTask, Serializable

public interface EbiDocJanitorTask

extends EbiTask

The Document Remove Task.

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

TASK_OBJECT_ID

Method Summary

boolean	getRemoveAllExpired() Tells whether the task is to remove all Documents that expired based on their EXPIRATIONDATE property value.
boolean	getRemoveAllUnpublished() Tells whether the task is to remove all Documents whose PUBLISHSTATUS is "unpublished"
boolean	getUnlinkChildren() Tells whether the task is to unlink any Child Documents of the ones being deleted.
boolean	getUnlinkLinkChildren() Tells whether the task is to remove any Links where the Documents being deleted act as Link-Children
boolean	getUnlinkLinkParents() Tells whether the task is to remove any Links where the Documents being deleted act as Link-Parents.
boolean	getUnlockIfNecessary() Tells whether the task is to remove any locks on Documents as it's removing them
void	setRemoveAllExpired(boolean doit) Tells the task whether to remove all Documents that expired based on their EXPIRATIONDATE property value.
void	setRemoveAllUnpublished(boolean doit) Tells the task whether to remove all Documents whose PUBLISHSTATUS is "unpublished".
void	setUnlinkChildren(boolean unlink) Tells the task whether to unlink any Child Documents of the ones being deleted.
void	setUnlinkLinkChildren(boolean unlink) Tells the task whether to remove any Links where the Documents being deleted act as Link-Children.
void	setUnlinkLinkParents(boolean unlink) Tells the task whether to remove any Links where the Documents being deleted act as Link-Parents.
void	setUnlockIfNecessary(boolean unlock) Tells the task whether to remove any locks on Documents as it's removing them.

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

setUnlockIfNecessary

public void setUnlockIfNecessary(boolean unlock)

Tells the task whether to remove any locks on Documents as it's removing them.

Parameters:

unlock - if true, remove any checkout locks

setUnlinkLinkParents

public void setUnlinkLinkParents(boolean unlink)

Tells the task whether to remove any Links where the Documents being deleted act as Link-Parents.

Parameters:

unlink - if true, remove any Links where the Documents being deleted act as Link-Parents

setUnlinkLinkChildren

public void setUnlinkLinkChildren(boolean unlink)

Tells the task whether to remove any Links where the Documents being deleted act as Link-Children.

Parameters:

unlink - if true, remove any Links where the Documents being deleted act as Link-Children

setUnlinkChildren

public void setUnlinkChildren(boolean unlink)

Tells the task whether to unlink any Child Documents of the ones being deleted.

Parameters:

unlink - if true, unlink any Child Documents of the ones being deleted

setRemoveAllExpired

public void setRemoveAllExpired(boolean doit)

Tells the task whether to remove all Documents that expired based on their EXPIRATIONDATE property value.

Parameters:

doit - if true, remove all Documents that expired based on their EXPIRATIONDATE property value

setRemoveAllUnpublished

public void setRemoveAllUnpublished(boolean doit)

Tells the task whether to remove all Documents whose PUBLISHSTATUS is "unpublished".

Parameters:

doit - if true, remove all Documents whose PUBLISHSTATUS is "unpublished"

getUnlockIfNecessary

public boolean getUnlockIfNecessary()

Tells whether the task is to remove any locks on Documents as it's removing them

Returns:

true if the task is to remove any locks on Documents as it's removing them

getUnlinkLinkParents

public boolean getUnlinkLinkParents()

Tells whether the task is to remove any Links where the Documents being deleted act as Link-Parents.

Returns:

true if the task is to remove any Links where the Documents being deleted act as Link-Parents

getUnlinkLinkChildren

public boolean getUnlinkLinkChildren()

Tells whether the task is to remove any Links where the Documents being deleted act as Link-Children

Returns:

true if the task is to remove any Links where the Documents being deleted act as Link-Children

getUnlinkChildren

public boolean getUnlinkChildren()

Tells whether the task is to unlink any Child Documents of the ones being deleted.

Returns:

true if the task is to unlink any Child Documents of the ones being deleted

getRemoveAllExpired

public boolean getRemoveAllExpired()

Tells whether the task is to remove all Documents that expired based on their EXPIRATIONDATE property value.

Returns:

true if the task is to remove all Documents that expired based on their EXPIRATIONDATE property value

getRemoveAllUnpublished

public boolean getRemoveAllUnpublished()

Tells whether the task is to remove all Documents whose PUBLISHSTATUS is "unpublished"

Returns:

true if the task is to remove all Documents whose PUBLISHSTATUS is "unpublished"