wt.wrmf.delivery
Class ShippingLabel

java.lang.Object
  wt.wrmf.delivery.ShippingLabel

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Serializable

public class ShippingLabel

extends Object

implements ObjectMappable, Externalizable

Use the newShippingLabel static factory method(s), not the ShippingLabel 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
protected static String	DELIVERY_TYPE Label for the attribute.
private int	deliveryType
private SiteAddress	destination
static String	DESTINATION Label for the attribute.
static long	EXTERNALIZATION_VERSION_UID
protected static String	INBOX_ID Label for the attribute.
private static int	INBOX_ID_UPPER_LIMIT
private String	inboxID
protected static long	OLD_FORMAT_VERSION_UID
protected static String	OUTBOX_ID Label for the attribute.
private static int	OUTBOX_ID_UPPER_LIMIT
private String	outboxID
static String	REQUESTED_TRANSPORT_TYPE Label for the attribute.
private TransportType	requestedTransportType
private static String	RESOURCE
static String	RETURN_TYPE Label for the attribute; If ReturnPreference.DIRECT is set, the InputStream from remote site will be returned; otherwise it will be executed within the receiver service in wrmf and null will be returned.
private int	returnType
(package private) static long	serialVersionUID
private static String	versionID

Constructor Summary

ShippingLabel()

Method Summary

private void	destinationValidate(SiteAddress a_Destination)
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
protected int	getDeliveryType() Gets the value of the attribute: DELIVERY_TYPE.
SiteAddress	getDestination() Gets the object for the association that plays role: DESTINATION.
protected String	getInboxID() Gets the value of the attribute: INBOX_ID.
protected String	getOutboxID() Gets the value of the attribute: OUTBOX_ID.
TransportType	getRequestedTransportType() Gets the object for the association that plays role: REQUESTED_TRANSPORT_TYPE.
int	getReturnType() Gets the value of the attribute: RETURN_TYPE.
private void	inboxIDValidate(String a_InboxID)
protected void	initialize() Supports initialization, following construction of an instance.
static ShippingLabel	newShippingLabel() Default factory for the class.
private void	outboxIDValidate(String a_OutboxID)
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(ShippingLabel thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
private void	requestedTransportTypeValidate(TransportType a_RequestedTransportType)
protected void	setDeliveryType(int a_DeliveryType) Sets the value of the attribute: DELIVERY_TYPE.
void	setDestination(SiteAddress a_Destination) Sets the object for the association that plays role: DESTINATION.
protected void	setInboxID(String a_InboxID) Sets the value of the attribute: INBOX_ID.
protected void	setOutboxID(String a_OutboxID) Sets the value of the attribute: OUTBOX_ID.
void	setRequestedTransportType(TransportType a_RequestedTransportType) Sets the object for the association that plays role: REQUESTED_TRANSPORT_TYPE.
void	setReturnType(int a_ReturnType) Sets the value of the attribute: RETURN_TYPE.
String	toString() Returns the conceptual (modeled) name for the class.
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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

DELIVERY_TYPE

protected static final String DELIVERY_TYPE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

deliveryType

private int deliveryType

RETURN_TYPE

public static final String RETURN_TYPE

Label for the attribute; If ReturnPreference.DIRECT is set, the InputStream from remote site will be returned; otherwise it will be executed within the receiver service in wrmf and null will be returned.

Supported API: false

See Also:

Constant Field Values

returnType

private int returnType

INBOX_ID

protected static final String INBOX_ID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

INBOX_ID_UPPER_LIMIT

private static int INBOX_ID_UPPER_LIMIT

inboxID

private String inboxID

OUTBOX_ID

protected static final String OUTBOX_ID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

OUTBOX_ID_UPPER_LIMIT

private static int OUTBOX_ID_UPPER_LIMIT

outboxID

private String outboxID

DESTINATION

public static final String DESTINATION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

destination

private SiteAddress destination

REQUESTED_TRANSPORT_TYPE

public static final String REQUESTED_TRANSPORT_TYPE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

requestedTransportType

private TransportType requestedTransportType

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

ShippingLabel

public ShippingLabel()

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

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

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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

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

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

getDeliveryType

protected int getDeliveryType()

Gets the value of the attribute: DELIVERY_TYPE.

Supported API: false

Returns:

int

setDeliveryType

protected void setDeliveryType(int a_DeliveryType)
                        throws WTPropertyVetoException

Sets the value of the attribute: DELIVERY_TYPE.

Supported API: false

Parameters:

a_DeliveryType -

Throws:

WTPropertyVetoException

getReturnType

public int getReturnType()

Gets the value of the attribute: RETURN_TYPE. If ReturnPreference.DIRECT is set, the InputStream from remote site will be returned; otherwise it will be executed within the receiver service in wrmf and null will be returned.

Supported API: false

Returns:

int

setReturnType

public void setReturnType(int a_ReturnType)
                   throws WTPropertyVetoException

Sets the value of the attribute: RETURN_TYPE. If ReturnPreference.DIRECT is set, the InputStream from remote site will be returned; otherwise it will be executed within the receiver service in wrmf and null will be returned.

Supported API: false

Parameters:

a_ReturnType -

Throws:

WTPropertyVetoException

getInboxID

protected String getInboxID()

Gets the value of the attribute: INBOX_ID.

Supported API: false

Returns:

String

setInboxID

protected void setInboxID(String a_InboxID)
                   throws WTPropertyVetoException

Sets the value of the attribute: INBOX_ID.

Supported API: false

Parameters:

a_InboxID -

Throws:

WTPropertyVetoException

inboxIDValidate

private void inboxIDValidate(String a_InboxID)
                      throws WTPropertyVetoException

Parameters:

a_InboxID -

Throws:

WTPropertyVetoException

getOutboxID

protected String getOutboxID()

Gets the value of the attribute: OUTBOX_ID.

Supported API: false

Returns:

String

setOutboxID

protected void setOutboxID(String a_OutboxID)
                    throws WTPropertyVetoException

Sets the value of the attribute: OUTBOX_ID.

Supported API: false

Parameters:

a_OutboxID -

Throws:

WTPropertyVetoException

outboxIDValidate

private void outboxIDValidate(String a_OutboxID)
                       throws WTPropertyVetoException

Parameters:

a_OutboxID -

Throws:

WTPropertyVetoException

getDestination

public SiteAddress getDestination()

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

Supported API: false

Returns:

SiteAddress

setDestination

public void setDestination(SiteAddress a_Destination)
                    throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_Destination -

Throws:

WTPropertyVetoException

destinationValidate

private void destinationValidate(SiteAddress a_Destination)
                          throws WTPropertyVetoException

Parameters:

a_Destination -

Throws:

WTPropertyVetoException

getRequestedTransportType

public TransportType getRequestedTransportType()

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

Supported API: false

Returns:

TransportType

setRequestedTransportType

public void setRequestedTransportType(TransportType a_RequestedTransportType)
                               throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_RequestedTransportType -

Throws:

WTPropertyVetoException

requestedTransportTypeValidate

private void requestedTransportTypeValidate(TransportType a_RequestedTransportType)
                                     throws WTPropertyVetoException

Parameters:

a_RequestedTransportType -

Throws:

WTPropertyVetoException

newShippingLabel

public static ShippingLabel newShippingLabel()
                                      throws WTException

Default factory for the class.

Supported API: false

Returns:

ShippingLabel

Throws:

WTException

initialize

protected void initialize()
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Throws:

WTException