|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.task.clientmodel.bean.WorkItemBean
Accesses the properties of the original WorkItem
object
and adds metadata for national language support and converters.
A work item represents a relationship between a person or group of persons and an object, typically an activity or task instance. The relationship is described by attributes such as the type of the associated object and the reason why the object is assigned.
A WorkItemBean
object can be instantiated from
a QueryResultSet
object.
Only the following properties are going to be loaded from the query result set:
owner
objectType
objectID
creationTime
ID
reason
taskName
taskDisplayName
Use the static method getLabel(String, Locale)
to
retrieve the localized label for a property.
Use the static method getConverter(String)
to
retrieve a converter for a property. The return value may be null because converters
are optional.
WorkItem
,
QueryResultSet
Field Summary | |
---|---|
static java.lang.String |
ASSIGNEDTOEVERYBODY_PROPERTY
Use the property name to determine labels and converters for the property assignedToEverybody. |
static java.lang.String |
COPYRIGHT
(C) Copyright IBM Corporation 2005. |
static java.lang.String |
CREATIONIME_PROPERTY
Use the property name to determine labels and converters for the property creationTime. |
static java.lang.String |
ID_PROPERTY
Use the property name to determine labels and converters for the property ID. |
static java.lang.String |
OBJECTID_PROPERTY
Use the property name to determine labels and converters for the property objectID. |
static java.lang.String |
OBJECTTYPE_PROPERTY
Use the property name to determine labels and converters for the property objectType. |
static java.lang.String |
OWNER_PROPERTY
Use the property name to determine labels and converters for the property owner. |
static java.lang.String |
REASON_PROPERTY
Use the property name to determine labels and converters for the property reason. |
static java.lang.String |
TASKDISPLAYNAME_PROPERTY
Use the property name to determine labels and converters for the property taskDisplayName. |
static java.lang.String |
TASKNAME_PROPERTY
Use the property name to determine labels and converters for the property taskName. |
Constructor Summary | |
---|---|
WorkItemBean(com.ibm.task.api.QueryResultSet resultSet,
HTMConnection htmConnection)
Constructs a new WorkItemBean from a QueryResultSet . |
Method Summary | |
---|---|
static SimpleConverter |
getConverter(java.lang.String propertyName)
Returns the default converter for a given property. |
java.util.Calendar |
getCreationTime()
Returns the property creationTime . |
com.ibm.bpe.api.WIID |
getID()
Returns the property ID . |
static java.lang.String |
getLabel(java.lang.String propertyName)
Returns the resource bundle key for a property |
static java.lang.String |
getLabel(java.lang.String propertyName,
java.util.Locale locale)
Returns the label for a property from the resource bundle. |
com.ibm.bpe.api.OID |
getObjectID()
Returns the property objectID . |
int |
getObjectType()
Returns the property objectType . |
java.lang.String |
getOwner()
Returns the property owner . |
int |
getReason()
Returns the property reason . |
com.ibm.bpc.clientcore.util.LocalisedString |
getTaskDisplayName()
Returns the property taskDisplayName . |
java.lang.String |
getTaskDisplayName(java.util.Locale locale)
Returns the property taskDisplayName . |
boolean |
isAssignedToEverybody()
Returns the property assignedToEverybody . |
static boolean |
isValid(java.lang.String propertyName)
Checks if the property is valid. |
void |
setAssignedToEverybody(boolean newAssignedToEverybody)
Sets the property assignedToEverybody . |
void |
setCreationTime(java.util.Calendar newCreationTime)
Sets the property creationTime . |
void |
setID(com.ibm.bpe.api.WIID newWorkitemID)
Sets the property ID . |
void |
setObjectID(com.ibm.bpe.api.OID newObjectID)
Sets the property objectID . |
void |
setObjectType(int newObjectType)
Sets the property objectType . |
void |
setOwner(java.lang.String newOwner)
Sets the property owner . |
void |
setReason(int newReason)
Sets the property reason . |
java.lang.String |
toString()
Returns all properties in a printable format |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String COPYRIGHT
public static java.lang.String CREATIONIME_PROPERTY
public static java.lang.String ID_PROPERTY
public static java.lang.String OBJECTID_PROPERTY
public static java.lang.String OBJECTTYPE_PROPERTY
public static java.lang.String OWNER_PROPERTY
public static java.lang.String REASON_PROPERTY
public static java.lang.String ASSIGNEDTOEVERYBODY_PROPERTY
public static java.lang.String TASKNAME_PROPERTY
public static java.lang.String TASKDISPLAYNAME_PROPERTY
Constructor Detail |
public WorkItemBean(com.ibm.task.api.QueryResultSet resultSet, HTMConnection htmConnection)
WorkItemBean
from a QueryResultSet
.
resultSet
- The result object of a query.htmConnection
- The connection to the HumanTaskManagerService API.Method Detail |
public static SimpleConverter getConverter(java.lang.String propertyName)
propertyName
- The name for the property.
public static java.lang.String getLabel(java.lang.String propertyName)
propertyName
- The name for the property.
public static java.lang.String getLabel(java.lang.String propertyName, java.util.Locale locale)
propertyName
- The name for the property.locale
- The locale.
public static boolean isValid(java.lang.String propertyName)
propertyName
- The name of the property to be checked.
public java.util.Calendar getCreationTime()
creationTime
.
public com.ibm.bpe.api.WIID getID()
ID
.
public com.ibm.bpe.api.OID getObjectID()
objectID
.
public int getObjectType()
objectType
.
public com.ibm.bpc.clientcore.util.LocalisedString getTaskDisplayName()
taskDisplayName
.
public java.lang.String getTaskDisplayName(java.util.Locale locale)
taskDisplayName
.
public java.lang.String getOwner()
owner
.
public int getReason()
reason
.
public boolean isAssignedToEverybody()
assignedToEverybody
.
public void setAssignedToEverybody(boolean newAssignedToEverybody)
assignedToEverybody
.
newAssignedToEverybody
- true if the work item should be assigned to everybodypublic void setCreationTime(java.util.Calendar newCreationTime)
creationTime
.
newCreationTime
- the time of the object creationpublic void setID(com.ibm.bpe.api.WIID newWorkitemID)
ID
.
newWorkitemID
- the id of the work itempublic void setObjectID(com.ibm.bpe.api.OID newObjectID)
objectID
.
newObjectID
- the object idpublic void setObjectType(int newObjectType)
objectType
.
newObjectType
- the type of the work itempublic void setOwner(java.lang.String newOwner)
owner
.
newOwner
- the owner of the work itempublic void setReason(int newReason)
reason
.
newReason
- the reason of this work itempublic java.lang.String toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |