wt.wrmf.delivery
Class PersistentInbox

java.lang.Object
  wt.fc.WTObject
      wt.wrmf.delivery.TransportBox
          wt.wrmf.delivery.Inbox
              wt.wrmf.delivery.PersistentInbox

All Implemented Interfaces:

DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class PersistentInbox

extends Inbox

implements Externalizable

Use the newPersistentInbox static factory method(s), not the PersistentInbox 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 static String	RESOURCE
(package private) static long	serialVersionUID

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

PersistentInbox()

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.
static void	executeBackItem(ObjectReference objRef, InputStream is) This static method is the method called in ProcessingQueue.
static void	executeItem(ObjectReference objRef, InputStream is) This static method is the method called in ProcessingQueue.
String	getConceptualClassname() Deprecated.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
static PersistentInbox	newPersistentInbox() Default factory for the class.
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(PersistentInbox thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
Receipt	receive(ShippingItem obj, InputStream is) Returns the Receipt if accepted.
Object	receiveFeedBack(ShippingItem obj, InputStream is) This method is called at the sender's (Shipping) side.
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.Inbox

readVersion

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

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

Constructor Detail

PersistentInbox

public PersistentInbox()

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 Inbox

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 Inbox

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(PersistentInbox 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 Inbox

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 Inbox

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

executeItem

public static void executeItem(ObjectReference objRef,
                               InputStream is)
                        throws WTDeliveryException

This static method is the method called in ProcessingQueue. This is called at the receiver's side.

Supported API: false

Parameters:

objRef -

is -

Throws:

WTDeliveryException

executeBackItem

public static void executeBackItem(ObjectReference objRef,
                                   InputStream is)
                            throws WTDeliveryException

This static method is the method called in ProcessingQueue. This method is called at the sender's (shipping) side.

Supported API: false

Parameters:

objRef -

is -

Throws:

WTDeliveryException

newPersistentInbox

public static PersistentInbox newPersistentInbox()
                                          throws WTException

Default factory for the class.

Supported API: false

Returns:

PersistentInbox

Throws:

WTException

receive

public Receipt receive(ShippingItem obj,
                       InputStream is)
                throws WTDeliveryException

Returns the Receipt if accepted. Throws WTDeliceryException otherwise. Stores for further processing or processes immedieately by asking the Receiver service to execute the method from the desc. The result object is discarded. (The immediate mode should not use the inbox at all).

Supported API: false

Specified by:

receive in class Inbox

Parameters:

obj -

is -

Returns:

Receipt

Throws:

WTDeliveryException

receiveFeedBack

public Object receiveFeedBack(ShippingItem obj,
                              InputStream is)
                       throws WTDeliveryException

This method is called at the sender's (Shipping) side. Wrap exceptions to WTDeliceryException. Stores for further processing or processes immedieately by asking the Receiver service to execute the method from the desc. The result object is discarded. (The immediate mode should not use the inbox at all).

Supported API: false

Specified by:

receiveFeedBack in class Inbox

Parameters:

obj -

is -

Returns:

Object

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 Inbox

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 Inbox

Returns:

int