com.dpslink.notification.api.param

Class FSecurityProfile

java.lang.Object

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

com.dpslink.notification.api.param.FSecurityProfile

All Implemented Interfaces:

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

public class FSecurityProfile
extends APIParam<FSecurityProfile>

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

Method Summary

Modifier and Type	Method and Description
boolean	getAllowAcctAccess() Returns the allow access to account flag.
boolean	getAllowAddToCart() Returns the allow add to cart flag.
boolean	getAllowAddToFavorites() Returns the allow add to favorites flag.
boolean	getAllowBuyFromCart() Returns the allow buy from cart flag.
boolean	getAllowCheckOut() Returns the allow check out flag.
boolean	getAllowCreateQuotes() Returns the allow quote creation flag.
boolean	getAllowEditBillto() Returns the allow editing of billing information flag.
boolean	getAllowEditContact() Returns the allow editing of contact information flag.
boolean	getAllowEditCrCard() Returns the allow editing of credit card information flag.
boolean	getAllowEditLogon() Returns the allow editing of logon information flag.
boolean	getAllowEditShipto() Returns the allow editing of shipping information flag.
boolean	getAllowInvoiceHistory() Returns the allow user to access invoice history flag.
boolean	getAllowOrderHistory() Returns the allow user to access order history flag.
boolean	getAllowPlaceOrders() Returns the allow placing orders flag.
boolean	getAllowPriceOverride() Returns the allow price overrides flag.
boolean	getBuyFromFavoritesOnly() Returns the allow user to buy from favorites only flag.
java.lang.String	getCode() Returns the unique code for the profile.
java.lang.String	getDescription() Returns the description.
boolean	getDisplayNegativeWhseQtys() Returns the display negative warehouse quantities flag.
boolean	getDisplayWhseQtys() Returns the display warehouse quantities flag.
java.lang.String	getSettings() Returns the concatenated string of settings (Y/N).
protected boolean	getSettingsFlag(int index) Returns the settings flag at the given index.
boolean	getShowNoPrices() Returns the don't show prices flag.
boolean	getShowNoQuantities() Returns the don't show available quantities flag.
protected void	removeUnwantedFields() Removes unwanted fields from a JSON object or from an array of JSON objects.
void	setAllowAcctAccess(boolean allow) Sets the allow access to account flag.
void	setAllowAddToCart(boolean allow) Sets the allow add to cart flag.
void	setAllowAddToFavorites(boolean allow) Sets the allow add to favorites flag.
void	setAllowCreateQuotes(boolean allow) Sets the allow quote creation flag.
void	setAllowEditBillto(boolean allow) Sets the allow editing of billing information flag.
void	setAllowEditContact(boolean allow) Sets the allow editing of contact information flag.
void	setAllowEditCrCard(boolean allow) Sets the allow editing of credit card information flag.
void	setAllowEditLogon(boolean allow) Sets the allow editing of logon information flag.
void	setAllowEditShipto(boolean allow) Sets the allow editing of shipping information flag.
void	setAllowInvoiceHistory(boolean allow) Sets the allow user to access invoice history flag.
void	setAllowOrderHistory(boolean allow) Sets the allow user to access order history flag.
void	setAllowPlaceOrders(boolean allow) Sets the allow placing orders flag.
void	setAllowPriceOverride(boolean allow) Sets the allow price overrides flag.
void	setBuyFromFavoritesOnly(boolean allow) Sets the allow user to buy from favorites only flag.
void	setCode(java.lang.String value) Sets the unique code for the profile.
void	setDescription(java.lang.String value) Sets the description.
void	setDisplayNegativeWhseQtys(boolean display) Sets the display negative warehouse quantities flag.
void	setDisplayWhseQtys(boolean display) Sets the display warehouse quantities flag.
void	setSettings(java.lang.String value) Sets the concatenated string of settings (Y/N).
protected void	setSettingsFlag(boolean flag, int index) Sets the settings flag at the given index.
void	setShowNoPrices(boolean noprices) Sets the don't show prices flag.
void	setShowNoQuantities(boolean noqtys) Sets the don't show available quantities 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

FSecurityProfile

public FSecurityProfile()

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

FSecurityProfile

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

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

Parameters:

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

FSecurityProfile

public FSecurityProfile(java.lang.String source)

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

getCode

public java.lang.String getCode()

Returns the unique code for the profile.

Returns:

String - The unique code for the profile.

setCode

public void setCode(java.lang.String value)

Sets the unique code for the profile.

Parameters:

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

getDescription

public java.lang.String getDescription()

Returns the description.

Returns:

String - The description.

setDescription

public void setDescription(java.lang.String value)

Sets the description.

Parameters:

value - (String) The description.

getSettings

public java.lang.String getSettings()

Returns the concatenated string of settings (Y/N).

Returns:

String - The concatenated string of settings (Y/N).

setSettings

public void setSettings(java.lang.String value)

Sets the concatenated string of settings (Y/N).

Parameters:

value - (String) The concatenated string of settings (Y/N).

getSettingsFlag

protected boolean getSettingsFlag(int index)

Returns the settings flag at the given index.

Parameters:

index - (int) The index of the flag to return.

Returns:

boolean - The flag at the specified index or false if a flag for the index does not exist.

setSettingsFlag

protected void setSettingsFlag(boolean flag,
                               int index)

Sets the settings flag at the given index. Auto-increases the size of the settings flags when the given index exceeds the current size.

Parameters:

flag - (boolean) The flag to set.

index - (int) The index of the flag to set.

getAllowPlaceOrders

public boolean getAllowPlaceOrders()

Returns the allow placing orders flag.

Returns:

boolean - The allow placing orders flag.

setAllowPlaceOrders

public void setAllowPlaceOrders(boolean allow)

Sets the allow placing orders flag.

Parameters:

allow - (boolean) The allow placing orders flag.

getAllowCreateQuotes

public boolean getAllowCreateQuotes()

Returns the allow quote creation flag.

Returns:

boolean - The allow quote creation flag.

setAllowCreateQuotes

public void setAllowCreateQuotes(boolean allow)

Sets the allow quote creation flag.

Parameters:

allow - (boolean) The allow quote creation flag.

getAllowAcctAccess

public boolean getAllowAcctAccess()

Returns the allow access to account flag.

Returns:

boolean - The allow access to account flag.

setAllowAcctAccess

public void setAllowAcctAccess(boolean allow)

Sets the allow access to account flag.

Parameters:

allow - (boolean) The allow access to account flag.

getAllowEditBillto

public boolean getAllowEditBillto()

Returns the allow editing of billing information flag.

Returns:

boolean - The allow editing of billing information flag.

setAllowEditBillto

public void setAllowEditBillto(boolean allow)

Sets the allow editing of billing information flag.

Parameters:

allow - (boolean) The allow editing of billing information flag.

getAllowEditShipto

public boolean getAllowEditShipto()

Returns the allow editing of shipping information flag.

Returns:

boolean - The allow editing of shipping information flag.

setAllowEditShipto

public void setAllowEditShipto(boolean allow)

Sets the allow editing of shipping information flag.

Parameters:

allow - (boolean) The editing of shipping information flag.

getAllowEditContact

public boolean getAllowEditContact()

Returns the allow editing of contact information flag.

Returns:

boolean - The allow editing of contact information flag.

setAllowEditContact

public void setAllowEditContact(boolean allow)

Sets the allow editing of contact information flag.

Parameters:

allow - (boolean) The editing of contact information flag.

getAllowEditLogon

public boolean getAllowEditLogon()

Returns the allow editing of logon information flag.

Returns:

boolean - The allow editing of logon information flag.

setAllowEditLogon

public void setAllowEditLogon(boolean allow)

Sets the allow editing of logon information flag.

Parameters:

allow - (boolean) The editing of logon information flag.

getAllowEditCrCard

public boolean getAllowEditCrCard()

Returns the allow editing of credit card information flag.

Returns:

boolean - The allow editing of credit card information flag.

setAllowEditCrCard

public void setAllowEditCrCard(boolean allow)

Sets the allow editing of credit card information flag.

Parameters:

allow - (boolean) The editing of credit card information flag.

getAllowPriceOverride

public boolean getAllowPriceOverride()

Returns the allow price overrides flag.

Returns:

boolean - The allow price overrides flag.

setAllowPriceOverride

public void setAllowPriceOverride(boolean allow)

Sets the allow price overrides flag.

Parameters:

allow - (boolean) The allow price overrides flag.

getAllowAddToCart

public boolean getAllowAddToCart()

Returns the allow add to cart flag.

Returns:

boolean - The allow add to cart flag.

setAllowAddToCart

public void setAllowAddToCart(boolean allow)

Sets the allow add to cart flag.

Parameters:

allow - (boolean) The allow add to cart flag.

getAllowAddToFavorites

public boolean getAllowAddToFavorites()

Returns the allow add to favorites flag.

Returns:

boolean - The allow add to favorites flag.

setAllowAddToFavorites

public void setAllowAddToFavorites(boolean allow)

Sets the allow add to favorites flag.

Parameters:

allow - (boolean) The allow add to favorites flag.

getDisplayWhseQtys

public boolean getDisplayWhseQtys()

Returns the display warehouse quantities flag.

Returns:

boolean - The display warehouse quantities flag.

setDisplayWhseQtys

public void setDisplayWhseQtys(boolean display)

Sets the display warehouse quantities flag.

Parameters:

display - (boolean) The display warehouse quantities flag.

getDisplayNegativeWhseQtys

public boolean getDisplayNegativeWhseQtys()

Returns the display negative warehouse quantities flag.

Returns:

boolean - The display negative warehouse quantities flag.

setDisplayNegativeWhseQtys

public void setDisplayNegativeWhseQtys(boolean display)

Sets the display negative warehouse quantities flag.

Parameters:

display - (boolean) The display negative warehouse quantities flag.

getShowNoPrices

public boolean getShowNoPrices()

Returns the don't show prices flag.

Returns:

boolean - The don't show prices flag.

setShowNoPrices

public void setShowNoPrices(boolean noprices)

Sets the don't show prices flag.

Parameters:

noprices - (boolean) The don't show prices flag.

getBuyFromFavoritesOnly

public boolean getBuyFromFavoritesOnly()

Returns the allow user to buy from favorites only flag.

Returns:

boolean - The allow user to buy from favorites only flag.

setBuyFromFavoritesOnly

public void setBuyFromFavoritesOnly(boolean allow)

Sets the allow user to buy from favorites only flag.

Parameters:

allow - (boolean) The allow user to buy from favorites only flag.

getAllowOrderHistory

public boolean getAllowOrderHistory()

Returns the allow user to access order history flag.

Returns:

boolean - The allow user to access order history flag.

setAllowOrderHistory

public void setAllowOrderHistory(boolean allow)

Sets the allow user to access order history flag.

Parameters:

allow - (boolean) The allow user to access order history flag.

getAllowInvoiceHistory

public boolean getAllowInvoiceHistory()

Returns the allow user to access invoice history flag.

Returns:

boolean - The allow user to access invoice history flag.

setAllowInvoiceHistory

public void setAllowInvoiceHistory(boolean allow)

Sets the allow user to access invoice history flag.

Parameters:

allow - (boolean) The allow user to access invoice history flag.

getShowNoQuantities

public boolean getShowNoQuantities()

Returns the don't show available quantities flag.

Returns:

boolean - The don't show available quantities flag.

setShowNoQuantities

public void setShowNoQuantities(boolean noqtys)

Sets the don't show available quantities flag.

Parameters:

noqtys - (boolean) The don't show available quantities flag.

getAllowBuyFromCart

public boolean getAllowBuyFromCart()

Returns the allow buy from cart flag. The returned flag is the result of getAllowAddToCart() && !getBuyFromFavoritesOnly().

Returns:

boolean - The allow check out flag.

getAllowCheckOut

public boolean getAllowCheckOut()

Returns the allow check out flag. The returned flag is the result of getAllowPlaceOrder() || getAllowCreateQuote().

Returns:

boolean - The allow buy from cart flag.