com.sssw.cm.task.api
Interface EbiDocPublishTask

All Superinterfaces:

EbiElement, EbiTask, EbiTask, Serializable

public interface EbiDocPublishTask

extends EbiTask

The Document Publish Task.

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

TASK_OBJECT_ID

Method Summary

void	doAllNotYetPublished(boolean doit) Tells the task to publish all the Documents whose PUBLISHSTATUS is "not yet published".
void	doAllReady(boolean doit) Tells the task whether to publish all the Documents that are ready to be published, based on the value of their PUBLISHDATE property.
void	doAllUnpublished(boolean doit) Tells the task to publish all the Documents whose PUBLISHSTATUS is "unpublished" (i.e.
void	forcePublish(boolean force) Tells the task whether to publish Documents regardless of the value of their PUBLISHDATE property (forced publish).
boolean	isForcedPublish() Tells whether the task is to publish Documents regardless of the value of their PUBLISHDATE property (forced publish).
boolean	mustDoAllNotYetPublished() Tells whether the task is to publish all the Documents whose PUBLISHSTATUS is "not yet published".
boolean	mustDoAllReady() Tells whether the task is to publish all the Documents that are ready to be published, based on the value of their PUBLISHDATE property.
boolean	mustDoAllUnpublished() Tells whether the task is to publish all the Documents whose PUBLISHSTATUS is "unpublished" (i.e.

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

doAllNotYetPublished

public void doAllNotYetPublished(boolean doit)

Tells the task to publish all the Documents whose PUBLISHSTATUS is "not yet published".

Parameters:

doit - if true, publish all the Documents whose PUBLISHSTATUS is "not yet published"

doAllUnpublished

public void doAllUnpublished(boolean doit)

Tells the task to publish all the Documents whose PUBLISHSTATUS is "unpublished" (i.e. republish).

Parameters:

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

doAllReady

public void doAllReady(boolean doit)

Tells the task whether to publish all the Documents that are ready to be published, based on the value of their PUBLISHDATE property.

Parameters:

doit - if true, publish all the Documents that are ready to be published, based on the value of their PUBLISHDATE property

forcePublish

public void forcePublish(boolean force)

Tells the task whether to publish Documents regardless of the value of their PUBLISHDATE property (forced publish).

Parameters:

force - if true, publish Documents regardless of the value of their PUBLISHDATE property

mustDoAllNotYetPublished

public boolean mustDoAllNotYetPublished()

Tells whether the task is to publish all the Documents whose PUBLISHSTATUS is "not yet published".

Returns:

true if the task is to publish all the Documents whose PUBLISHSTATUS is "not yet published"

mustDoAllUnpublished

public boolean mustDoAllUnpublished()

Tells whether the task is to publish all the Documents whose PUBLISHSTATUS is "unpublished" (i.e. republish).

Returns:

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

mustDoAllReady

public boolean mustDoAllReady()

Tells whether the task is to publish all the Documents that are ready to be published, based on the value of their PUBLISHDATE property.

Returns:

true if the task is to publish all the Documents that are ready to be published, based on the value of their PUBLISHDATE property

isForcedPublish

public boolean isForcedPublish()

Tells whether the task is to publish Documents regardless of the value of their PUBLISHDATE property (forced publish).

Returns:

true if the task is to publish Documents regardless of the value of their PUBLISHDATE property