wt.org.electronicIdentity
Class SignatureLink

java.lang.Object
  wt.fc.WTObject
      wt.fc.ObjectToObjectLink
          wt.org.electronicIdentity.SignatureLink

All Implemented Interfaces:

BinaryLink, DisplayIdentification, Externalizable, Link, NetFactor, ObjectMappable, Persistable, Serializable

public class SignatureLink

extends ObjectToObjectLink

implements Externalizable

Class contains the association between a WTUsers electronic identity and the class that implements the ElectronicallySignable interface.

Use the newSignatureLink static factory method(s), not the SignatureLink 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
private String	comments
static String	COMMENTS Label for the attribute.
private static int	COMMENTS_UPPER_LIMIT
static long	EXTERNALIZATION_VERSION_UID
private String	instructions
static String	INSTRUCTIONS Label for the attribute; Description of why the object was signed.
private static int	INSTRUCTIONS_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
private String	role
static String	ROLE Label for the attribute; The Role the users was playing when they signed the object.
private static int	ROLE_UPPER_LIMIT
(package private) static long	serialVersionUID
static String	SIGNABLE_ROLE Label for the attribute.
static String	SIGNATURE_ROLE Label for the attribute.
private String	vote
static String	VOTE Label for the attribute; How the user voted during the task completion for this item.
private static int	VOTE_UPPER_LIMIT

Fields inherited from class wt.fc.ObjectToObjectLink

ROLE_AOBJECT_REF, ROLE_BOBJECT_REF

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.fc.BinaryLink

ALL_ROLES, BOTH_ROLES, ROLE_AOBJECT_ROLE, ROLE_BOBJECT_ROLE

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

SignatureLink()

Method Summary

private void	commentsValidate(String a_Comments)
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	getComments() Gets the value of the attribute: COMMENTS.
String	getConceptualClassname() Deprecated.
String	getInstructions() Gets the value of the attribute: INSTRUCTIONS.
String	getRole() Gets the value of the attribute: ROLE.
ElectronicallySignable	getSignable() Gets the object for the association that plays role: SIGNABLE_ROLE.
ElectronicIdentification	getSignature() Gets the object for the association that plays role: SIGNATURE_ROLE.
String	getVote() Gets the value of the attribute: VOTE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
private void	instructionsValidate(String a_Instructions)
static SignatureLink	newSignatureLink(ElectronicallySignable signable, ElectronicIdentification signature) Default factory for the class.
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(SignatureLink thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
private void	roleValidate(String a_Role)
void	setComments(String a_Comments) Sets the value of the attribute: COMMENTS.
void	setInstructions(String a_Instructions) Sets the value of the attribute: INSTRUCTIONS.
void	setRole(String a_Role) Sets the value of the attribute: ROLE.
void	setSignable(ElectronicallySignable signable) Sets the object for the association that plays role: SIGNABLE_ROLE.
void	setSignature(ElectronicIdentification signature) Sets the object for the association that plays role: SIGNATURE_ROLE.
void	setVote(String a_Vote) Sets the value of the attribute: VOTE.
private void	voteValidate(String a_Vote)
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.ObjectToObjectLink

appendJoinCriteria, appendRoleCriteria, duplicate, getAllObjects, getJoinValues, getLinkInfo, getObject, getOtherObject, getRemoteRoleAObjectId, getRemoteRoleBObjectId, getRole, getRoleAObject, getRoleAObjectId, getRoleAObjectRef, getRoleBObject, getRoleBObjectId, getRoleBObjectRef, getRoleIdName, getRoleObject, initialize, isRoleANonpersistentProxy, isRoleBNonpersistentProxy, readVersion, setRoleAObject, setRoleAObjectRef, setRoleBObject, setRoleBObjectRef, setRoleObject

Methods inherited from class wt.fc.WTObject

checkAttributes, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, 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, getIdentity, 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

SIGNABLE_ROLE

public static final String SIGNABLE_ROLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

SIGNATURE_ROLE

public static final String SIGNATURE_ROLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

INSTRUCTIONS

public static final String INSTRUCTIONS

Label for the attribute; Description of why the object was signed. Can be the Activities description which the user is allowed to change per activity completion or the description of why an iterated object was iterated or deleted.

Supported API: false

See Also:

Constant Field Values

INSTRUCTIONS_UPPER_LIMIT

private static int INSTRUCTIONS_UPPER_LIMIT

instructions

private String instructions

COMMENTS

public static final String COMMENTS

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

COMMENTS_UPPER_LIMIT

private static int COMMENTS_UPPER_LIMIT

comments

private String comments

VOTE

public static final String VOTE

Label for the attribute; How the user voted during the task completion for this item. Accept, Reject, Promote....

Supported API: false

See Also:

Constant Field Values

VOTE_UPPER_LIMIT

private static int VOTE_UPPER_LIMIT

vote

private String vote

ROLE

public static final String ROLE

Label for the attribute; The Role the users was playing when they signed the object.

Supported API: false

See Also:

Constant Field Values

ROLE_UPPER_LIMIT

private static int ROLE_UPPER_LIMIT

role

private String role

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

SignatureLink

public SignatureLink()

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 ObjectToObjectLink

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 ObjectToObjectLink

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(SignatureLink 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 ObjectToObjectLink

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 ObjectToObjectLink

Parameters:

input -

Throws:

SQLException

DatastoreException

getSignable

public ElectronicallySignable getSignable()

Gets the object for the association that plays role: SIGNABLE_ROLE.

Supported API: false

Returns:

ElectronicallySignable

setSignable

public void setSignable(ElectronicallySignable signable)
                 throws WTPropertyVetoException

Sets the object for the association that plays role: SIGNABLE_ROLE.

Supported API: false

Parameters:

signable -

Throws:

WTPropertyVetoException

getSignature

public ElectronicIdentification getSignature()

Gets the object for the association that plays role: SIGNATURE_ROLE.

Supported API: false

Returns:

ElectronicIdentification

setSignature

public void setSignature(ElectronicIdentification signature)
                  throws WTPropertyVetoException

Sets the object for the association that plays role: SIGNATURE_ROLE.

Supported API: false

Parameters:

signature -

Throws:

WTPropertyVetoException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

getInstructions

public String getInstructions()

Gets the value of the attribute: INSTRUCTIONS. Description of why the object was signed. Can be the Activities description which the user is allowed to change per activity completion or the description of why an iterated object was iterated or deleted.

Supported API: false

Returns:

String

setInstructions

public void setInstructions(String a_Instructions)
                     throws WTPropertyVetoException

Sets the value of the attribute: INSTRUCTIONS. Description of why the object was signed. Can be the Activities description which the user is allowed to change per activity completion or the description of why an iterated object was iterated or deleted.

Supported API: false

Parameters:

a_Instructions -

Throws:

WTPropertyVetoException

instructionsValidate

private void instructionsValidate(String a_Instructions)
                           throws WTPropertyVetoException

Parameters:

a_Instructions -

Throws:

WTPropertyVetoException

getComments

public String getComments()

Gets the value of the attribute: COMMENTS.

Supported API: false

Returns:

String

setComments

public void setComments(String a_Comments)
                 throws WTPropertyVetoException

Sets the value of the attribute: COMMENTS.

Supported API: false

Parameters:

a_Comments -

Throws:

WTPropertyVetoException

commentsValidate

private void commentsValidate(String a_Comments)
                       throws WTPropertyVetoException

Parameters:

a_Comments -

Throws:

WTPropertyVetoException

getVote

public String getVote()

Gets the value of the attribute: VOTE. How the user voted during the task completion for this item. Accept, Reject, Promote....

Supported API: false

Returns:

String

setVote

public void setVote(String a_Vote)
             throws WTPropertyVetoException

Sets the value of the attribute: VOTE. How the user voted during the task completion for this item. Accept, Reject, Promote....

Supported API: false

Parameters:

a_Vote -

Throws:

WTPropertyVetoException

voteValidate

private void voteValidate(String a_Vote)
                   throws WTPropertyVetoException

Parameters:

a_Vote -

Throws:

WTPropertyVetoException

getRole

public String getRole()

Gets the value of the attribute: ROLE. The Role the users was playing when they signed the object.

Supported API: false

Returns:

String

setRole

public void setRole(String a_Role)
             throws WTPropertyVetoException

Sets the value of the attribute: ROLE. The Role the users was playing when they signed the object.

Supported API: false

Parameters:

a_Role -

Throws:

WTPropertyVetoException

roleValidate

private void roleValidate(String a_Role)
                   throws WTPropertyVetoException

Parameters:

a_Role -

Throws:

WTPropertyVetoException

newSignatureLink

public static SignatureLink newSignatureLink(ElectronicallySignable signable,
                                             ElectronicIdentification signature)
                                      throws WTException

Default factory for the class.

Supported API: false

Parameters:

signable -

signature -

Returns:

SignatureLink

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 ObjectToObjectLink

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 ObjectToObjectLink

Returns:

int