wt.wrmf.delivery
Class ActionShippingItem

java.lang.Object
  wt.fc.WTObject
      wt.wrmf.delivery.ConfirmableShippingItem
          wt.wrmf.delivery.ActionShippingItem

All Implemented Interfaces:

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

Direct Known Subclasses:

ActionPullItem, PayloadShippingItem

public class ActionShippingItem

extends ConfirmableShippingItem

implements ActionCarrier, PipeActionCarrier, Externalizable

Use the newActionShippingItem static factory method(s), not the ActionShippingItem 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 MethodInvocationDesc	desc
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private MethodInvocationDesc	pipeDesc
private static String	RESOURCE
(package private) static long	serialVersionUID
private static String	versionID

Fields inherited from class wt.wrmf.delivery.ConfirmableShippingItem

ID, STATUS

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.wrmf.delivery.ActionCarrier

DESC

Fields inherited from interface wt.wrmf.delivery.PipeActionCarrier

PIPE_DESC

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

ActionShippingItem()

Method Summary

private void	descValidate(MethodInvocationDesc a_Desc)
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.
MethodInvocationDesc	getDesc() Gets the object for the association that plays role: DESC.
MethodInvocationDesc	getPipeDesc() Gets the object for the association that plays role: PIPE_DESC.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected static ActionShippingItem	newActionShippingItem() Supported API: false
private void	pipeDescValidate(MethodInvocationDesc a_PipeDesc)
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(ActionShippingItem thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setDesc(MethodInvocationDesc a_Desc) Sets the object for the association that plays role: DESC.
void	setPipeDesc(MethodInvocationDesc a_PipeDesc) Sets the object for the association that plays role: PIPE_DESC.
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.wrmf.delivery.ConfirmableShippingItem

getId, getItemLabel, getReceiptLabel, getStatus, getTotalSize, newConfirmableShippingItem, readVersion, setId, setItemLabel, setReceiptLabel, setStatus, setTotalSize

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

desc

private MethodInvocationDesc desc

pipeDesc

private MethodInvocationDesc pipeDesc

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

ActionShippingItem

public ActionShippingItem()

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 ConfirmableShippingItem

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 ConfirmableShippingItem

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(ActionShippingItem 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 ConfirmableShippingItem

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 ConfirmableShippingItem

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

Overrides:

getConceptualClassname in class ConfirmableShippingItem

Returns:

String

newActionShippingItem

protected static ActionShippingItem newActionShippingItem()
                                                   throws WTException

Supported API: false

Returns:

ActionShippingItem

Throws:

WTException

getDesc

public MethodInvocationDesc getDesc()

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

Supported API: false

Specified by:

getDesc in interface ActionCarrier

Returns:

MethodInvocationDesc

setDesc

public void setDesc(MethodInvocationDesc a_Desc)
             throws WTPropertyVetoException

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

Supported API: false

Specified by:

setDesc in interface ActionCarrier

Parameters:

a_Desc -

Throws:

WTPropertyVetoException

descValidate

private void descValidate(MethodInvocationDesc a_Desc)
                   throws WTPropertyVetoException

Parameters:

a_Desc -

Throws:

WTPropertyVetoException

getPipeDesc

public MethodInvocationDesc getPipeDesc()

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

Supported API: false

Specified by:

getPipeDesc in interface PipeActionCarrier

Returns:

MethodInvocationDesc

setPipeDesc

public void setPipeDesc(MethodInvocationDesc a_PipeDesc)
                 throws WTPropertyVetoException

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

Supported API: false

Specified by:

setPipeDesc in interface PipeActionCarrier

Parameters:

a_PipeDesc -

Throws:

WTPropertyVetoException

pipeDescValidate

private void pipeDescValidate(MethodInvocationDesc a_PipeDesc)
                       throws WTPropertyVetoException

Parameters:

a_PipeDesc -

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 ConfirmableShippingItem

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 ConfirmableShippingItem

Returns:

int