public interface ITaskQueueWriter
Modifier and Type | Method and Description |
---|---|
ITask |
add(ITask task)
Adds an entry to the end of the queue.
|
ITask |
createTask()
Factory method to create task objects.
|
ITask |
createTask(Properties properties)
Factory method to create task objects.
|
ITask |
createTask(Properties properties,
String description)
Factory method to create task objects.
|
ITask |
createTask(Properties properties,
String description,
int priority)
Factory method to create task objects.
|
String |
getNamespace()
Returns the namespace of this writer.
|
String |
getUser()
Returns the user of this writer.
|
void |
setState(ITask task,
TaskState state)
Sets the task's state to a new
state . |
ITask add(ITask task) throws WcmException
The task' state is set NEW
during this operation.
According to the persistence layer a correct task id will be created.
task
- The task to addWcmException
- raised in failure situationvoid setState(ITask task, TaskState state) throws WcmException
state
. The task must belong to
the writer's namespace. The new state must be a legal transition of the old
state (see ITask.getState()
) for details.state
- The state to set.task
- The task to set the state.WcmException
- Exception raised in failure situationITask createTask() throws WcmException
normal
.WcmException
- Exception raised in failure situationITask createTask(Properties properties) throws WcmException
properties
- Adds a set of properties to the task.WcmException
- Exception raised in failure situationcreateTask()
ITask createTask(Properties properties, String description) throws WcmException
description
to the task. The description string may be null
.properties
- Adds a set of properties to the task.description
- Adds a short descritption description
to
the task.WcmException
- Exception raised in failure situationcreateTask(Properties)
ITask createTask(Properties properties, String description, int priority) throws WcmException
priority
value to the task. The priory value must lie between 0
and 100
.properties
- Adds a set of properties to the task.description
- Adds a short descritption description
to
the task.priority
- The priority value that affect the processing order of
tasks.WcmException
- Exception raised in failure situationcreateTask(Properties,String)
String getUser()
String getNamespace()
Access Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice