Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

com.sapportals.wcm.service.taskqueue
Interface ITask

[contained in: com.sap.netweaver.bc.sf.service.par - bc.sf.service.taskqueue_api.jar]
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
 java.lang.String getCreatedBy()
          Returns the user who created this entry.
 java.util.Date getCreationDate()
          Returns the date this entry was created.
 java.lang.String getDescription()
          Returns a short description
 java.lang.String getID()
          The tasks unique id will be created by the underlying persistence layer.
 java.util.Date getLastModified()
          The last time the task state was changed.
 java.lang.String getNamespace()
          Returns the namespace this entry is assigned to.
 int getPriority()
          Gets the priority of this task.
 java.util.Properties getProperties()
          Returns the complete property bundle of this task queue
 TaskState getState()
          The current state of this task.
 java.lang.String getValue(java.lang.String name)
          Returns the property value for the specified key.
 

Field Detail

MIN_PRIORITY

public static final int MIN_PRIORITY
Default value to set the task priority to a minimum (0).

NORM_PRIORITY

public static final int NORM_PRIORITY
Default task priority (50).

MAX_PRIORITY

public static final int MAX_PRIORITY
Default value to set the task priority to a maximum (100).
Method Detail

getID

public java.lang.String getID()
The tasks unique id will be created by the underlying persistence layer.
Returns:
The tasks unique id.

getNamespace

public java.lang.String getNamespace()
Returns the namespace this entry is assigned to.
Returns:
The namespace

getCreatedBy

public java.lang.String getCreatedBy()
Returns the user who created this entry.
Returns:
The createdBy value

getCreationDate

public java.util.Date getCreationDate()
Returns the date this entry was created.
Returns:
The creationDate value

getState

public TaskState getState()
The current state of this task.
Returns:
The current state

getLastModified

public java.util.Date getLastModified()
The last time the task state was changed.
Returns:
The last time the task state was changed.

getPriority

public 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

public java.lang.String getValue(java.lang.String name)
Returns the property value for the specified key.
Parameters:
name - a unique name
Returns:
The property value

getProperties

public java.util.Properties getProperties()
Returns the complete property bundle of this task queue
Returns:
properties

getDescription

public java.lang.String getDescription()
Returns a short description
Returns:
The description string
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.