|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectwt.fc.WTObject
wt.workflow.work.WorkItem
The WorkItem class represents discreet units of work owned by principals. If the work item is owned by a group, any member of the group may satisfy the work requirement.
A work item has an associated task which is accessed through a URL. The task provides a context to help the user complete the work item.
The WorkflowService should be used to mark work items complete instead
of directly calling setComplete
.
Use the newWorkItem
static factory method(s), not the WorkItem
constructor, to construct instances of this class. Instances must be
constructed using the static factory(s), in order to ensure proper initialization
of the instance.
Supported API: false
Extendable: false
Field Summary | |
private static String |
CLASSNAME
|
static String |
COMPLETED_BY
Label for the attribute; The name of the entity that completed this work item. |
private static int |
COMPLETED_BY_UPPER_LIMIT
|
private String |
completedBy
|
private WTPrincipalReference |
delegate
|
static String |
DELEGATE
Label for the attribute. |
private String |
description
|
static String |
DESCRIPTION
Label for the attribute; A description of the work Supported API: false |
private static int |
DESCRIPTION_UPPER_LIMIT
|
static long |
EXTERNALIZATION_VERSION_UID
|
protected static long |
OLD_FORMAT_VERSION_UID
|
private Ownership |
ownership
|
static String |
PARENT_WA
Label for the attribute. |
private ObjectReference |
parentWA
|
static String |
PRIMARY_BUSINESS_OBJECT
Label for the attribute. |
private PersistentReference |
primaryBusinessObject
|
private String |
priority
|
static String |
PRIORITY
Label for the attribute. |
private static int |
PRIORITY_UPPER_LIMIT
|
private boolean |
reassigned
|
static String |
REASSIGNED
Label for the attribute; Indicates whether or not this work item has been reassigned. |
private boolean |
required
|
static String |
REQUIRED
Label for the attribute; Indicates whether or not this work item HAS to be completed Supported API: false |
private static String |
RESOURCE
|
private Role |
role
|
static String |
ROLE
Label for the attribute; The role that the owner will play in completing the work item Supported API: false |
private static int |
ROLE_UPPER_LIMIT
|
(package private) static long |
serialVersionUID
|
private ObjectReference |
source
|
static String |
SOURCE
Label for the attribute; The source that created this work item Supported API: false |
private WfAssignmentState |
status
|
static String |
STATUS
Label for the attribute; State of the assignment. |
private static int |
STATUS_UPPER_LIMIT
|
static String |
TASK_URLPATH_INFO
Label for the attribute; A string representation of the everything after the gateway portion of the task URL. |
private static int |
TASK_URLPATH_INFO_UPPER_LIMIT
|
private String |
taskURLPathInfo
|
protected static String |
VARIABLE_PERMISSION_MAP
Label for the attribute; Associates variable names to lists of permissions actually granted to task participant. |
private VariablePermissionTable |
variablePermissionMap
|
Fields inherited from class wt.fc.WTObject |
CREATE_TIMESTAMP, MODIFY_TIMESTAMP |
Fields inherited from interface wt.ownership.Ownable |
OWNERSHIP |
Fields inherited from interface wt.fc.Persistable |
IDENTITY, PERSIST_INFO, TYPE |
Fields inherited from interface wt.identity.DisplayIdentification |
DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE |
Constructor Summary | |
WorkItem()
|
Method Summary | |
private void |
completedByValidate(String completedByValidate)
|
private void |
delegateValidate(WTPrincipalReference a_Delegate)
|
private void |
descriptionValidate(String a_Description)
|
boolean |
equals(Object obj)
Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifier s. |
String |
getCompletedBy()
Gets the value of the attribute: COMPLETED_BY. |
String |
getConceptualClassname()
Deprecated. |
WTPrincipalReference |
getDelegate()
Gets the object for the association that plays role: DELEGATE. |
String |
getDescription()
Gets the value of the attribute: DESCRIPTION. |
String |
getIdentity()
Deprecated. Replaced by getDisplayIdentifier() to return a localizable message which supplies the identifier for the object. To return a localizable value which includes the object type, use getDisplayIdentity(). For general messages, getDisplayIdentity() by itself is prefereble to using a combination of getDisplayType() and getDisplayIdentifier(). |
Ownership |
getOwnership()
Gets the object for the association that plays role: OWNERSHIP. |
ObjectReference |
getParentWA()
Gets the value of the attribute: PARENT_WA. |
PersistentReference |
getPrimaryBusinessObject()
Gets the value of the attribute: PRIMARY_BUSINESS_OBJECT. |
String |
getPriority()
Gets the value of the attribute: PRIORITY. |
Role |
getRole()
Gets the value of the attribute: ROLE. |
ObjectReference |
getSource()
Gets the value of the attribute: SOURCE. |
WfAssignmentState |
getStatus()
Gets the value of the attribute: STATUS. |
String |
getTaskURLPathInfo()
Gets the value of the attribute: TASK_URLPATH_INFO. |
protected VariablePermissionTable |
getVariablePermissionMap()
Gets the value of the attribute: VARIABLE_PERMISSION_MAP. |
int |
hashCode()
Returns a hash code for this object based upon its ObjectIdentifier . |
protected void |
initialize(WTPrincipal owner)
|
boolean |
isComplete()
Indicates whether this work item has been completed. |
boolean |
isReassigned()
Gets the value of the attribute: REASSIGNED. |
boolean |
isRequired()
Gets the value of the attribute: REQUIRED. |
static WorkItem |
newWorkItem()
Default factory for the class. |
static WorkItem |
newWorkItem(WTPrincipal owner)
Factory method that creates WorkItems. |
static WorkItem |
newWorkItem(WTPrincipal owner,
String taskURLClass,
String taskURLMethod,
Properties taskURLParams,
Role role,
String description,
ObjectReference source,
String priority,
boolean required)
Factory method that creates fully initialized WorkItems. |
private void |
parentWAValidate(ObjectReference a_ParentWA)
|
private void |
priorityValidate(String a_Priority)
|
void |
readExternal(ObjectInput input)
Reads the non-transient fields of this class from an external source. |
void |
readExternal(PersistentRetrieveIfc input)
Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store. |
private boolean |
readOldVersion(ObjectInput input,
long readSerialVersionUID,
boolean passThrough,
boolean superDone)
Reads the non-transient fields of this class from an external source, which is not the current version. |
protected boolean |
readVersion(WorkItem thisObject,
ObjectInput input,
long readSerialVersionUID,
boolean passThrough,
boolean superDone)
Reads the non-transient fields of this class from an external source. |
void |
setComplete(String completedBy)
Indicates that a work item has been completed by someone. |
void |
setDelegate(WTPrincipalReference a_Delegate)
Sets the object for the association that plays role: DELEGATE. |
void |
setDescription(String a_Description)
Sets the value of the attribute: DESCRIPTION. |
(package private) void |
setIncomplete()
Changes a work item's status for complete to incomplete and nullifies the completeBy attribute. |
void |
setOwnership(Ownership a_Ownership)
Sets the object for the association that plays role: OWNERSHIP. |
void |
setParentWA(ObjectReference a_ParentWA)
Sets the value of the attribute: PARENT_WA. |
void |
setPrimaryBusinessObject(PersistentReference a_PrimaryBusinessObject)
Sets the value of the attribute: PRIMARY_BUSINESS_OBJECT. |
void |
setPriority(String a_Priority)
Sets the value of the attribute: PRIORITY. |
void |
setReassigned(boolean a_Reassigned)
Sets the value of the attribute: REASSIGNED. |
void |
setRequired(boolean a_Required)
Sets the value of the attribute: REQUIRED. |
void |
setRole(Role a_Role)
Sets the value of the attribute: ROLE. |
void |
setSource(ObjectReference a_Source)
Sets the value of the attribute: SOURCE. |
void |
setStatus(WfAssignmentState a_Status)
Sets the value of the attribute: STATUS. |
void |
setTaskURLPathInfo(String a_TaskURLPathInfo)
Sets the value of the attribute: TASK_URLPATH_INFO. |
protected void |
setVariablePermissionMap(VariablePermissionTable a_VariablePermissionMap)
Sets the value of the attribute: VARIABLE_PERMISSION_MAP. |
void |
writeExternal(ObjectOutput output)
Writes the non-transient fields of this class to an external source. |
void |
writeExternal(PersistentStoreIfc output)
Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store. |
Methods inherited from class wt.fc.WTObject |
checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getModifyTimestamp, getPersistInfo, getType, initialize, readVersion, setPersistInfo, toString |
Methods inherited from class java.lang.Object |
clone, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface wt.fc.Persistable |
checkAttributes, getPersistInfo, getType, setPersistInfo |
Methods inherited from interface wt.fc.NetFactor |
getClassInfo |
Field Detail |
private static final String RESOURCE
private static final String CLASSNAME
public static final String TASK_URLPATH_INFO
wt.httpgw.GatewayURL.getURL
.
The value for this attribute should be created using wt.httpgw.GatewayURL.buildPathInfo
or by constructing a work item with the multi argument constructor in
this class.
Example:
Properties params = new Properties();
params.put("action", "WfTask");
//Add other query string parameters...
String taskURLPathInfo = GatewayURL.buildPathInfo("wt.enterprise.URLProcessor",
"URLTemplateAction", null, params);
WorkItem wi = newWorkItem();
wi.setTaskURL(taskURLPathInfo);
Supported API: false
GatewayURL
,
Constant Field Valuesprivate static int TASK_URLPATH_INFO_UPPER_LIMIT
private String taskURLPathInfo
public static final String ROLE
private static int ROLE_UPPER_LIMIT
private Role role
public static final String DESCRIPTION
private static int DESCRIPTION_UPPER_LIMIT
private String description
public static final String SOURCE
private ObjectReference source
public static final String PRIORITY
private static int PRIORITY_UPPER_LIMIT
private String priority
public static final String REQUIRED
private boolean required
public static final String COMPLETED_BY
private static int COMPLETED_BY_UPPER_LIMIT
private String completedBy
public static final String PRIMARY_BUSINESS_OBJECT
private PersistentReference primaryBusinessObject
public static final String PARENT_WA
private ObjectReference parentWA
public static final String STATUS
private static int STATUS_UPPER_LIMIT
private WfAssignmentState status
protected static final String VARIABLE_PERMISSION_MAP
private VariablePermissionTable variablePermissionMap
public static final String REASSIGNED
private boolean reassigned
public static final String DELEGATE
private WTPrincipalReference delegate
private Ownership ownership
static final long serialVersionUID
public static final long EXTERNALIZATION_VERSION_UID
protected static final long OLD_FORMAT_VERSION_UID
Constructor Detail |
public WorkItem()
Method Detail |
public void writeExternal(ObjectOutput output) throws IOException
writeExternal
in interface Externalizable
writeExternal
in class WTObject
output
-
IOException
public void readExternal(ObjectInput input) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
readExternal
in class WTObject
input
-
IOException
ClassNotFoundException
protected boolean readVersion(WorkItem thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) throws IOException, ClassNotFoundException
thisObject
- input
- readSerialVersionUID
- passThrough
- superDone
-
IOException
ClassNotFoundException
private boolean readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) throws IOException, ClassNotFoundException
input
- readSerialVersionUID
- passThrough
- superDone
-
IOException
ClassNotFoundException
public void writeExternal(PersistentStoreIfc output) throws SQLException, DatastoreException
(Not intended for general use.)
Supported API: false
writeExternal
in interface ObjectMappable
writeExternal
in class WTObject
output
-
SQLException
DatastoreException
public void readExternal(PersistentRetrieveIfc input) throws SQLException, DatastoreException
(Not intended for general
use.)
Supported API: false
readExternal
in interface ObjectMappable
readExternal
in class WTObject
input
-
SQLException
DatastoreException
public String getConceptualClassname()
getConceptualClassname
in interface NetFactor
public String getTaskURLPathInfo()
wt.httpgw.GatewayURL.getURL
.
The value for this attribute should be created using wt.httpgw.GatewayURL.buildPathInfo
or by constructing a work item with the multi argument constructor
in this class.
Example:
Properties params = new Properties();
params.put("action", "WfTask");
//Add other query string parameters...
String taskURLPathInfo = GatewayURL.buildPathInfo("wt.enterprise.URLProcessor",
"URLTemplateAction", null, params);
WorkItem wi = newWorkItem();
wi.setTaskURL(taskURLPathInfo);
Supported API: false
GatewayURL
public void setTaskURLPathInfo(String a_TaskURLPathInfo)
wt.httpgw.GatewayURL.getURL
.
The value for this attribute should be created using wt.httpgw.GatewayURL.buildPathInfo
or by constructing a work item with the multi argument constructor
in this class.
Example:
Properties params = new Properties();
params.put("action", "WfTask");
//Add other query string parameters...
String taskURLPathInfo = GatewayURL.buildPathInfo("wt.enterprise.URLProcessor",
"URLTemplateAction", null, params);
WorkItem wi = newWorkItem();
wi.setTaskURL(taskURLPathInfo);
Supported API: false
a_TaskURLPathInfo
- GatewayURL
public Role getRole()
public void setRole(Role a_Role) throws WTPropertyVetoException
a_Role
-
WTPropertyVetoException
public String getDescription()
public void setDescription(String a_Description) throws WTPropertyVetoException
a_Description
-
WTPropertyVetoException
private void descriptionValidate(String a_Description) throws WTPropertyVetoException
a_Description
-
WTPropertyVetoException
public ObjectReference getSource()
public void setSource(ObjectReference a_Source)
a_Source
- public String getPriority()
public void setPriority(String a_Priority) throws WTPropertyVetoException
a_Priority
-
WTPropertyVetoException
private void priorityValidate(String a_Priority) throws WTPropertyVetoException
a_Priority
-
WTPropertyVetoException
public boolean isRequired()
public void setRequired(boolean a_Required) throws WTPropertyVetoException
a_Required
-
WTPropertyVetoException
public String getCompletedBy()
public PersistentReference getPrimaryBusinessObject()
public void setPrimaryBusinessObject(PersistentReference a_PrimaryBusinessObject)
a_PrimaryBusinessObject
- public ObjectReference getParentWA()
public void setParentWA(ObjectReference a_ParentWA) throws WTPropertyVetoException
a_ParentWA
-
WTPropertyVetoException
private void parentWAValidate(ObjectReference a_ParentWA) throws WTPropertyVetoException
a_ParentWA
-
WTPropertyVetoException
public WfAssignmentState getStatus()
public void setStatus(WfAssignmentState a_Status)
a_Status
- protected VariablePermissionTable getVariablePermissionMap()
protected void setVariablePermissionMap(VariablePermissionTable a_VariablePermissionMap)
a_VariablePermissionMap
- public boolean isReassigned()
public void setReassigned(boolean a_Reassigned) throws WTPropertyVetoException
a_Reassigned
-
WTPropertyVetoException
public WTPrincipalReference getDelegate()
public void setDelegate(WTPrincipalReference a_Delegate) throws WTPropertyVetoException
a_Delegate
-
WTPropertyVetoException
private void delegateValidate(WTPrincipalReference a_Delegate) throws WTPropertyVetoException
a_Delegate
-
WTPropertyVetoException
public static WorkItem newWorkItem(WTPrincipal owner) throws WfException
owner
-
WfException
public static WorkItem newWorkItem(WTPrincipal owner, String taskURLClass, String taskURLMethod, Properties taskURLParams, Role role, String description, ObjectReference source, String priority, boolean required) throws WfException
owner
- The WTPrincipal that this WorkItem is assigned to.taskURLClass
- String containing the class that supports the taskURLMethod.taskURLMethod
- String containing the method of the supplied class that will be invoked by the task URL.taskURLParams
- Parameters to the taskURLMethod.role
- description
- source
- priority
- required
-
WfException
public boolean isComplete()
public void setComplete(String completedBy) throws WTPropertyVetoException
WorkflowService
has
methods for marking work items complete.
completedBy
-
WTPropertyVetoException
void setIncomplete()
public static WorkItem newWorkItem() throws WTException
WTException
public Ownership getOwnership()
getOwnership
in interface Ownable
public void setOwnership(Ownership a_Ownership)
setOwnership
in interface Ownable
a_Ownership
- public boolean equals(Object obj)
ObjectIdentifier
s.
Changed or stale copies are still considered equal by this method.
Delegates to PersistenceHelper.equals(Persistable,Object)
.
Warning: Certain core Windchill operations may depend upon
equals
being ObjectIdentifier
-based. Changes
to the default implementation should be done with care, if at all.
Supported API: false
equals
in class WTObject
obj
-
public int hashCode()
ObjectIdentifier
.
Delegates to PersistenceHelper.hashCode(Persistable)
.
Warning: Certain core Windchill operations may depend upon
hashCode
being ObjectIdentifier-based
. Changes
to the default implementation should be done with care, if at all.
Supported API: false
hashCode
in class WTObject
private void completedByValidate(String completedByValidate) throws WTPropertyVetoException
WTPropertyVetoException
public String getIdentity()
getIdentity
in interface Persistable
getIdentity
in class WTObject
protected void initialize(WTPrincipal owner) throws WTException
WTException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |