wt.org.electronicIdentity
Class ElectronicSignature

java.lang.Object
  wt.fc.WTObject
      wt.org.electronicIdentity.ElectronicSignature

All Implemented Interfaces:

ContentHolder, DisplayIdentification, ElectronicIdentification, Externalizable, FormatContentHolder, NetFactor, ObjectMappable, Persistable, Serializable

public class ElectronicSignature

extends WTObject

implements ElectronicIdentification, Externalizable

Class contains the electronic identification of the WTUser.

Use the newElectronicSignature static factory method(s), not the ElectronicSignature 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 boolean	active
private static String	CLASSNAME
private Vector	contentVector
static long	EXTERNALIZATION_VERSION_UID
private DataFormatReference	format
private boolean	hasContents
private Vector	httpVector
private String	name
private static int	NAME_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
private HttpContentOperation	operation
private ContentItem	primary
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.org.electronicIdentity.ElectronicIdentification

ACTIVE, NAME

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.content.FormatContentHolder

FORMAT, FORMAT_NAME, PRIMARY

Fields inherited from interface wt.content.ContentHolder

CONTENT_VECTOR, HAS_CONTENTS, HTTP_VECTOR, OPERATION

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

ElectronicSignature()

Method Summary

boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
private void	formatValidate(DataFormatReference a_Format)
String	getConceptualClassname() Deprecated.
Vector	getContentVector() Gets the value of the attribute: CONTENT_VECTOR.
DataFormatReference	getFormat() Gets the object for the association that plays role: FORMAT.
String	getFormatName() Gets the value of the attribute: FORMAT_NAME.
Vector	getHttpVector() Gets the value of the attribute: HTTP_VECTOR.
String	getName() Gets the value of the attribute: NAME.
HttpContentOperation	getOperation() Gets the value of the attribute: OPERATION.
ContentItem	getPrimary() Gets the value of the attribute: PRIMARY.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(String fileName, boolean active) Supports initialization, following construction of an instance.
boolean	isActive() Gets the value of the attribute: ACTIVE.
boolean	isHasContents() Gets the value of the attribute: HAS_CONTENTS.
private void	nameValidate(String a_Name)
static ElectronicSignature	newElectronicSignature() Supported API: false
static ElectronicSignature	newElectronicSignature(String fileName, boolean active) 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(ElectronicSignature thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setActive(boolean a_Active) Sets the value of the attribute: ACTIVE.
void	setContentVector(Vector a_ContentVector) Sets the value of the attribute: CONTENT_VECTOR.
void	setFormat(DataFormatReference a_Format) Sets the object for the association that plays role: FORMAT.
void	setHasContents(boolean a_HasContents) Sets the value of the attribute: HAS_CONTENTS.
void	setHttpVector(Vector a_HttpVector) Sets the value of the attribute: HTTP_VECTOR.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setOperation(HttpContentOperation a_Operation) Sets the value of the attribute: OPERATION.
void	setPrimary(ContentItem a_Primary) Sets the value of the attribute: PRIMARY.
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, 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

active

private boolean active

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

primary

private ContentItem primary

format

private DataFormatReference format

contentVector

private Vector contentVector

hasContents

private boolean hasContents

operation

private HttpContentOperation operation

httpVector

private Vector httpVector

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

ElectronicSignature

public ElectronicSignature()

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

newElectronicSignature

public static ElectronicSignature newElectronicSignature(String fileName,
                                                         boolean active)
                                                  throws WTPropertyVetoException,
                                                         WTException

Supported API: false

Parameters:

fileName -

active -

Returns:

ElectronicSignature

Throws:

WTPropertyVetoException

WTException

initialize

protected void initialize(String fileName,
                          boolean active)
                   throws WTPropertyVetoException,
                          WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:

fileName -

active -

Throws:

WTPropertyVetoException

WTException

newElectronicSignature

public static ElectronicSignature newElectronicSignature()
                                                  throws WTException

Supported API: false

Returns:

ElectronicSignature

Throws:

WTException

isActive

public boolean isActive()

Gets the value of the attribute: ACTIVE. Only one electronic identity can be active at a time.

Supported API: false

Specified by:

isActive in interface ElectronicIdentification

Returns:

boolean

setActive

public void setActive(boolean a_Active)
               throws WTPropertyVetoException

Sets the value of the attribute: ACTIVE. Only one electronic identity can be active at a time.

Supported API: false

Specified by:

setActive in interface ElectronicIdentification

Parameters:

a_Active -

Throws:

WTPropertyVetoException

getName

public String getName()

Gets the value of the attribute: NAME. Name of the WTUsers electronicID.

Supported API: false

Specified by:

getName in interface ElectronicIdentification

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME. Name of the WTUsers electronicID.

Supported API: false

Specified by:

setName in interface ElectronicIdentification

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getFormatName

public String getFormatName()

Gets the value of the attribute: FORMAT_NAME.

Supported API: false

Specified by:

getFormatName in interface FormatContentHolder

Returns:

String

getPrimary

public ContentItem getPrimary()

Gets the value of the attribute: PRIMARY. This is a non-persistent ContentItem for FormatContentHolders that is used to pass the primary content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

getPrimary in interface FormatContentHolder

Returns:

ContentItem

setPrimary

public void setPrimary(ContentItem a_Primary)
                throws WTPropertyVetoException

Sets the value of the attribute: PRIMARY. This is a non-persistent ContentItem for FormatContentHolders that is used to pass the primary content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

setPrimary in interface FormatContentHolder

Parameters:

a_Primary -

Throws:

WTPropertyVetoException

getFormat

public DataFormatReference getFormat()

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

Supported API: false

Specified by:

getFormat in interface FormatContentHolder

Returns:

DataFormatReference

setFormat

public void setFormat(DataFormatReference a_Format)
               throws WTPropertyVetoException

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

Supported API: false

Specified by:

setFormat in interface FormatContentHolder

Parameters:

a_Format -

Throws:

WTPropertyVetoException

formatValidate

private void formatValidate(DataFormatReference a_Format)
                     throws WTPropertyVetoException

Parameters:

a_Format -

Throws:

WTPropertyVetoException

getContentVector

public Vector getContentVector()

Gets the value of the attribute: CONTENT_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

getContentVector in interface ContentHolder

Returns:

Vector

setContentVector

public void setContentVector(Vector a_ContentVector)
                      throws WTPropertyVetoException

Sets the value of the attribute: CONTENT_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

setContentVector in interface ContentHolder

Parameters:

a_ContentVector -

Throws:

WTPropertyVetoException

isHasContents

public boolean isHasContents()

Gets the value of the attribute: HAS_CONTENTS. This is a non-persistent variable that is used to pass information from server to client. Should not be directly accessed by the client

Supported API: false

Specified by:

isHasContents in interface ContentHolder

Returns:

boolean

setHasContents

public void setHasContents(boolean a_HasContents)
                    throws WTPropertyVetoException

Sets the value of the attribute: HAS_CONTENTS. This is a non-persistent variable that is used to pass information from server to client. Should not be directly accessed by the client

Supported API: false

Specified by:

setHasContents in interface ContentHolder

Parameters:

a_HasContents -

Throws:

WTPropertyVetoException

getOperation

public HttpContentOperation getOperation()

Gets the value of the attribute: OPERATION.

Supported API: false

Specified by:

getOperation in interface ContentHolder

Returns:

HttpContentOperation

setOperation

public void setOperation(HttpContentOperation a_Operation)
                  throws WTPropertyVetoException

Sets the value of the attribute: OPERATION.

Supported API: false

Specified by:

setOperation in interface ContentHolder

Parameters:

a_Operation -

Throws:

WTPropertyVetoException

getHttpVector

public Vector getHttpVector()

Gets the value of the attribute: HTTP_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

getHttpVector in interface ContentHolder

Returns:

Vector

setHttpVector

public void setHttpVector(Vector a_HttpVector)
                   throws WTPropertyVetoException

Sets the value of the attribute: HTTP_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

setHttpVector in interface ContentHolder

Parameters:

a_HttpVector -

Throws:

WTPropertyVetoException

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