com.dpslink.notification.api.param

Class FRestockNotification

java.lang.Object

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

com.dpslink.notification.api.param.FRestockNotification

All Implemented Interfaces:

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

public class FRestockNotification
extends APIParam<FRestockNotification>

Defines the fields and methods for a Flash restock notification 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
FRestockNotification() Constructs a FRestockNotification object with all field values set to null.
FRestockNotification(java.util.HashMap<java.lang.String,java.lang.Object> source) Constructs a FRestockNotification object with field values based on the supplied hash map.
FRestockNotification(java.lang.String source) Constructs a FRestockNotification object with field values based on the supplied JSON text string.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAvailableQty() Returns the product's available quantity.
java.lang.String	getDateAsked() Returns the time when request was submitted.
java.lang.String	getDateNotified() Returns the time when notification was issued.
java.lang.String	getDescription() Returns the product's description.
java.lang.String	getEmailAddr() Returns the notification email address.
java.lang.String	getLowQty() Returns the associated product's (or product's category) low quantity value.
java.lang.String	getOutQty() Returns the product's (or product's category) out quantity value.
java.lang.String	getProductCode() Returns the product code.
java.lang.String	getType() Returns the notification type.
java.lang.String	getUomCode() Returns the product unit of measure code.
java.lang.String	getUserId() Returns the id of user who submitted the request.
protected void	removeUnwantedFields() Removes unwanted fields from a JSON object or from an array of JSON objects.
void	setAvailableQty(java.lang.String value) Sets the product's available quantity.
void	setDateAsked(java.lang.String value) Sets the time when request was submitted.
void	setDateNotified(java.lang.String value) Sets the time when notification was issued.
void	setDescription(java.lang.String value) Sets the product's description.
void	setEmailAddr(java.lang.String value) Sets the notification email address.
void	setLowQty(java.lang.String value) Sets the product's (or product's category) low quantity value.
void	setOutQty(java.lang.String value) Sets the product's (or product's category) out quantity value.
void	setProductCode(java.lang.String value) Sets the product code.
void	setType(java.lang.String value) Sets the notification type.
void	setUomCode(java.lang.String value) Sets the product unit of measure code.
void	setUserId(java.lang.String value) Sets the id of user who submitted the request.

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

FRestockNotification

public FRestockNotification()

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

FRestockNotification

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

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

Parameters:

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

FRestockNotification

public FRestockNotification(java.lang.String source)

Constructs a FRestockNotification 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<FRestockNotification>

getType

public java.lang.String getType()

Returns the notification type.

Returns:

String - The notification type.

setType

public void setType(java.lang.String value)

Sets the notification type.

Parameters:

value - (String) The notification type.

getProductCode

public java.lang.String getProductCode()

Returns the product code.

Returns:

String - The product code.

setProductCode

public void setProductCode(java.lang.String value)

Sets the product code.

Parameters:

value - (String) The product code.

getUomCode

public java.lang.String getUomCode()

Returns the product unit of measure code.

Returns:

String - The product unit of measure code.

setUomCode

public void setUomCode(java.lang.String value)

Sets the product unit of measure code.

Parameters:

value - (String) The product unit of measure code.

getEmailAddr

public java.lang.String getEmailAddr()

Returns the notification email address.

Returns:

String - The notification email address.

setEmailAddr

public void setEmailAddr(java.lang.String value)

Sets the notification email address.

Parameters:

value - (String) The notification email address.

getUserId

public java.lang.String getUserId()

Returns the id of user who submitted the request.

Returns:

String - The id of user who submitted the request.

setUserId

public void setUserId(java.lang.String value)

Sets the id of user who submitted the request.

Parameters:

value - (String) The id of user who submitted the request.

getDateAsked

public java.lang.String getDateAsked()

Returns the time when request was submitted.

Returns:

String - The time when request was submitted.

setDateAsked

public void setDateAsked(java.lang.String value)

Sets the time when request was submitted.

Parameters:

value - (String) The time when request was submitted.

getDateNotified

public java.lang.String getDateNotified()

Returns the time when notification was issued.

Returns:

String - The time when notification was issued.

setDateNotified

public void setDateNotified(java.lang.String value)

Sets the time when notification was issued.

Parameters:

value - (String) The time when notification was issued.

getLowQty

public java.lang.String getLowQty()

Returns the associated product's (or product's category) low quantity value.

Returns:

String - The product's (or category's) low quantity value.

setLowQty

public void setLowQty(java.lang.String value)

Sets the product's (or product's category) low quantity value.

Parameters:

value - (String) The product's low quantity value.

getOutQty

public java.lang.String getOutQty()

Returns the product's (or product's category) out quantity value.

Returns:

String - The product's (or category's) out quantity value.

setOutQty

public void setOutQty(java.lang.String value)

Sets the product's (or product's category) out quantity value.

Parameters:

value - (String) The product's out quantity value.

getAvailableQty

public java.lang.String getAvailableQty()

Returns the product's available quantity.

Returns:

String - The product's available quantity.

setAvailableQty

public void setAvailableQty(java.lang.String value)

Sets the product's available quantity.

Parameters:

value - (String) The product's available quantity.

getDescription

public java.lang.String getDescription()

Returns the product's description.

Returns:

String - The product's description.

setDescription

public void setDescription(java.lang.String value)

Sets the product's description.

Parameters:

value - (String) The product's description.