com.dpslink.notification.api.param

Class FShipper

java.lang.Object

com.dpslink.notification.api.param.APIParam<FShipper>

com.dpslink.notification.api.param.FShipper

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FShipper>

public class FShipper
extends APIParam<FShipper>

Defines the fields and methods for a Flash shipper API parameter object.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID The class' serialization version id.

Fields inherited from class com.dpslink.notification.api.param.APIParam

ivHashCode, ivHashFlds, ivObjFlds

Constructor Summary

Constructors

Constructor and Description
FShipper() Constructs a FShipper object with all field values set to null.
FShipper(java.util.HashMap<java.lang.String,java.lang.Object> source) Constructs a FShipper object with field values based on the supplied hash map.
FShipper(java.lang.String source) Constructs a FShipper object with field values based on the supplied JSON text string.

Method Summary

Modifier and Type	Method and Description
boolean	getAllCountries() Returns the is valid for all countries flag.
java.lang.String	getCode() Returns the unique code for the shipper.
java.lang.String	getName() Returns the description.
java.lang.String	getSeqCode() Returns the sort sequence code.
boolean	getShowTracking() Returns the show tracking numbers flag.
java.lang.String	getTrackingURL() Returns the url for shipper web site tracking page.
java.lang.String	getType() Returns the type code (C=commercial, R=residential, B=both).
boolean	getValid() Returns the is valid for check out flag.
protected void	removeUnwantedFields() Removes unwanted fields from a JSON object or from an array of JSON objects.
void	setAllCountries(boolean value) Sets the is valid for all countries flag.
void	setCode(java.lang.String value) Sets the unique code for the shipper.
void	setName(java.lang.String value) Sets the description.
void	setSeqCode(java.lang.String value) Sets the sort sequence code.
void	setShowTracking(boolean value) Sets the show tracking numbers flag.
void	setTrackingURL(java.lang.String value) Sets the url for shipper web site tracking page.
void	setType(java.lang.String value) Sets the type code (C=commercial, R=residential, B=both).
void	setValid(boolean value) Sets the is valid for check out flag.

Methods inherited from class com.dpslink.notification.api.param.APIParam

after, before, compareTo, equals, getHashFields, getObjectFields, hashCode, removeStringWhitespace, removeUnwantedFields, setHashFields, setObjectFields, toJSONString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

Constructor Detail

FShipper

public FShipper()

Constructs a FShipper object with all field values set to null.

FShipper

public FShipper(java.util.HashMap<java.lang.String,java.lang.Object> source)

Constructs a FShipper object with field values based on the supplied hash map.

Parameters:

source - (HashMap) A hash map of field names and values.

FShipper

public FShipper(java.lang.String source)

Constructs a FShipper object with field values based on the supplied JSON text string.

Parameters:

source - (String) A string beginning with { (left brace) and ending with } (right brace).

Method Detail

removeUnwantedFields

protected void removeUnwantedFields()

Removes unwanted fields from a JSON object or from an array of JSON objects. Automatically invoked by the constructors.

Specified by:

removeUnwantedFields in class APIParam<FShipper>

getCode

public java.lang.String getCode()

Returns the unique code for the shipper.

Returns:

String - The unique code for the shipper.

setCode

public void setCode(java.lang.String value)

Sets the unique code for the shipper.

Parameters:

value - (String) The unique code for the shipper.

getName

public java.lang.String getName()

Returns the description.

Returns:

String - The description.

setName

public void setName(java.lang.String value)

Sets the description.

Parameters:

value - (String) The description.

getTrackingURL

public java.lang.String getTrackingURL()

Returns the url for shipper web site tracking page.

Returns:

String - The url for shipper web site tracking page.

setTrackingURL

public void setTrackingURL(java.lang.String value)

Sets the url for shipper web site tracking page.

Parameters:

value - (String) The url for shipper web site tracking page.

getShowTracking

public boolean getShowTracking()

Returns the show tracking numbers flag.

Returns:

boolean - The show tracking numbers flag.

setShowTracking

public void setShowTracking(boolean value)

Sets the show tracking numbers flag.

Parameters:

value - (boolean) The show tracking numbers flag.

getSeqCode

public java.lang.String getSeqCode()

Returns the sort sequence code.

Returns:

String - The sort sequence code.

setSeqCode

public void setSeqCode(java.lang.String value)

Sets the sort sequence code.

Parameters:

value - (String) The sort sequence code.

getValid

public boolean getValid()

Returns the is valid for check out flag.

Returns:

boolean - The is valid for check out flag.

setValid

public void setValid(boolean value)

Sets the is valid for check out flag.

Parameters:

value - (boolean) The is valid for check out flag.

getType

public java.lang.String getType()

Returns the type code (C=commercial, R=residential, B=both).

Returns:

String - The type code.

setType

public void setType(java.lang.String value)

Sets the type code (C=commercial, R=residential, B=both).

Parameters:

value - (String) The type code.

getAllCountries

public boolean getAllCountries()

Returns the is valid for all countries flag.

Returns:

boolean - The is valid for all countries flag.

setAllCountries

public void setAllCountries(boolean value)

Sets the is valid for all countries flag.

Parameters:

value - (boolean) The is valid for all countries flag.