wt.workflow.work
Class WfBallot

java.lang.Object
  wt.fc.WTObject
      wt.workflow.work.WfBallot

All Implemented Interfaces:

DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class WfBallot

extends WTObject

implements Externalizable

These are the ballots objects used in assigned activities. Ballots will be generated at runtime.

Use the newWfBallot static factory method(s), not the WfBallot 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: true

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private WTPrincipalReference	delegate
static String	DELEGATE Label for the attribute.
static String	EVENT_LIST Label for the attribute; Event list vector from workComplete.
private Vector	eventList
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private boolean	required
static String	REQUIRED Label for the attribute; Indicates whether the assignee was required to cast this ballot.
private static String	RESOURCE
(package private) static long	serialVersionUID
private Timestamp	timestamp
static String	TIMESTAMP Label for the attribute.
private WTPrincipalReference	voter
static String	VOTER Label for the attribute; This generalizes the actual subtype of voter - WfPrincipalAssignee, WfProjectAssignee, WfRoleAssignee, or WfVariableAssignee.

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

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

WfBallot()

Method Summary

private void	delegateValidate(WTPrincipalReference a_Delegate)
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	getConceptualClassname() Deprecated.
WTPrincipalReference	getDelegate() Gets the object for the association that plays role: DELEGATE.
Vector	getEventList() Gets the value of the attribute: EVENT_LIST.
Timestamp	getTimestamp() Gets the value of the attribute: TIMESTAMP.
WTPrincipalReference	getVoter() Gets the value of the attribute: VOTER.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Initializes objects created by new-factory methods.
boolean	isRequired() Gets the value of the attribute: REQUIRED.
static void	main(String[] argv)
static WfBallot	newWfBallot() Default factory for the class.
WfBallot	newWfBallot(WTPrincipalReference principalRef, Vector events, boolean required, ObjectReference source) Supported API: false
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(WfBallot thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setDelegate(WTPrincipalReference a_Delegate) Sets the object for the association that plays role: DELEGATE.
void	setEventList(Vector a_EventList) Sets the value of the attribute: EVENT_LIST.
void	setRequired(boolean a_Required) Sets the value of the attribute: REQUIRED.
void	setTimestamp(Timestamp a_Timestamp) Sets the value of the attribute: TIMESTAMP.
void	setVoter(WTPrincipalReference a_Voter) Sets the value of the attribute: VOTER.
private void	timestampValidate(Timestamp a_Timestamp)
String	toString() If the object has been persisted, return it's ObjectIdentifier.
private void	voterValidate(WTPrincipalReference a_Voter)
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, getIdentity, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

EVENT_LIST

public static final String EVENT_LIST

Label for the attribute; Event list vector from workComplete.

Supported API: true

See Also:

Constant Field Values

eventList

private Vector eventList

VOTER

public static final String VOTER

Label for the attribute; This generalizes the actual subtype of voter - WfPrincipalAssignee, WfProjectAssignee, WfRoleAssignee, or WfVariableAssignee.

Supported API: false

See Also:

Constant Field Values

voter

private WTPrincipalReference voter

TIMESTAMP

public static final String TIMESTAMP

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

timestamp

private Timestamp timestamp

REQUIRED

public static final String REQUIRED

Label for the attribute; Indicates whether the assignee was required to cast this ballot.

Supported API: false

See Also:

Constant Field Values

required

private boolean required

DELEGATE

public static final String DELEGATE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

delegate

private WTPrincipalReference delegate

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

WfBallot

public WfBallot()

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(WfBallot 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

getEventList

public Vector getEventList()

Gets the value of the attribute: EVENT_LIST. Event list vector from workComplete.

Supported API: true

Returns:

Vector

setEventList

public void setEventList(Vector a_EventList)
                  throws WTPropertyVetoException

Sets the value of the attribute: EVENT_LIST. Event list vector from workComplete.

Supported API: true

Parameters:

a_EventList -

Throws:

WTPropertyVetoException

getVoter

public WTPrincipalReference getVoter()

Gets the value of the attribute: VOTER. This generalizes the actual subtype of voter - WfPrincipalAssignee, WfProjectAssignee, WfRoleAssignee, or WfVariableAssignee.

Supported API: false

Returns:

WTPrincipalReference

setVoter

public void setVoter(WTPrincipalReference a_Voter)
              throws WTPropertyVetoException

Sets the value of the attribute: VOTER. This generalizes the actual subtype of voter - WfPrincipalAssignee, WfProjectAssignee, WfRoleAssignee, or WfVariableAssignee.

Supported API: false

Parameters:

a_Voter -

Throws:

WTPropertyVetoException

voterValidate

private void voterValidate(WTPrincipalReference a_Voter)
                    throws WTPropertyVetoException

Parameters:

a_Voter -

Throws:

WTPropertyVetoException

getTimestamp

public Timestamp getTimestamp()

Gets the value of the attribute: TIMESTAMP.

Supported API: true

Returns:

Timestamp

setTimestamp

public void setTimestamp(Timestamp a_Timestamp)
                  throws WTPropertyVetoException

Sets the value of the attribute: TIMESTAMP.

Supported API: true

Parameters:

a_Timestamp -

Throws:

WTPropertyVetoException

timestampValidate

private void timestampValidate(Timestamp a_Timestamp)
                        throws WTPropertyVetoException

Parameters:

a_Timestamp -

Throws:

WTPropertyVetoException

isRequired

public boolean isRequired()

Gets the value of the attribute: REQUIRED. Indicates whether the assignee was required to cast this ballot.

Supported API: false

Returns:

boolean

setRequired

public void setRequired(boolean a_Required)
                 throws WTPropertyVetoException

Sets the value of the attribute: REQUIRED. Indicates whether the assignee was required to cast this ballot.

Supported API: false

Parameters:

a_Required -

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

newWfBallot

public WfBallot newWfBallot(WTPrincipalReference principalRef,
                            Vector events,
                            boolean required,
                            ObjectReference source)
                     throws WfException

Supported API: false

Parameters:

principalRef -

events -

required -

source -

Returns:

WfBallot

Throws:

WfException

newWfBallot

public static WfBallot newWfBallot()
                            throws WTException

Default factory for the class.

Supported API: false

Returns:

WfBallot

Throws:

WTException

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

initialize

protected void initialize()

Description copied from class: WTObject

Initializes objects created by new-factory methods.

Supported API: false

Overrides:

initialize in class WTObject

toString

public String toString()

Description copied from class: WTObject

If the object has been persisted, return it's ObjectIdentifier. If it has not yet been persisted, simply return it's conceptual (modeled) name.

Overrides:

toString in class WTObject

Returns:

String

main

public static void main(String[] argv)