com.sssw.cm.task.api
Interface EbiTask

All Superinterfaces:

EbiElement, EbiTask, Serializable

All Known Subinterfaces:

EbiDocExpireTask, EbiDocJanitorTask, EbiDocPublishTask, EbiSynchTask

public interface EbiTask

extends EbiTask

The task superinterface that is specific to the Content Management System.

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

TASK_OBJECT_ID

Method Summary

EbiQuery	getScope() Gets the query to run against CM to define the scope of the operation
String	getSourceRepositoryName() Gets the source CM repository name
boolean	mustUseAnd() Tells whether to logically AND or OR any supplied conditions with the scope query (if supplied).
void	setScope(EbiQuery query) Sets the query to run against CM to extract the data
void	setSourceRepositoryName(String srcRepName) Sets the source CM repository name
void	useAnd(boolean useAnd) Specifies whether to logically AND or OR any supplied conditions with the scope query (if supplied).

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

getScope

public EbiQuery getScope()

Gets the query to run against CM to define the scope of the operation

Returns:

the scope (query)

getSourceRepositoryName

public String getSourceRepositoryName()

Gets the source CM repository name

Returns:

the source CM repository name

mustUseAnd

public boolean mustUseAnd()

Tells whether to logically AND or OR any supplied conditions with the scope query (if supplied). E.g. "publish all documents that are ready to be published AND that belong to the MovieReview doctype".

Returns:

true if AND is to be used, false if OR

setScope

public void setScope(EbiQuery query)

Sets the query to run against CM to extract the data

Parameters:

query - the query (scope)

setSourceRepositoryName

public void setSourceRepositoryName(String srcRepName)

Sets the source CM repository name

Parameters:

srcRepName - the source repository name

useAnd

public void useAnd(boolean useAnd)

Specifies whether to logically AND or OR any supplied conditions with the scope query (if supplied). E.g. "publish all documents that are ready to be published AND that belong to the MovieReview doctype".

Parameters:

useAnd - if true, use AND, otherwise OR