wt.wrmf.delivery
Class PayloadShippingItem

java.lang.Object
  extended bywt.fc.WTObject
      extended bywt.wrmf.delivery.ConfirmableShippingItem
          extended bywt.wrmf.delivery.ActionShippingItem
              extended bywt.wrmf.delivery.PayloadShippingItem
All Implemented Interfaces:
ActionCarrier, DisplayIdentification, Externalizable, NetFactor, ObjectMappable, PayloadCarrier, Persistable, PipeActionCarrier, Serializable, ShippingItem

public class PayloadShippingItem
extends ActionShippingItem
implements PayloadCarrier, Externalizable

Use the newPayloadShippingItem static factory method(s), not the PayloadShippingItem 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 long EXTERNALIZATION_VERSION_UID
           
protected static long OLD_FORMAT_VERSION_UID
           
private  PayloadInputStreamDesc payload
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
private static String versionID
           
 
Fields inherited from class wt.wrmf.delivery.ActionShippingItem
 
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.PayloadCarrier
PAYLOAD
 
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
PayloadShippingItem()
           
 
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.
 String getConceptualClassname()
          Deprecated.  
 PayloadInputStreamDesc getPayload()
          Gets the value of the attribute: PAYLOAD.
 int hashCode()
          Returns a hash code for this object based upon its ObjectIdentifier.
protected static PayloadShippingItem newPayloadShippingItem()
          

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(PayloadShippingItem thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setPayload(PayloadInputStreamDesc a_Payload)
          Sets the value of the attribute: PAYLOAD.
 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.ActionShippingItem
getDesc, getPipeDesc, newActionShippingItem, readVersion, setDesc, setPipeDesc
 
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

payload

private PayloadInputStreamDesc payload

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

PayloadShippingItem

public PayloadShippingItem()
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 ActionShippingItem
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 ActionShippingItem
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

protected boolean readVersion(PayloadShippingItem 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 ActionShippingItem
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 ActionShippingItem
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 ActionShippingItem
Returns:
String

newPayloadShippingItem

protected static PayloadShippingItem newPayloadShippingItem()
                                                     throws WTException


Supported API: false

Returns:
PayloadShippingItem
Throws:
WTException

getPayload

public PayloadInputStreamDesc getPayload()
Gets the value of the attribute: PAYLOAD.

Supported API: false

Specified by:
getPayload in interface PayloadCarrier
Returns:
PayloadInputStreamDesc

setPayload

public void setPayload(PayloadInputStreamDesc a_Payload)
                throws WTPropertyVetoException
Sets the value of the attribute: PAYLOAD.

Supported API: false

Specified by:
setPayload in interface PayloadCarrier
Parameters:
a_Payload -
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 ActionShippingItem
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 ActionShippingItem
Returns:
int