com.sapportals.wcm.service.taskqueue

Interface ITask

public interface ITask

Entry of a task queue. This interface discribes a task to be executed by an application or service.

A task has the following properties: Name Required ID Yes Namespace Yes CreatedBy Yes CreationDate Yes State Yes LastModified Yes Priority Yes Value by name No Description No

A task object is created by the writer factory methods. This methods provide validation of the properties settings.

Copyright 2004 SAP AG

Field Summary

static int	MAX_PRIORITY Default value to set the task priority to a maximum (100).
static int	MIN_PRIORITY Default value to set the task priority to a minimum (0).
static int	NORM_PRIORITY Default task priority (50).

Method Summary

String	getCreatedBy() Returns the user who created this entry.
Date	getCreationDate() Returns the date this entry was created.
String	getDescription() Returns a short description
String	getID() The tasks unique id will be created by the underlying persistence layer.
Date	getLastModified() The last time the task state was changed.
String	getNamespace() Returns the namespace this entry is assigned to.
int	getPriority() Gets the priority of this task.
Properties	getProperties() Returns the complete property bundle of this task queue
TaskState	getState() The current state of this task.
String	getValue(String name) Returns the property value for the specified key.

Field Detail

MIN_PRIORITY

static final int MIN_PRIORITY

Default value to set the task priority to a minimum (0).

See Also:

Constant Field Values

NORM_PRIORITY

static final int NORM_PRIORITY

Default task priority (50).

See Also:

Constant Field Values

MAX_PRIORITY

static final int MAX_PRIORITY

Default value to set the task priority to a maximum (100).

See Also:

Constant Field Values

Method Detail

getID

String getID()

The tasks unique id will be created by the underlying persistence layer.

Returns:

The tasks unique id.

getNamespace

String getNamespace()

Returns the namespace this entry is assigned to.

Returns:

The namespace

getCreatedBy

String getCreatedBy()

Returns the user who created this entry.

Returns:

The createdBy value

getCreationDate

Date getCreationDate()

Returns the date this entry was created.

Returns:

The creationDate value

getState

TaskState getState()

The current state of this task.

Returns:

The current state

getLastModified

Date getLastModified()

The last time the task state was changed.

Returns:

The last time the task state was changed.

getPriority

int getPriority()

Gets the priority of this task. Since the task queue service provides a priority queue, the returned value affects the FIFO order of the queue. Default settings are MIN_PRIORITY, NORM_PRIORITY and MAX_PRIORITY.

Returns:

The priority of this task.

getValue

String getValue(String name)

Returns the property value for the specified key.

Parameters:

name - a unique name

Returns:

The property value

getProperties

Properties getProperties()

Returns the complete property bundle of this task queue

Returns:

properties

getDescription

String getDescription()

Returns a short description

Returns:

The description string

Access Rights

This class can be accessed from:

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