com.sap.netweaver.bc.uwl

Class Item

java.lang.Object
  extended bycom.sap.netweaver.bc.uwl.Item

public class Item
extends Object

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:

See Also:
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

UNKNOWN_ATTACHMENT_EXISTENCE

public static final int UNKNOWN_ATTACHMENT_EXISTENCE
It is not known whether there exists any attachment object.

See Also:
Constant Field Values

UNKNOWN_NUMBER_EXISTING_ATTACHMENT

public static final int UNKNOWN_NUMBER_EXISTING_ATTACHMENT
It is known that attachment(s) exist(s) but it is not clear how many of them are there.

See Also:
Constant Field Values

ZERO_NUMBER_ATTACHMENT

public static final int ZERO_NUMBER_ATTACHMENT
There exists no attachment at all.

See Also:
Constant Field Values

EMPTY_ATTACHMENTS

public static final Attachment[] EMPTY_ATTACHMENTS
Many of the following private properties could be null. and not suited depending upon the item type. Please maintain them in alphabetical order.


ATTACHMENT_COUNT

public static final String ATTACHMENT_COUNT
These constants could be used in the Sorting and Filtering functions. Reflection works on these constants.

See Also:
Constant Field Values

APP_CONTEXT

public static final String APP_CONTEXT
See Also:
Constant Field Values

INTERNAL_ID

public static final String INTERNAL_ID
See Also:
Constant Field Values

CONNECTOR_ID

public static final String CONNECTOR_ID
See Also:
Constant Field Values

SYSTEM_ID

public static final String SYSTEM_ID
See Also:
Constant Field Values

EXTERNAL_ID

public static final String EXTERNAL_ID
See Also:
Constant Field Values

USER_ID

public static final String USER_ID
See Also:
Constant Field Values

CREATED_DATE

public static final String CREATED_DATE
See Also:
Constant Field Values

CREATOR_ID

public static final String CREATOR_ID
See Also:
Constant Field Values

DUE_DATE

public static final String DUE_DATE
See Also:
Constant Field Values

EXECUTION_URL

public static final String EXECUTION_URL
See Also:
Constant Field Values

EXPIRY_DATE

public static final String EXPIRY_DATE
See Also:
Constant Field Values

EXTL_OBJECT_ID

public static final String EXTL_OBJECT_ID
See Also:
Constant Field Values

EXTERNAL_TYPE

public static final String EXTERNAL_TYPE
See Also:
Constant Field Values

ITEM_TYPE

public static final String ITEM_TYPE
See Also:
Constant Field Values

INTERNAL_STATUS_FLAG

public static final String INTERNAL_STATUS_FLAG
See Also:
Constant Field Values

MEMO_COUNT

public static final String MEMO_COUNT
See Also:
Constant Field Values

PRIORITY

public static final String PRIORITY
See Also:
Constant Field Values

PROCESSOR

public static final String PROCESSOR
The processor who is currently responsible for the item. Or if the item has been completed, it is the last person who worked on the item.

See Also:
Constant Field Values

STATUS

public static final String STATUS
See Also:
Constant Field Values

SUBJECT

public static final String SUBJECT
See Also:
Constant Field Values

SUBPROCESS_ID

public static final String SUBPROCESS_ID
See Also:
Constant Field Values

DECISION

public static final String DECISION
Decision about the items approval item

See Also:
Constant Field Values

DESCRIPTION

public static final String DESCRIPTION
Sorting on following fields is not allowed.

See Also:
Constant Field Values

PARENT_ITEM_ID

public static final String PARENT_ITEM_ID
In case of sub process item, indicates the parent itemId

See Also:
Constant Field Values

COMPLETED_DATE

public static final String COMPLETED_DATE
Typical dynamic attribute for an item. The date when the item is completed, in java.util.date type.

See Also:
Constant Field Values

FORWARDED_DATE

public static final String FORWARDED_DATE
Typical dynamic attribute for an item. The date when the item is forwarded, in java.util.date type.

See Also:
Constant Field Values

FORWARDED_BY

public static final String FORWARDED_BY
See Also:
Constant Field Values

ESCALATED_BY

public static final String ESCALATED_BY
See Also:
Constant Field Values

IS_ESCALATED

public static final String IS_ESCALATED
See Also:
Constant Field Values

SUBSTITUTED_FOR

public static final String SUBSTITUTED_FOR
See Also:
Constant Field Values

FUTURE_DATE

public static final String FUTURE_DATE
Typical dynamic attribute for an item. The date when the item is postponed to, in java.util.date type. This is also known as follow up date.

See Also:
Constant Field Values
Constructor Detail

Item

public Item(String connectorID,
            String systemID,
            String externalID,
            String userID)
This constructor creates an item with minimum parameters required to construct the item key. Note that Key for the item is defined as external ID + connector ID+system ID + user ID.

Parameters:
connectorID - the connector ID.
systemID - the system ID.
externalID - the external ID.
userID - the user ID.

Item

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)
This constructor is intended to create an item in a comprehensive way.

Parameters:
connectorID -
systemID -
externalID -
userID -
attachmentCount -
createdDate -
creatorID -
dueDate -
externalObjectID -
externalType -
itemType -
priority -
status -
subject -
Method Detail

getConnectorId

public String getConnectorId()
This method returns provider's registered name. This helps in contacting the same provider if needed.

Returns:
String the connector ID.

getItemType

public String getItemType()
This method returns item type for this item. The type can be something like uwl.notification.

Returns:
String the item type.

getCreatorId

public String getCreatorId()
Returns User or process that created this item. This could be null.

Returns:
String creator ID.

getCreatedDate

public Date getCreatedDate()
Returns the date this item is sent or created at the Provider system. This could be null.

Returns:
Date the date this item has been created.

getDescription

public String getDescription()
Returns the description. Before calling this, description should be filled for the item object by calling the IUWLItemManager methods.

Returns:
String the description of this item. Could be null.
See Also:
IUWLItemManager.getItemByUwlId(com.sap.netweaver.bc.uwl.UWLContext,long,boolean,boolean,boolean)

setDescription

public void setDescription(String description)
To display the description as raw (non-encoded) text, the description must start with a Html comment. i.e. <!-- some text here -->

Parameters:
description - the text that describes this item.

getDueDate

public Date getDueDate()
Certain item may contain date when they are supposed to be due.

Returns:
Date the due date for this item. Could be null.

getExternalId

public String getExternalId()
This method returns the ID by which this task could be identified with the provider.

Returns:
String the external ID.

getExternalType

public String getExternalType()
Returns the type by which item is known in the back end. This field could be null.

Returns:
String the external type.

getPriority

public PriorityEnum getPriority()
Returns the priority associated with the Item. Could be nul.

Returns:
PriorityEnum the priority of the item like low, normal, high, etc.

getProcessor

public String getProcessor()
Returns the current processor of the item. This makes sense only for certain types of tasks for example tracking tasks or forwarded tasks.

Returns:
could be null. Users unique Id if it is found in the portal else provider given string.

setProcessor

public void setProcessor(String procesor)
Parameters:
procesor - could be null or users unique id
See Also:
getProcessor()

getStatus

public StatusEnum getStatus()
Returns the status of the item.

Returns:
StatusEnum the status of this item like new, read, completed, etc.

getSystemId

public String getSystemId()
System from which Item came to UWL.

Returns:
String the system ID.

getSubject

public String getSubject()
This method returns one of the standard attributes of the Item, namely subject.

Returns:
String the subject of this item.

getUserId

public String getUserId()
Owner of the item. It is the users unique Id. See also com.sap.security.IUser.getUniqueID().

Returns:
String the user ID.

getAttachments

public Attachment[] getAttachments()
Returns attachments associated with the work item. Before calling this method, items attachment should be filled by calling IUWLItemManager's getItemByUwlId() methods.

Returns:
Attachment[] an array of attachments. Even if there are no attachments, this returns an array of zero length but not null.
See Also:
IUWLItemManager.getItemByUwlId(com.sap.netweaver.bc.uwl.UWLContext,long,boolean,boolean,boolean)

setAttachments

public void setAttachments(Attachment[] info)
Parameters:
info - an array of attachments.

isAttachmentHeaderFilled

public boolean isAttachmentHeaderFilled()
Method to verify if item has attachments headers retrieved.

Returns:
boolean true if the number of attachments is greater than zero and the array of attachments is not empty. Returns also true if the attachment count equals zero. Returns false otherwise.

getExternalObjectId

public String getExternalObjectId()
Returns the externalObjectID.

Returns:
String the external ID.

setItemType

public void setItemType(String itemType)
This method sets item type such as uwl.notification.

Parameters:
itemType - the text that describes the type of the item.

setUser

public void setUser(String user)
Parameters:
user - the ID of the user.

setInternalId

public void setInternalId(long internalID)
Parameters:
internalID -

getInternalId

public long getInternalId()
Identifer by which item is known in the UWL cache.

Returns:
long the internal ID.

getExecutionUrl

public String getExecutionUrl()
Returns the executionURL. Could be null.

Returns:
String the execution URL.

getAttachmentCount

public int getAttachmentCount()
Returns the attachmentCount. Attachment count includes the memo type attachments count too.

Returns:
int the number of attachments.

setAttachmentCount

public void setAttachmentCount(int attachmentCount)
Sets the attachmentCount.

Parameters:
attachmentCount - The attachmentCount to set

getMemoCount

public int getMemoCount()
Returns the memo Count. Typically memo count indicates how many memo type attachments are there.

Returns:
int the number of memos attached to this item.

setMemoCount

public void setMemoCount(int memCount)
Sets the memoCount. Typically memo count indicates how many memo type attachments are there.

Parameters:
memCount - The memoCount to set

getExpiryDate

public Date getExpiryDate()
Returns the expiryDate. This is valid for certain types of items like Alerts.

Returns:
Date the date of expiration.

setExpiryDate

public void setExpiryDate(Date expiryDate)
Sets the expiryDate.

Parameters:
expiryDate - The expiryDate to set

internalIsBOAttributesFilled

public boolean internalIsBOAttributesFilled()
Only for internal usage.

Returns:
boolean true if the if BOAttributes are filled and false otherwise.

internalSetFlags

public void internalSetFlags(int f)
Used for internal purpose only.

Parameters:
f -

internalGetFlags

public int internalGetFlags()
Used for internal purposes only.

Returns:

internalSetBOAttributesFilled

public void internalSetBOAttributesFilled(boolean b)
Only for internal usage.

Parameters:
b - indicates whether or not BOAttributes are filled.

setCreatedDate

public void setCreatedDate(Date date)
Parameters:
date - the date on which this item is created.

setCreatorId

public void setCreatorId(String creatorID)
Parameters:
creatorID - the ID of the creator.

setDueDate

public void setDueDate(Date dueDate)
Parameters:
dueDate - the date on which this item is due.

setExternalObjectId

public void setExternalObjectId(String externalObjectID)
Parameters:
externalObjectID - the external object ID.

setExternalType

public void setExternalType(String externalType)
Parameters:
externalType - the external type of the item

setStatus

public void setStatus(StatusEnum status)
Parameters:
status - the status enum which indicates whether or not the item is read, etc.

setSubject

public void setSubject(String subject)
Parameters:
subject - the subject of this item.

setExecutionUrl

public void setExecutionUrl(String executionURL)
Parameters:
executionURL - the execution URL.

setPriority

public void setPriority(PriorityEnum priority)
Parameters:
priority - the priority enum like high, normal, low, etc.

getAttributes

public Map getAttributes()
This method returns the attributes that are specific to this item. These are different from the normal attributes like subject.

Returns:
Map the map of attributes specific to this item. This could be Collections.EMPTY_MAP. So for putting attributes, use addAttributes() method.

getAttributeValue

public Object getAttributeValue(String attributeName)
Returns the value of the attribute specified.

Parameters:
attributeName - the name of the desired attribute.
Returns:
Object the value of the desired attribute. If such attribute does not exist, this will return null.

getAttribute

public Attribute getAttribute(String attributeName)
Returns one Attribute for the item.

Parameters:
attributeName - the name of the desired attribute.
Returns:
Attribute the desired attribute. Returns null if the desired attribute is not found.

addAttributes

public void addAttributes(Map attr)
Method to add custom attributes to the Item object.


removeAttribute

public Attribute removeAttribute(String attrName)
Removes on Custom Attribute from the Item. This doesnt persist the item. For persisting the item in the cache, IPushChannel.updateItemmethods need to be called.

Parameters:
attrName - shouldnt be null
Returns:
Attribute if present, null if not present.

addAttribute

public void addAttribute(Attribute attr)
Method for adding one attribute to the item

Parameters:
attr - not null

getAttributeNames

public String[] getAttributeNames()
Returns the attribute names.

Returns:
String[] the array of strings that contain the names of the attributes.

getAppContext

public String getAppContext()
Application context sort of represents a namespace for an Item. It could be a collaboration room id, or an applications identifier. It could be maximum of 10 chars.

Returns:
String could be null

setAppContext

public void setAppContext(String appContext)
Parameters:
appContext - the application context of the item which is like a name space.

getSubstitutedFor

public String getSubstitutedFor()
If an item arrives to users inbox because he is substituting for someone else, this field is filled. Typically this should be the com.sap.security.api.IUser.getUniqueID()

Returns:
could be null

setSubstitutedFor

public void setSubstitutedFor(String usr)

hasSubProcess

public boolean hasSubProcess()
Indicates if item has sub process attached to it.

Returns:
true if this item has a sub process attached to it.

getSubProcessId

public String getSubProcessId()
If this item has any child processes (sub process) running, it returns the identifer of such a process.

Returns:
null if there is no subprocess attached

setSubProcessId

public void setSubProcessId(String subProcId)
Parameters:
subProcId - if null then subProcess is removed

isEscalated

public 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. Actual semantinc meaning of being escalated and follow up actions for the same depend upon the acutal item type.

Returns:
true if escalated.

setEscalatedBy

public void setEscalatedBy(String userWhoEscalated)

getEscalatedBy

public String getEscalatedBy()
Returns string User-id who escalated the item.

Returns:
could be null. User who escalated the item

getCompletedDate

public Date getCompletedDate()
Returns the date when item is completed.

Returns:
Date when the item is completed. Could be null if not specified by the Provider while giving items to UWL.

getForwardedDate

public Date getForwardedDate()
Relevant only if the item is forwarded by some one else.

Returns:
Date when the item is forwarded. Could be null.

getFutureDate

public Date getFutureDate()
Relevant only for resubmission (a Business Workflow term) items.

Returns:
Date when item is going to be resubmitted.

setCompletedDate

public void setCompletedDate(Date d)

setForwardedDate

public void setForwardedDate(Date d)

setFutureDate

public void setFutureDate(Date d)

getDecision

public String getDecision()
For completed items, if item has a decision like approved, or rejected that text is returned.

Returns:
could be null

setDecision

public void setDecision(String str)
Associates decision with an Item.

Parameters:
str -

getForwardedBy

public String getForwardedBy()
Relevant only if the item is forwarded by some one else.

Returns:
the user id of the user who forwarded this item.

setForwardedBy

public void setForwardedBy(String usr)

getParentItemId

public 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).

Returns:
could be null if there is no parent item associated with it.

setParentItemId

public void setParentItemId(long pItemId)
Sets the parentId for Item


isShared

public boolean isShared()
Indicates if this item is a shared item i.e. has several assignees of same locale.

Returns:
true if item is shared

setShared

public void setShared()
marks this item as a shared item


isHollow

public boolean isHollow()
Connector can mark an Item as hollow in which case, it could fill the item lazily later in a second call. An item marked as hollow may not have all its standard attributes filled. Some of the attributes may be filled later in populateHollowItem method of the providerConnector.

Returns:
boolean true if lazy initialization is chosen and false otherwise.

setHollow

public void setHollow(boolean b)
Parameters:
b - indicates whether or not the item should be lazily initialized.

isDeclinable

public boolean isDeclinable()
A Special flag which indicates if end user can decline the item.

Returns:
true if declinable.

setDeclinable

public void setDeclinable(boolean b)
Parameters:
b - indicates whether or not the item be declinable. By default false.

setEscalated

public void setEscalated(boolean b)
Parameters:
b - indicates whether or not the item is escalated. By default false.

isLocked

public boolean isLocked()
Indicates if item is locked.

Returns:

isRead

public boolean isRead()
Indicates if item is read. An Item is read when user sees the preview or the detail for the item.

Returns:
boolean true either the item is new or it is not yet read and false otherwise.

setRead

public void setRead(boolean set)
Parameters:
set - if false item is marked unread Marks the items as read item.

isUnRead

public boolean isUnRead()

isNew

public boolean isNew()
Indicates if item is new (status is NEW).

Returns:
boolean true if the item is new and false otherwise.

hasRequiredAction

public boolean hasRequiredAction()
Indicate if reading of additional information or certain action (secondary method) of the item is mandatory before item execution. This is rendered as required attachment of an item. Return true if item has this requirement defined, and false otherwise.


setRequiredAction

public void setRequiredAction(boolean b)
Set to true when mandatory reading/action is defined for the item.


isLaunched

public boolean isLaunched()
If item is executed by clicking on any link associated with the Item, this flag is set.

Returns:
boolean true if the item is launched and false otherwise.

setLaunched

public void setLaunched(boolean b)
If item is executed by clicking on any link associated with the Item, this flag is set.


setLocked

public void setLocked(boolean b)
Parameters:
b - indicates whether or not the item be locked.

internalSetIncomplete

public void internalSetIncomplete(boolean bSet)
Internal method to indicate item may not be fully filled.

Parameters:
bSet -

isIncomplete

public boolean isIncomplete()
An item is incomplete if its description or attachment are not filled because there is no connection to the Provider is made. Another situation where an Item is marked inComplete is if Actions are asked,but back end connections could not be made.

Returns:
true if it is hollow or /description/attachments are not filled
See Also:
com.sap.netweaver.bc.uwl.IUWLItemManager#getAllActionsForItem()


Copyright 2006 SAP AG Complete Copyright Notice