wt.wrmf.delivery
Class Receipt

java.lang.Object
  wt.fc.WTObject
      wt.wrmf.delivery.Receipt

All Implemented Interfaces:

DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable, ShippingItem

Direct Known Subclasses:

AlertItem

public class Receipt

extends WTObject

implements ShippingItem, Externalizable

Use the newReceipt static factory method(s), not the Receipt 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	CONFIRMS_ID Label for the attribute.
private TrackingID	confirmsID
static long	EXTERNALIZATION_VERSION_UID
private ShippingLabel	itemLabel
protected static long	OLD_FORMAT_VERSION_UID
private ShippingLabel	receiptLabel
private static String	RESOURCE
(package private) static long	serialVersionUID
private long	totalSize
private static String	versionID

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.wrmf.delivery.ShippingItem

ITEM_LABEL, RECEIPT_LABEL

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

Receipt()

Method Summary

private void	confirmsIDValidate(TrackingID a_ConfirmsID)
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.
TrackingID	getConfirmsID() Gets the object for the association that plays role: CONFIRMS_ID.
ShippingLabel	getItemLabel() Gets the object for the association that plays role: ITEM_LABEL.
ShippingLabel	getReceiptLabel() Gets the object for the association that plays role: RECEIPT_LABEL.
protected long	getTotalSize() Gets the value of the attribute: TOTAL_SIZE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
private void	itemLabelValidate(ShippingLabel a_ItemLabel)
protected static Receipt	newReceipt() 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(Receipt thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
private void	receiptLabelValidate(ShippingLabel a_ReceiptLabel)
void	setConfirmsID(TrackingID a_ConfirmsID) Sets the object for the association that plays role: CONFIRMS_ID.
void	setItemLabel(ShippingLabel a_ItemLabel) Sets the object for the association that plays role: ITEM_LABEL.
void	setReceiptLabel(ShippingLabel a_ReceiptLabel) Sets the object for the association that plays role: RECEIPT_LABEL.
protected void	setTotalSize(long a_TotalSize) Sets the value of the attribute: TOTAL_SIZE.
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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

CONFIRMS_ID

public static final String CONFIRMS_ID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

confirmsID

private TrackingID confirmsID

totalSize

private long totalSize

itemLabel

private ShippingLabel itemLabel

receiptLabel

private ShippingLabel receiptLabel

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

versionID

private static final String versionID

See Also:

Constant Field Values

Constructor Detail

Receipt

public Receipt()

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

getConfirmsID

public TrackingID getConfirmsID()

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

Supported API: false

Returns:

TrackingID

setConfirmsID

public void setConfirmsID(TrackingID a_ConfirmsID)
                   throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_ConfirmsID -

Throws:

WTPropertyVetoException

confirmsIDValidate

private void confirmsIDValidate(TrackingID a_ConfirmsID)
                         throws WTPropertyVetoException

Parameters:

a_ConfirmsID -

Throws:

WTPropertyVetoException

newReceipt

protected static Receipt newReceipt()
                             throws WTException

Supported API: false

Returns:

Receipt

Throws:

WTException

getTotalSize

protected long getTotalSize()

Gets the value of the attribute: TOTAL_SIZE.

Supported API: false

Returns:

long

setTotalSize

protected void setTotalSize(long a_TotalSize)
                     throws WTPropertyVetoException

Sets the value of the attribute: TOTAL_SIZE.

Supported API: false

Parameters:

a_TotalSize -

Throws:

WTPropertyVetoException

getItemLabel

public ShippingLabel getItemLabel()

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

Supported API: false

Specified by:

getItemLabel in interface ShippingItem

Returns:

ShippingLabel

setItemLabel

public void setItemLabel(ShippingLabel a_ItemLabel)
                  throws WTPropertyVetoException

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

Supported API: false

Specified by:

setItemLabel in interface ShippingItem

Parameters:

a_ItemLabel -

Throws:

WTPropertyVetoException

itemLabelValidate

private void itemLabelValidate(ShippingLabel a_ItemLabel)
                        throws WTPropertyVetoException

Parameters:

a_ItemLabel -

Throws:

WTPropertyVetoException

getReceiptLabel

public ShippingLabel getReceiptLabel()

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

Supported API: false

Specified by:

getReceiptLabel in interface ShippingItem

Returns:

ShippingLabel

setReceiptLabel

public void setReceiptLabel(ShippingLabel a_ReceiptLabel)
                     throws WTPropertyVetoException

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

Supported API: false

Specified by:

setReceiptLabel in interface ShippingItem

Parameters:

a_ReceiptLabel -

Throws:

WTPropertyVetoException

receiptLabelValidate

private void receiptLabelValidate(ShippingLabel a_ReceiptLabel)
                           throws WTPropertyVetoException

Parameters:

a_ReceiptLabel -

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