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). |
MIN_PRIORITY
public static final int MIN_PRIORITY
- Default value to set the task priority to a minimum (0).
- See Also:
- Constant Field Values
NORM_PRIORITY
public static final int NORM_PRIORITY
- Default task priority (50).
- See Also:
- Constant Field Values
MAX_PRIORITY
public static final int MAX_PRIORITY
- Default value to set the task priority to a maximum (100).
- See Also:
- Constant Field Values
getID
public String getID()
- The tasks unique id will be created by the underlying persistence layer.
- Returns:
- The tasks unique id.
getNamespace
public String getNamespace()
- Returns the namespace this entry is assigned to.
- Returns:
- The namespace
getCreatedBy
public String getCreatedBy()
- Returns the user who created this entry.
- Returns:
- The createdBy value
getCreationDate
public 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 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 String getValue(String name)
- Returns the property value for the specified key.
- Parameters:
name - a unique name
- Returns:
- The property value
getProperties
public Properties getProperties()
- Returns the complete property bundle of this task queue
- Returns:
- properties
getDescription
public String getDescription()
- Returns a short description
- Returns:
- The description string
Copyright 2006 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. 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.