wt.wrmf.delivery
Class Outbox

java.lang.Object
  wt.fc.WTObject
      wt.wrmf.delivery.TransportBox
          wt.wrmf.delivery.Outbox

All Implemented Interfaces:

DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

Direct Known Subclasses:

PerDestinationOutbox, TransparentOutbox

public abstract class Outbox

extends TransportBox

implements Externalizable

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static int	ATTEMPT_WAIT
private static int	ATTEMPTS
private static String	CLASSNAME
protected static boolean	DELETE_DELIVERED_ITEM
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static long	startSendManifestToNetwork

Fields inherited from class wt.wrmf.delivery.TransportBox

NAME, VERBOSE

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

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

Outbox()

Method Summary

private void	deleteDeliveredItems(ConfirmableShippingItem csi)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
abstract ShippingItem	get(SiteAddress to) Supported API: false
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
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(Outbox thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
abstract Object	send(ShippingItem obj) If DIRECT return type for IMMEDIATE send mode is requested (as in ShippingLabel) for the ShippingItem, the InputStream from remote side will be returned; otherwise null or TrackingID will be returned.
private InputStream	send0(ShippingItem obj, SiteAddress to, TransportType transport)
InputStream	sendToGTS(ShippingItem obj, Outbox outbox) If return type of DIRECT is requested, the InputStream from remote side will be returned directly; otherwise INDIRECT return type) the InputStream will be executed and null will be returned.
protected void	updateStatusToSending(ShippingItem obj)
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.TransportBox

getName, readVersion, setName

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.NetFactor

getConceptualClassname

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

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

ATTEMPTS

private static final int ATTEMPTS

ATTEMPT_WAIT

private static final int ATTEMPT_WAIT

DELETE_DELIVERED_ITEM

protected static boolean DELETE_DELIVERED_ITEM

startSendManifestToNetwork

public static long startSendManifestToNetwork

Constructor Detail

Outbox

public Outbox()

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 TransportBox

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 TransportBox

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(Outbox 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 TransportBox

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 TransportBox

Parameters:

input -

Throws:

SQLException

DatastoreException

send

public abstract Object send(ShippingItem obj)
                     throws WTDeliveryException

If DIRECT return type for IMMEDIATE send mode is requested (as in ShippingLabel) for the ShippingItem, the InputStream from remote side will be returned; otherwise null or TrackingID will be returned. Problems sending are indicated by throwing WTDeliveryException.

Supported API: false

Parameters:

obj -

Returns:

Object

Throws:

WTDeliveryException

get

public abstract ShippingItem get(SiteAddress to)

Supported API: false

Parameters:

to -

Returns:

ShippingItem

sendToGTS

public InputStream sendToGTS(ShippingItem obj,
                             Outbox outbox)
                      throws WTDeliveryException

If return type of DIRECT is requested, the InputStream from remote side will be returned directly; otherwise INDIRECT return type) the InputStream will be executed and null will be returned.

Supported API: false

Parameters:

obj -

outbox -

Returns:

InputStream

Throws:

WTDeliveryException

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 TransportBox

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 TransportBox

Returns:

int

send0

private InputStream send0(ShippingItem obj,
                          SiteAddress to,
                          TransportType transport)
                   throws IOException,
                          WTException

Throws:

IOException

WTException

updateStatusToSending

protected void updateStatusToSending(ShippingItem obj)
                              throws WTException

Throws:

WTException

deleteDeliveredItems

private void deleteDeliveredItems(ConfirmableShippingItem csi)