|
SAP NetWeaver 2004S SPS 10 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.sap.netweaver.bc.uwl.Item
The Item class defines a basic work item or notification or alert or some such construct.
An item in UWL system is identified uniquely by its internalId. This internalId is computed
when the item arrives at UWL system. The producer of the item shouldn't fill this internal id.
For external systems, item should be uniquely identifiable with userId+connectorId+systemId+externalId
combination.
In most of the cases, one item is owned by one user. However in exceptional cases, when several
users should have the same copy of the item, the item should have shared flag set using
setShared() method.
An item is immutable (time invariant) with respect to its shared property, that is as long as item exists in
UWL system, its shared property cannot
be modified. When an item is shared by several users, effects of action on this shared item by any user will
be immediately reflected for all other users. However concept of shared items can not be
used by the Item Providers if Item's locale specific attributes like subject,
description are not the same for all the item's users.
Restrictions on length of attributes:
Attribute,
ItemKey,
IProviderConnector| Field Summary | |
static String |
APP_CONTEXT
|
static String |
ATTACHMENT_COUNT
These constants could be used in the Sorting and Filtering functions. |
static String |
COMPLETED_DATE
Typical dynamic attribute for an item. |
static String |
CONNECTOR_ID
|
static String |
CREATED_DATE
|
static String |
CREATOR_ID
|
static String |
DECISION
Decision about the items approval item |
static String |
DESCRIPTION
Sorting on following fields is not allowed. |
static String |
DUE_DATE
|
static Attachment[] |
EMPTY_ATTACHMENTS
Many of the following private properties could be null. |
static String |
ESCALATED_BY
|
static String |
EXECUTION_URL
|
static String |
EXPIRY_DATE
|
static String |
EXTERNAL_ID
|
static String |
EXTERNAL_TYPE
|
static String |
EXTL_OBJECT_ID
|
static String |
FORWARDED_BY
|
static String |
FORWARDED_DATE
Typical dynamic attribute for an item. |
static String |
FUTURE_DATE
Typical dynamic attribute for an item. |
static String |
INTERNAL_ID
|
static String |
INTERNAL_STATUS_FLAG
|
static String |
IS_ESCALATED
|
static String |
ITEM_TYPE
|
static String |
MEMO_COUNT
|
static String |
PARENT_ITEM_ID
In case of sub process item, indicates the parent itemId |
static String |
PRIORITY
|
static String |
PROCESSOR
The processor who is currently responsible for the item. |
static String |
STATUS
|
static String |
SUBJECT
|
static String |
SUBPROCESS_ID
|
static String |
SUBSTITUTED_FOR
|
static String |
SYSTEM_ID
|
static int |
UNKNOWN_ATTACHMENT_EXISTENCE
It is not known whether there exists any attachment object. |
static int |
UNKNOWN_NUMBER_EXISTING_ATTACHMENT
It is known that attachment(s) exist(s) but it is not clear how many of them are there. |
static String |
USER_ID
|
static int |
ZERO_NUMBER_ATTACHMENT
There exists no attachment at all. |
| Constructor Summary | |
Item(String connectorID,
String systemID,
String externalID,
String userID)
This constructor creates an item with minimum parameters required to construct the item key. |
|
Item(String connectorID,
String systemID,
String externalID,
String userID,
int attachmentCount,
Date createdDate,
String creatorID,
Date dueDate,
String externalObjectID,
String externalType,
String itemType,
PriorityEnum priority,
StatusEnum status,
String subject)
This constructor is intended to create an item in a comprehensive way. |
|
| Method Summary | |
void |
addAttribute(Attribute attr)
Method for adding one attribute to the item |
void |
addAttributes(Map attr)
Method to add custom attributes to the Item object. |
String |
getAppContext()
Application context sort of represents a namespace for an Item. |
int |
getAttachmentCount()
Returns the attachmentCount. |
Attachment[] |
getAttachments()
Returns attachments associated with the work item. |
Attribute |
getAttribute(String attributeName)
Returns one Attribute for the item. |
String[] |
getAttributeNames()
Returns the attribute names. |
Map |
getAttributes()
This method returns the attributes that are specific to this item. |
Object |
getAttributeValue(String attributeName)
Returns the value of the attribute specified. |
Date |
getCompletedDate()
Returns the date when item is completed. |
String |
getConnectorId()
This method returns provider's registered name. |
Date |
getCreatedDate()
Returns the date this item is sent or created at the Provider system. |
String |
getCreatorId()
Returns User or process that created this item. |
String |
getDecision()
For completed items, if item has a decision like approved, or rejected that text is returned. |
String |
getDescription()
Returns the description. |
Date |
getDueDate()
Certain item may contain date when they are supposed to be due. |
String |
getEscalatedBy()
Returns string User-id who escalated the item. |
String |
getExecutionUrl()
Returns the executionURL. |
Date |
getExpiryDate()
Returns the expiryDate. |
String |
getExternalId()
This method returns the ID by which this task could be identified with the provider. |
String |
getExternalObjectId()
Returns the externalObjectID. |
String |
getExternalType()
Returns the type by which item is known in the back end. |
String |
getForwardedBy()
Relevant only if the item is forwarded by some one else. |
Date |
getForwardedDate()
Relevant only if the item is forwarded by some one else. |
Date |
getFutureDate()
Relevant only for resubmission (a Business Workflow term) items. |
long |
getInternalId()
Identifer by which item is known in the UWL cache. |
String |
getItemType()
This method returns item type for this item. |
int |
getMemoCount()
Returns the memo Count. |
Long |
getParentItemId()
When a work item is created for a sub process, it contains reference to the the parent item thro item id (type long). |
PriorityEnum |
getPriority()
Returns the priority associated with the Item. |
String |
getProcessor()
Returns the current processor of the item. |
StatusEnum |
getStatus()
Returns the status of the item. |
String |
getSubject()
This method returns one of the standard attributes of the Item, namely subject. |
String |
getSubProcessId()
If this item has any child processes (sub process) running, it returns the identifer of such a process. |
String |
getSubstitutedFor()
If an item arrives to users inbox because he is substituting for someone else, this field is filled. |
String |
getSystemId()
System from which Item came to UWL. |
String |
getUserId()
Owner of the item. |
boolean |
hasRequiredAction()
Indicate if reading of additional information or certain action (secondary method) of the item is mandatory before item execution. |
boolean |
hasSubProcess()
Indicates if item has sub process attached to it. |
int |
internalGetFlags()
Used for internal purposes only. |
boolean |
internalIsBOAttributesFilled()
Only for internal usage. |
void |
internalSetBOAttributesFilled(boolean b)
Only for internal usage. |
void |
internalSetFlags(int f)
Used for internal purpose only. |
void |
internalSetIncomplete(boolean bSet)
Internal method to indicate item may not be fully filled. |
boolean |
isAttachmentHeaderFilled()
Method to verify if item has attachments headers retrieved. |
boolean |
isDeclinable()
A Special flag which indicates if end user can decline the item. |
boolean |
isEscalated()
This flag can be set for some of the item types like alerts or collaboration items indicating that the work item/ alert is an escalated one. |
boolean |
isHollow()
Connector can mark an Item as hollow in which case, it could fill the item lazily later in a second call. |
boolean |
isIncomplete()
An item is incomplete if its description or attachment are not filled because there is no connection to the Provider is made. |
boolean |
isLaunched()
If item is executed by clicking on any link associated with the Item, this flag is set. |
boolean |
isLocked()
Indicates if item is locked. |
boolean |
isNew()
Indicates if item is new (status is NEW). |
boolean |
isRead()
Indicates if item is read. |
boolean |
isShared()
Indicates if this item is a shared item i.e. has several assignees of same locale. |
boolean |
isUnRead()
|
Attribute |
removeAttribute(String attrName)
Removes on Custom Attribute from the Item. |
void |
setAppContext(String appContext)
|
void |
setAttachmentCount(int attachmentCount)
Sets the attachmentCount. |
void |
setAttachments(Attachment[] info)
|
void |
setCompletedDate(Date d)
|
void |
setCreatedDate(Date date)
|
void |
setCreatorId(String creatorID)
|
void |
setDecision(String str)
Associates decision with an Item. |
void |
setDeclinable(boolean b)
|
void |
setDescription(String description)
To display the description as raw (non-encoded) text, the description must start with a Html comment. |
void |
setDueDate(Date dueDate)
|
void |
setEscalated(boolean b)
|
void |
setEscalatedBy(String userWhoEscalated)
|
void |
setExecutionUrl(String executionURL)
|
void |
setExpiryDate(Date expiryDate)
Sets the expiryDate. |
void |
setExternalObjectId(String externalObjectID)
|
void |
setExternalType(String externalType)
|
void |
setForwardedBy(String usr)
|
void |
setForwardedDate(Date d)
|
void |
setFutureDate(Date d)
|
void |
setHollow(boolean b)
|
void |
setInternalId(long internalID)
|
void |
setItemType(String itemType)
This method sets item type such as uwl.notification. |
void |
setLaunched(boolean b)
If item is executed by clicking on any link associated with the Item, this flag is set. |
void |
setLocked(boolean b)
|
void |
setMemoCount(int memCount)
Sets the memoCount. |
void |
setParentItemId(long pItemId)
Sets the parentId for Item |
void |
setPriority(PriorityEnum priority)
|
void |
setProcessor(String procesor)
|
void |
setRead(boolean set)
|
void |
setRequiredAction(boolean b)
Set to true when mandatory reading/action is defined for the item. |
void |
setShared()
marks this item as a shared item |
void |
setStatus(StatusEnum status)
|
void |
setSubject(String subject)
|
void |
setSubProcessId(String subProcId)
|
void |
setSubstitutedFor(String usr)
|
void |
setUser(String user)
|
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
public static final int UNKNOWN_ATTACHMENT_EXISTENCE
public static final int UNKNOWN_NUMBER_EXISTING_ATTACHMENT
public static final int ZERO_NUMBER_ATTACHMENT
public static final Attachment[] EMPTY_ATTACHMENTS
public static final String ATTACHMENT_COUNT
public static final String APP_CONTEXT
public static final String INTERNAL_ID
public static final String CONNECTOR_ID
public static final String SYSTEM_ID
public static final String EXTERNAL_ID
public static final String USER_ID
public static final String CREATED_DATE
public static final String CREATOR_ID
public static final String DUE_DATE
public static final String EXECUTION_URL
public static final String EXPIRY_DATE
public static final String EXTL_OBJECT_ID
public static final String EXTERNAL_TYPE
public static final String ITEM_TYPE
public static final String INTERNAL_STATUS_FLAG
public static final String MEMO_COUNT
public static final String PRIORITY
public static final String PROCESSOR
public static final String STATUS
public static final String SUBJECT
public static final String SUBPROCESS_ID
public static final String DECISION
public static final String DESCRIPTION
public static final String PARENT_ITEM_ID
public static final String COMPLETED_DATE
java.util.date type.
public static final String FORWARDED_DATE
java.util.date type.
public static final String FORWARDED_BY
public static final String ESCALATED_BY
public static final String IS_ESCALATED
public static final String SUBSTITUTED_FOR
public static final String FUTURE_DATE
java.util.date type.
This is also known as follow up date.
| Constructor Detail |
public Item(String connectorID,
String systemID,
String externalID,
String userID)
connectorID - the connector ID.systemID - the system ID.externalID - the external ID.userID - the user ID.
public Item(String connectorID,
String systemID,
String externalID,
String userID,
int attachmentCount,
Date createdDate,
String creatorID,
Date dueDate,
String externalObjectID,
String externalType,
String itemType,
PriorityEnum priority,
StatusEnum status,
String subject)
connectorID - systemID - externalID - userID - attachmentCount - createdDate - creatorID - dueDate - externalObjectID - externalType - itemType - priority - status - subject - | Method Detail |
public String getConnectorId()
public String getItemType()
public String getCreatorId()
public Date getCreatedDate()
public String getDescription()
IUWLItemManager.getItemByUwlId(com.sap.netweaver.bc.uwl.UWLContext,long,boolean,boolean,boolean)public void setDescription(String description)
description - the text that describes this item.public Date getDueDate()
public String getExternalId()
public String getExternalType()
public PriorityEnum getPriority()
public String getProcessor()
public void setProcessor(String procesor)
procesor - could be null or users unique idgetProcessor()public StatusEnum getStatus()
public String getSystemId()
public String getSubject()
public String getUserId()
public Attachment[] getAttachments()
IUWLItemManager's getItemByUwlId() methods.
IUWLItemManager.getItemByUwlId(com.sap.netweaver.bc.uwl.UWLContext,long,boolean,boolean,boolean)public void setAttachments(Attachment[] info)
info - an array of attachments.public boolean isAttachmentHeaderFilled()
public String getExternalObjectId()
public void setItemType(String itemType)
itemType - the text that describes the type of the item.public void setUser(String user)
user - the ID of the user.public void setInternalId(long internalID)
internalID - public long getInternalId()
public String getExecutionUrl()
public int getAttachmentCount()
public void setAttachmentCount(int attachmentCount)
attachmentCount - The attachmentCount to setpublic int getMemoCount()
public void setMemoCount(int memCount)
memCount - The memoCount to setpublic Date getExpiryDate()
public void setExpiryDate(Date expiryDate)
expiryDate - The expiryDate to setpublic boolean internalIsBOAttributesFilled()
public void internalSetFlags(int f)
f - public int internalGetFlags()
public void internalSetBOAttributesFilled(boolean b)
b - indicates whether or not BOAttributes are filled.public void setCreatedDate(Date date)
date - the date on which this item is created.public void setCreatorId(String creatorID)
creatorID - the ID of the creator.public void setDueDate(Date dueDate)
dueDate - the date on which this item is due.public void setExternalObjectId(String externalObjectID)
externalObjectID - the external object ID.public void setExternalType(String externalType)
externalType - the external type of the itempublic void setStatus(StatusEnum status)
status - the status enum which indicates whether or not the item is read, etc.public void setSubject(String subject)
subject - the subject of this item.public void setExecutionUrl(String executionURL)
executionURL - the execution URL.public void setPriority(PriorityEnum priority)
priority - the priority enum like high, normal, low, etc.public Map getAttributes()
public Object getAttributeValue(String attributeName)
attributeName - the name of the desired attribute.
public Attribute getAttribute(String attributeName)
attributeName - the name of the desired attribute.
public void addAttributes(Map attr)
public Attribute removeAttribute(String attrName)
IPushChannel.updateItemmethods need
to be called.
attrName - shouldnt be null
public void addAttribute(Attribute attr)
attr - not nullpublic String[] getAttributeNames()
public String getAppContext()
public void setAppContext(String appContext)
appContext - the application context of the item which is like a name space.public String getSubstitutedFor()
public void setSubstitutedFor(String usr)
public boolean hasSubProcess()
public String getSubProcessId()
public void setSubProcessId(String subProcId)
subProcId - if null then subProcess is removedpublic boolean isEscalated()
public void setEscalatedBy(String userWhoEscalated)
public String getEscalatedBy()
public Date getCompletedDate()
public Date getForwardedDate()
public Date getFutureDate()
public void setCompletedDate(Date d)
public void setForwardedDate(Date d)
public void setFutureDate(Date d)
public String getDecision()
public void setDecision(String str)
str - public String getForwardedBy()
public void setForwardedBy(String usr)
public Long getParentItemId()
public void setParentItemId(long pItemId)
public boolean isShared()
public void setShared()
public boolean isHollow()
public void setHollow(boolean b)
b - indicates whether or not the item should be lazily initialized.public boolean isDeclinable()
public void setDeclinable(boolean b)
b - indicates whether or not the item be declinable. By default false.public void setEscalated(boolean b)
b - indicates whether or not the item is escalated. By default false.public boolean isLocked()
public boolean isRead()
public void setRead(boolean set)
set - if false item is marked unread
Marks the items as read item.public boolean isUnRead()
public boolean isNew()
public boolean hasRequiredAction()
public void setRequiredAction(boolean b)
public boolean isLaunched()
public void setLaunched(boolean b)
public void setLocked(boolean b)
b - indicates whether or not the item be locked.public void internalSetIncomplete(boolean bSet)
bSet - public boolean isIncomplete()
com.sap.netweaver.bc.uwl.IUWLItemManager#getAllActionsForItem()
|
SAP NetWeaver 2004S SPS 10 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||