wt.workflow.work
Class WorkItem

java.lang.Object
  extended bywt.fc.WTObject
      extended bywt.workflow.work.WorkItem
All Implemented Interfaces:
DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Ownable, Persistable, Serializable
Direct Known Subclasses:
ProjectWorkItem

public class WorkItem
extends WTObject
implements Ownable, Externalizable

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

See Also:
Serialized Form

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 ObjectIdentifiers.
 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

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

TASK_URLPATH_INFO

public static final String TASK_URLPATH_INFO
Label for the attribute; A string representation of the everything after the gateway portion of the task URL. The actual URL for the task associated with this work item is built as needed by calling the method 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

See Also:
GatewayURL, Constant Field Values

TASK_URLPATH_INFO_UPPER_LIMIT

private static int TASK_URLPATH_INFO_UPPER_LIMIT

taskURLPathInfo

private String taskURLPathInfo

ROLE

public static final String ROLE
Label for the attribute; The role that the owner will play in completing the work item

Supported API: false

See Also:
Constant Field Values

ROLE_UPPER_LIMIT

private static int ROLE_UPPER_LIMIT

role

private Role role

DESCRIPTION

public static final String DESCRIPTION
Label for the attribute; A description of the work

Supported API: false

See Also:
Constant Field Values

DESCRIPTION_UPPER_LIMIT

private static int DESCRIPTION_UPPER_LIMIT

description

private String description

SOURCE

public static final String SOURCE
Label for the attribute; The source that created this work item

Supported API: false

See Also:
Constant Field Values

source

private ObjectReference source

PRIORITY

public static final String PRIORITY
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

PRIORITY_UPPER_LIMIT

private static int PRIORITY_UPPER_LIMIT

priority

private String priority

REQUIRED

public static final String REQUIRED
Label for the attribute; Indicates whether or not this work item HAS to be completed

Supported API: false

See Also:
Constant Field Values

required

private boolean required

COMPLETED_BY

public static final String COMPLETED_BY
Label for the attribute; The name of the entity that completed this work item. Work can be completed by humans as well as workflow robot activities.

Supported API: false

See Also:
Constant Field Values

COMPLETED_BY_UPPER_LIMIT

private static int COMPLETED_BY_UPPER_LIMIT

completedBy

private String completedBy

PRIMARY_BUSINESS_OBJECT

public static final String PRIMARY_BUSINESS_OBJECT
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

primaryBusinessObject

private PersistentReference primaryBusinessObject

PARENT_WA

public static final String PARENT_WA
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

parentWA

private ObjectReference parentWA

STATUS

public static final String STATUS
Label for the attribute; State of the assignment. One of {POTENTIAL, ACCEPTED}.

Supported API: false

See Also:
Constant Field Values

STATUS_UPPER_LIMIT

private static int STATUS_UPPER_LIMIT

status

private WfAssignmentState status

VARIABLE_PERMISSION_MAP

protected static final String VARIABLE_PERMISSION_MAP
Label for the attribute; Associates variable names to lists of permissions actually granted to task participant. After task is done all the permissions in the list must be revoked for each variable.

Supported API: false

See Also:
Constant Field Values

variablePermissionMap

private VariablePermissionTable variablePermissionMap

REASSIGNED

public static final String REASSIGNED
Label for the attribute; Indicates whether or not this work item has been reassigned.

Supported API: false

See Also:
Constant Field Values

reassigned

private boolean reassigned

DELEGATE

public static final String DELEGATE
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

delegate

private WTPrincipalReference delegate

ownership

private Ownership ownership

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID
See Also:
Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID
See Also:
Constant Field Values
Constructor Detail

WorkItem

public WorkItem()
Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException
Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class WTObject
Parameters:
output -
Throws:
IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException
Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class WTObject
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

protected boolean readVersion(WorkItem thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException
Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:
thisObject -
input -
readSerialVersionUID -
passThrough -
superDone -
Returns:
boolean
Throws:
IOException
ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException
Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:
input -
readSerialVersionUID -
passThrough -
superDone -
Returns:
boolean
Throws:
IOException
ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException
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.

(Not intended for general use.)

Supported API: false

Specified by:
writeExternal in interface ObjectMappable
Overrides:
writeExternal in class WTObject
Parameters:
output -
Throws:
SQLException
DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException
Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:
readExternal in interface ObjectMappable
Overrides:
readExternal in class WTObject
Parameters:
input -
Throws:
SQLException
DatastoreException

getConceptualClassname

public String getConceptualClassname()
Deprecated.  

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:
getConceptualClassname in interface NetFactor
Returns:
String

getTaskURLPathInfo

public String getTaskURLPathInfo()
Gets the value of the attribute: TASK_URLPATH_INFO. A string representation of the everything after the gateway portion of the task URL. The actual URL for the task associated with this work item is built as needed by calling the method 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

Returns:
String
See Also:
GatewayURL

setTaskURLPathInfo

public void setTaskURLPathInfo(String a_TaskURLPathInfo)
Sets the value of the attribute: TASK_URLPATH_INFO. A string representation of the everything after the gateway portion of the task URL. The actual URL for the task associated with this work item is built as needed by calling the method 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

Parameters:
a_TaskURLPathInfo -
See Also:
GatewayURL

getRole

public Role getRole()
Gets the value of the attribute: ROLE. The role that the owner will play in completing the work item

Supported API: false

Returns:
Role

setRole

public void setRole(Role a_Role)
             throws WTPropertyVetoException
Sets the value of the attribute: ROLE. The role that the owner will play in completing the work item

Supported API: false

Parameters:
a_Role -
Throws:
WTPropertyVetoException

getDescription

public String getDescription()
Gets the value of the attribute: DESCRIPTION. A description of the work

Supported API: false

Returns:
String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException
Sets the value of the attribute: DESCRIPTION. A description of the work

Supported API: false

Parameters:
a_Description -
Throws:
WTPropertyVetoException

descriptionValidate

private void descriptionValidate(String a_Description)
                          throws WTPropertyVetoException
Parameters:
a_Description -
Throws:
WTPropertyVetoException

getSource

public ObjectReference getSource()
Gets the value of the attribute: SOURCE. The source that created this work item

Supported API: false

Returns:
ObjectReference

setSource

public void setSource(ObjectReference a_Source)
Sets the value of the attribute: SOURCE. The source that created this work item

Supported API: false

Parameters:
a_Source -

getPriority

public String getPriority()
Gets the value of the attribute: PRIORITY.

Supported API: false

Returns:
String

setPriority

public void setPriority(String a_Priority)
                 throws WTPropertyVetoException
Sets the value of the attribute: PRIORITY.

Supported API: false

Parameters:
a_Priority -
Throws:
WTPropertyVetoException

priorityValidate

private void priorityValidate(String a_Priority)
                       throws WTPropertyVetoException
Parameters:
a_Priority -
Throws:
WTPropertyVetoException

isRequired

public boolean isRequired()
Gets the value of the attribute: REQUIRED. Indicates whether or not this work item HAS to be completed

Supported API: false

Returns:
boolean

setRequired

public void setRequired(boolean a_Required)
                 throws WTPropertyVetoException
Sets the value of the attribute: REQUIRED. Indicates whether or not this work item HAS to be completed

Supported API: false

Parameters:
a_Required -
Throws:
WTPropertyVetoException

getCompletedBy

public String getCompletedBy()
Gets the value of the attribute: COMPLETED_BY. The name of the entity that completed this work item. Work can be completed by humans as well as workflow robot activities.

Supported API: false

Returns:
String

getPrimaryBusinessObject

public PersistentReference getPrimaryBusinessObject()
Gets the value of the attribute: PRIMARY_BUSINESS_OBJECT.

Supported API: false

Returns:
PersistentReference

setPrimaryBusinessObject

public void setPrimaryBusinessObject(PersistentReference a_PrimaryBusinessObject)
Sets the value of the attribute: PRIMARY_BUSINESS_OBJECT.

Supported API: false

Parameters:
a_PrimaryBusinessObject -

getParentWA

public ObjectReference getParentWA()
Gets the value of the attribute: PARENT_WA.

Supported API: false

Returns:
ObjectReference

setParentWA

public void setParentWA(ObjectReference a_ParentWA)
                 throws WTPropertyVetoException
Sets the value of the attribute: PARENT_WA.

Supported API: false

Parameters:
a_ParentWA -
Throws:
WTPropertyVetoException

parentWAValidate

private void parentWAValidate(ObjectReference a_ParentWA)
                       throws WTPropertyVetoException
Parameters:
a_ParentWA -
Throws:
WTPropertyVetoException

getStatus

public WfAssignmentState getStatus()
Gets the value of the attribute: STATUS. State of the assignment. One of {POTENTIAL, ACCEPTED}.

Supported API: false

Returns:
WfAssignmentState

setStatus

public void setStatus(WfAssignmentState a_Status)
Sets the value of the attribute: STATUS. State of the assignment. One of {POTENTIAL, ACCEPTED}.

Supported API: false

Parameters:
a_Status -

getVariablePermissionMap

protected VariablePermissionTable getVariablePermissionMap()
Gets the value of the attribute: VARIABLE_PERMISSION_MAP. Associates variable names to lists of permissions actually granted to task participant. After task is done all the permissions in the list must be revoked for each variable.

Supported API: false

Returns:
VariablePermissionTable

setVariablePermissionMap

protected void setVariablePermissionMap(VariablePermissionTable a_VariablePermissionMap)
Sets the value of the attribute: VARIABLE_PERMISSION_MAP. Associates variable names to lists of permissions actually granted to task participant. After task is done all the permissions in the list must be revoked for each variable.

Supported API: false

Parameters:
a_VariablePermissionMap -

isReassigned

public boolean isReassigned()
Gets the value of the attribute: REASSIGNED. Indicates whether or not this work item has been reassigned.

Supported API: false

Returns:
boolean

setReassigned

public void setReassigned(boolean a_Reassigned)
                   throws WTPropertyVetoException
Sets the value of the attribute: REASSIGNED. Indicates whether or not this work item has been reassigned.

Supported API: false

Parameters:
a_Reassigned -
Throws:
WTPropertyVetoException

getDelegate

public WTPrincipalReference getDelegate()
Gets the object for the association that plays role: DELEGATE.

Supported API: false

Returns:
WTPrincipalReference

setDelegate

public void setDelegate(WTPrincipalReference a_Delegate)
                 throws WTPropertyVetoException
Sets the object for the association that plays role: DELEGATE.

Supported API: false

Parameters:
a_Delegate -
Throws:
WTPropertyVetoException

delegateValidate

private void delegateValidate(WTPrincipalReference a_Delegate)
                       throws WTPropertyVetoException
Parameters:
a_Delegate -
Throws:
WTPropertyVetoException

newWorkItem

public static WorkItem newWorkItem(WTPrincipal owner)
                            throws WfException
Factory method that creates WorkItems.

Supported API: false

Parameters:
owner -
Returns:
WorkItem
Throws:
WfException

newWorkItem

public static WorkItem newWorkItem(WTPrincipal owner,
                                   String taskURLClass,
                                   String taskURLMethod,
                                   Properties taskURLParams,
                                   Role role,
                                   String description,
                                   ObjectReference source,
                                   String priority,
                                   boolean required)
                            throws WfException
Factory method that creates fully initialized WorkItems.

Supported API: false

Parameters:
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 -
Returns:
WorkItem
Throws:
WfException

isComplete

public boolean isComplete()
Indicates whether this work item has been completed.

Supported API: false

Returns:
boolean

setComplete

public void setComplete(String completedBy)
                 throws WTPropertyVetoException
Indicates that a work item has been completed by someone. This method should not be called directly! The WorkflowService has methods for marking work items complete.

Supported API: false

Parameters:
completedBy -
Throws:
WTPropertyVetoException

setIncomplete

void setIncomplete()
Changes a work item's status for complete to incomplete and nullifies the completeBy attribute.

Supported API: false


newWorkItem

public static WorkItem newWorkItem()
                            throws WTException
Default factory for the class.

Supported API: false

Returns:
WorkItem
Throws:
WTException

getOwnership

public Ownership getOwnership()
Gets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:
getOwnership in interface Ownable
Returns:
Ownership

setOwnership

public void setOwnership(Ownership a_Ownership)
Sets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:
setOwnership in interface Ownable
Parameters:
a_Ownership -

equals

public boolean equals(Object obj)
Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. 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

Overrides:
equals in class WTObject
Parameters:
obj -
Returns:
boolean

hashCode

public int hashCode()
Returns a hash code for this object based upon its 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

Overrides:
hashCode in class WTObject
Returns:
int

completedByValidate

private void completedByValidate(String completedByValidate)
                          throws WTPropertyVetoException
Throws:
WTPropertyVetoException

getIdentity

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

Returns a String that can be used to identify the target WorkItem object to an end-user. The identity string value returned is the workflow process name, a dash ('-'), and then the activity name.

Supported API: false

Specified by:
getIdentity in interface Persistable
Overrides:
getIdentity in class WTObject
Returns:
String

initialize

protected void initialize(WTPrincipal owner)
                   throws WTException
Throws:
WTException