|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.task.clientmodel.bean.WorkItemBean
public class WorkItemBean
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.
WorkItem
,
QueryResultSet
Field Summary | |
---|---|
static java.lang.String |
ASSIGNEDTOEVERYBODY_PROPERTY
Use the property name to determine labels and converters for the assignedToEverybody property. |
static java.lang.String |
COPYRIGHT
(C) Copyright IBM Corporation 2005, 2007. |
static java.lang.String |
CREATIONIME_PROPERTY
Deprecated. use CREATIONTIME_PROPERTY |
static java.lang.String |
CREATIONTIME_PROPERTY
Use the property name to determine labels and converters for the creationTime property. |
static java.lang.String |
GROUPNAME_PROPERTY
Use the property name to determine labels and converters for the groupName property. |
static java.lang.String |
ID_PROPERTY
Use the property name to determine labels and converters for the ID property. |
static java.lang.String |
OBJECTID_PROPERTY
Use the property name to determine labels and converters for the objectID property. |
static java.lang.String |
OBJECTTYPE_PROPERTY
Use the property name to determine labels and converters for the objectType property. |
static java.lang.String |
OWNER_PROPERTY
Use the property name to determine labels and converters for the owner property. |
static java.lang.String |
REASON_PROPERTY
Use the property name to determine labels and converters for the reason property. |
static java.lang.String |
TASKDISPLAYNAME_PROPERTY
Use the property name to determine labels and converters for the taskDisplayName property. |
static java.lang.String |
TASKNAME_PROPERTY
Use the property name to determine labels and converters for the taskName property. |
Constructor Summary | |
---|---|
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 | |
---|---|
static SimpleConverter |
getConverter(java.lang.String propertyName)
Returns the default converter for a given property. |
java.util.Calendar |
getCreationTime()
Returns the creationTime property. |
java.lang.String |
getGroupName()
Returns the groupName property. |
com.ibm.bpe.api.WIID |
getID()
Returns the ID property. |
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. |
OID |
getObjectID()
Returns the objectID property. |
int |
getObjectType()
Returns the objectType property. |
java.lang.String |
getOwner()
Returns the owner property. |
int |
getReason()
Returns the reason property. |
com.ibm.bpc.clientcore.util.LocalisedString |
getTaskDisplayName()
Returns the taskDisplayName property. |
java.lang.String |
getTaskDisplayName(java.util.Locale locale)
Returns the taskDisplayName property. |
java.lang.String |
getTaskName()
Returns the taskName property. |
TKTID |
getTaskTemplateID()
Returns the property tktid . |
boolean |
isAssignedToEverybody()
Returns the assignedToEverybody property. |
static boolean |
isValid(java.lang.String propertyName)
Checks wehther the property is valid. |
void |
setAssignedToEverybody(boolean newAssignedToEverybody)
Sets the assignedToEverybody property. |
void |
setCreationTime(java.util.Calendar newCreationTime)
Sets the creationTime property. |
void |
setGroupName(java.lang.String newGroupName)
Sets the groupName property. |
void |
setID(com.ibm.bpe.api.WIID newWorkitemID)
Sets the ID property. |
void |
setLocalisedDisplayName(java.lang.String displayName,
java.util.Locale locale)
Sets the taskDisplayName property. |
void |
setObjectID(OID newObjectID)
Sets the objectID property. |
void |
setObjectType(int newObjectType)
Sets the objectType property. |
void |
setOwner(java.lang.String newOwner)
Sets the owner property. |
void |
setReason(int newReason)
Sets the reason property. |
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 final java.lang.String CREATIONTIME_PROPERTY
creationTime
property.
public static final java.lang.String CREATIONIME_PROPERTY
CREATIONTIME_PROPERTY
creationTime
property.
public static final java.lang.String ID_PROPERTY
ID
property.
public static final java.lang.String OBJECTID_PROPERTY
objectID
property.
public static final java.lang.String OBJECTTYPE_PROPERTY
objectType
property.
public static final java.lang.String OWNER_PROPERTY
owner
property.
public static final java.lang.String REASON_PROPERTY
reason
property.
public static final java.lang.String ASSIGNEDTOEVERYBODY_PROPERTY
assignedToEverybody
property.
public static final java.lang.String TASKNAME_PROPERTY
taskName
property.
public static final java.lang.String TASKDISPLAYNAME_PROPERTY
taskDisplayName
property.
public static final java.lang.String GROUPNAME_PROPERTY
groupName
property.
Constructor Detail |
---|
public WorkItemBean(QueryResultSet resultSet, HTMConnection htmConnection)
WorkItemBean
from a QueryResultSet
.
resultSet
- The result object of a query.htmConnection
- The connection to the HumanTaskManagerService API.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 |
---|
public static SimpleConverter getConverter(java.lang.String propertyName)
propertyName
- The name of the property.
public static java.lang.String getLabel(java.lang.String propertyName)
propertyName
- The name of the property.
public static java.lang.String getLabel(java.lang.String propertyName, java.util.Locale locale)
propertyName
- The name of the property.locale
- The locale.
public static boolean isValid(java.lang.String propertyName)
propertyName
- The name of the property to be checked.
public TKTID getTaskTemplateID()
tktid
.
Task.getTaskTemplateID()
public java.util.Calendar getCreationTime()
creationTime
property.
public com.ibm.bpe.api.WIID getID()
ID
property.
public OID getObjectID()
objectID
property.
public int getObjectType()
objectType
property.
public void setLocalisedDisplayName(java.lang.String displayName, java.util.Locale locale)
taskDisplayName
property.
Task.setDisplayName(java.lang.String,
java.util.Locale)
public com.ibm.bpc.clientcore.util.LocalisedString getTaskDisplayName()
taskDisplayName
property.
public java.lang.String getTaskDisplayName(java.util.Locale locale)
taskDisplayName
property.
locale
-
public java.lang.String getTaskName()
taskName
property.
public java.lang.String getOwner()
owner
property.
public int getReason()
reason
property.
public boolean isAssignedToEverybody()
assignedToEverybody
property.
public java.lang.String getGroupName()
groupName
property.
public void setGroupName(java.lang.String newGroupName)
groupName
property.
newGroupName
- the name of the group of the work itempublic void setAssignedToEverybody(boolean newAssignedToEverybody)
assignedToEverybody
property.
newAssignedToEverybody
- true if the work item is to be assigned to everybodypublic void setCreationTime(java.util.Calendar newCreationTime)
creationTime
property.
newCreationTime
- the time of the object's creationpublic void setID(com.ibm.bpe.api.WIID newWorkitemID)
ID
property.
newWorkitemID
- the ID of the work itempublic void setObjectID(OID newObjectID)
objectID
property.
newObjectID
- the object IDpublic void setObjectType(int newObjectType)
objectType
property.
newObjectType
- the type of the work itempublic void setOwner(java.lang.String newOwner)
owner
property.
newOwner
- the owner of the work itempublic void setReason(int newReason)
reason
property.
newReason
- the reason of this work itempublic java.lang.String toString()
toString
in class java.lang.Object
|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |