com.ibm.task.clientmodel.bean
Class WorkItemBean
- java.lang.Object
com.ibm.task.clientmodel.bean.WorkItemBean
- public class WorkItemBean
- extends java.lang.Object
Stores the properties of a work item retrieved from a QueryResultSet
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 loaded from the query result set:
owner
objectType
objectID
creationTime
ID
reason
taskName
assignedToEverybody
groupName
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.
Field Summary
Modifier and Type | Field and Description |
---|---|
|
ASSIGNEDTOEVERYBODY_PROPERTY
Use the property name to determine labels and converters for the
assignedToEverybody property.
|
|
COPYRIGHT
(C) Copyright IBM Corporation 2005, 2007.
|
|
CREATIONIME_PROPERTY
Deprecated. use
CREATIONTIME_PROPERTY
|
|
CREATIONTIME_PROPERTY
Use the property name to determine labels and converters for the
creationTime property.
|
|
GROUPNAME_PROPERTY
Use the property name to determine labels and converters for the
groupName property.
|
|
ID_PROPERTY
Use the property name to determine labels and converters for the
ID property.
|
|
OBJECTID_PROPERTY
Use the property name to determine labels and converters for the
objectID property.
|
|
OBJECTTYPE_PROPERTY
Use the property name to determine labels and converters for the
objectType property.
|
|
OWNER_PROPERTY
Use the property name to determine labels and converters for the
owner property.
|
|
REASON_PROPERTY
Use the property name to determine labels and converters for the
reason property.
|
|
TASKDISPLAYNAME_PROPERTY
Use the property name to determine labels and converters for the
taskDisplayName property.
|
|
TASKNAME_PROPERTY
Use the property name to determine labels and converters for the
taskName property.
|
Constructor Summary
Constructor and Description |
---|
WorkItemBean(QueryResultSet resultSet,HTMConnection htmConnection)
Constructs a new
WorkItemBean from a QueryResultSet .
|
WorkItemBean(QueryResultSet resultSet,HTMConnection htmConnection,java.util.Locale locale)
Constructs a new
WorkItemBean from a QueryResultSet .
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getConverter(java.lang.String propertyName)
Returns the default converter for a given property.
|
|
getCreationTime()
Returns the
creationTime property.
|
|
getGroupName()
Returns the
groupName property.
|
|
getID()
Returns the
ID property.
|
|
getLabel(java.lang.String propertyName)
Returns the resource bundle key for a property
|
|
getLabel(java.lang.String propertyName,java.util.Locale locale)
Returns the label for a property from the resource bundle.
|
getObjectID()
Returns the
objectID property.
|
|
|
getObjectType()
Returns the
objectType property.
|
|
getOwner()
Returns the
owner property.
|
|
getReason()
Returns the
reason property.
|
|
getTaskDisplayName()
Returns the
taskDisplayName property.
|
|
getTaskDisplayName(java.util.Locale locale)
Returns the
taskDisplayName property.
|
|
getTaskName()
Returns the
taskName property.
|
getTaskTemplateID()
Returns the property
tktid .
|
|
|
isAssignedToEverybody()
Returns the
assignedToEverybody property.
|
|
isValid(java.lang.String propertyName)
Checks wehther the property is valid.
|
|
setAssignedToEverybody(boolean newAssignedToEverybody)
Sets the
assignedToEverybody property.
|
|
setCreationTime(java.util.Calendar newCreationTime)
Sets the
creationTime property.
|
|
setGroupName(java.lang.String newGroupName)
Sets the
groupName property.
|
|
setID(com.ibm.bpe.api.WIID newWorkitemID)
Sets the
ID property.
|
|
setLocalisedDisplayName(java.lang.String displayName,java.util.Locale locale)
Sets the
taskDisplayName property.
|
|
setObjectID(OID newObjectID)
Sets the
objectID property.
|
|
setObjectType(int newObjectType)
Sets the
objectType property.
|
|
setOwner(java.lang.String newOwner)
Sets the
owner property.
|
|
setReason(int newReason)
Sets the
reason property.
|
|
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
COPYRIGHT
- public static final java.lang.String COPYRIGHT
CREATIONTIME_PROPERTY
- public static final java.lang.String CREATIONTIME_PROPERTY
creationTime
property.
CREATIONIME_PROPERTY
- public static final java.lang.String CREATIONIME_PROPERTY
CREATIONTIME_PROPERTY
creationTime
property.
ID_PROPERTY
- public static final java.lang.String ID_PROPERTY
ID
property.
OBJECTID_PROPERTY
- public static final java.lang.String OBJECTID_PROPERTY
objectID
property.
OBJECTTYPE_PROPERTY
- public static final java.lang.String OBJECTTYPE_PROPERTY
objectType
property.
OWNER_PROPERTY
- public static final java.lang.String OWNER_PROPERTY
owner
property.
REASON_PROPERTY
- public static final java.lang.String REASON_PROPERTY
reason
property.
ASSIGNEDTOEVERYBODY_PROPERTY
- public static final java.lang.String ASSIGNEDTOEVERYBODY_PROPERTY
assignedToEverybody
property.
TASKNAME_PROPERTY
- public static final java.lang.String TASKNAME_PROPERTY
taskName
property.
TASKDISPLAYNAME_PROPERTY
- public static final java.lang.String TASKDISPLAYNAME_PROPERTY
taskDisplayName
property.
GROUPNAME_PROPERTY
- public static final java.lang.String GROUPNAME_PROPERTY
groupName
property.
Constructor Detail
WorkItemBean
- public WorkItemBean(QueryResultSet resultSet,
- HTMConnection htmConnection)
WorkItemBean
from a QueryResultSet
.
resultSet
- The result object of a query. htmConnection
- The connection to the HumanTaskManagerService API. WorkItemBean
- public WorkItemBean(QueryResultSet resultSet,
- HTMConnection htmConnection,
- java.util.Locale locale)
WorkItemBean
from a QueryResultSet
.
resultSet
- The result object of a query. htmConnection
- The connection to the HumanTaskManagerService API. locale
- The locale of the locale dependant properties. Method Detail
getConverter
- public static SimpleConverter getConverter( java.lang.String propertyName)
propertyName
- The name of the property. getLabel
- public static java.lang.String getLabel( java.lang.String propertyName)
propertyName
- The name of the property. getLabel
- public static java.lang.String getLabel( java.lang.String propertyName,
- java.util.Locale locale)
propertyName
- The name of the property. locale
- The locale. isValid
- public static boolean isValid(java.lang.String propertyName)
propertyName
- The name of the property to be checked. getTaskTemplateID
- public TKTID getTaskTemplateID( )
tktid
.
getCreationTime
- public java.util.Calendar getCreationTime( )
creationTime
property.
getID
- public com.ibm.bpe.api.WIID getID( )
ID
property.
getObjectID
- public OID getObjectID()
objectID
property.
getObjectType
- public int getObjectType()
objectType
property.
setLocalisedDisplayName
- public void setLocalisedDisplayName( java.lang.String displayName,
- java.util.Locale locale)
taskDisplayName
property.
getTaskDisplayName
- public com.ibm.bpc.clientcore.util.LocalisedString getTaskDisplayName( )
taskDisplayName
property.
getTaskDisplayName
- public java.lang.String getTaskDisplayName( java.util.Locale locale)
taskDisplayName
property.
locale
- getTaskName
- public java.lang.String getTaskName( )
taskName
property.
getOwner
- public java.lang.String getOwner( )
owner
property.
getReason
- public int getReason()
reason
property.
isAssignedToEverybody
- public boolean isAssignedToEverybody( )
assignedToEverybody
property.
getGroupName
- public java.lang.String getGroupName( )
groupName
property.
setGroupName
- public void setGroupName(java.lang.String newGroupName)
groupName
property.
newGroupName
- the name of the group of the work item setAssignedToEverybody
- public void setAssignedToEverybody( boolean newAssignedToEverybody)
assignedToEverybody
property.
newAssignedToEverybody
- true if the work item is to be assigned to everybody setCreationTime
- public void setCreationTime(java.util.Calendar newCreationTime)
creationTime
property.
newCreationTime
- the time of the object's creation setID
- public void setID(com.ibm.bpe.api.WIID newWorkitemID)
ID
property.
newWorkitemID
- the ID of the work item setObjectID
- public void setObjectID(OID newObjectID)
objectID
property.
newObjectID
- the object ID setObjectType
- public void setObjectType(int newObjectType)
objectType
property.
newObjectType
- the type of the work item setOwner
- public void setOwner(java.lang.String newOwner)
owner
property.
newOwner
- the owner of the work item setReason
- public void setReason(int newReason)
reason
property.
newReason
- the reason of this work item toString
- public java.lang.String toString( )
toString
in class java.lang.Object