wt.lifecycle
Class LifeCycleSignature

java.lang.Object
  wt.fc.WTObject
      wt.lifecycle.LifeCycleSignature

All Implemented Interfaces:

Externalizable, Serializable, NetFactor, ObjectMappable, Persistable, DisplayIdentification, wt.lifecycle.Signable

public class LifeCycleSignature
extends WTObject
implements wt.lifecycle.Signable, Externalizable

LifeCycleSignature captures a role player's ballot and comments for a specific object in a specific phase of a life cycle.

Use the newLifeCycleSignature static factory method(s), not the LifeCycleSignature 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:

Signable, Phase, LifeCycleHistory, wt.workflow.WorkItem, Serialized Form

Field Summary

static String	ROLE_NAME Label for the attribute; The name of the Role Supported API: true
static String	VOTE Label for the attribute; The signer's vote.

Method Summary

String	getComments() Gets the value of the attribute: COMMENTS.
String	getRoleName() Gets the value of the attribute: ROLE_NAME.
String	getSignerName() Gets the value of the attribute: SIGNER_NAME.
boolean	isVote() Gets the value of the attribute: VOTE.
void	setComments(String a_Comments) Sets the value of the attribute: COMMENTS.
void	setRoleName(String a_RoleName) Sets the value of the attribute: ROLE_NAME.
void	setSignerName(String a_SignerName) Sets the value of the attribute: SIGNER_NAME.
void	setVote(boolean a_Vote) Sets the value of the attribute: VOTE.

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

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

Field Detail

ROLE_NAME

public static final String ROLE_NAME

Label for the attribute; The name of the Role

Supported API: true

See Also:

Constant Field Values

VOTE

public static final String VOTE

Label for the attribute; The signer's vote. Approve/Disapprove. Required attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

getRoleName

public String getRoleName()

Gets the value of the attribute: ROLE_NAME. The name of the Role

Supported API: true

Returns:

String

setRoleName

public void setRoleName(String a_RoleName)
                 throws WTPropertyVetoException

Sets the value of the attribute: ROLE_NAME. The name of the Role

Supported API: true

Parameters:

a_RoleName -

Throws:

WTPropertyVetoException

isVote

public boolean isVote()

Gets the value of the attribute: VOTE. The signer's vote. Approve/Disapprove. Required attribute.

Supported API: true

Returns:

boolean

setVote

public void setVote(boolean a_Vote)
             throws WTPropertyVetoException

Sets the value of the attribute: VOTE. The signer's vote. Approve/Disapprove. Required attribute.

Supported API: true

Parameters:

a_Vote -

Throws:

WTPropertyVetoException

getSignerName

public String getSignerName()

Gets the value of the attribute: SIGNER_NAME. Full name of signing user. Required attribute.

Supported API: true

Returns:

String

setSignerName

public void setSignerName(String a_SignerName)
                   throws WTPropertyVetoException

Sets the value of the attribute: SIGNER_NAME. Full name of signing user. Required attribute.

Supported API: true

Parameters:

a_SignerName -

Throws:

WTPropertyVetoException

getComments

public String getComments()

Gets the value of the attribute: COMMENTS. Note: Should be removed in favor of Annotatable.

Supported API: true

Returns:

String

setComments

public void setComments(String a_Comments)
                 throws WTPropertyVetoException

Sets the value of the attribute: COMMENTS. Note: Should be removed in favor of Annotatable.

Supported API: true

Parameters:

a_Comments -

Throws:

WTPropertyVetoException