public class Store extends ModelObject
Modifier and Type | Field and Description |
---|---|
static java.lang.String | B2B
Store type - B2B.
|
static java.lang.String | B2C
Store type - B2C.
|
static java.lang.String | BBB
Store type - BBB (hybrid between B2B and B2C).
|
static java.lang.String | PROP_AVAIL_ORDERCHANGE_REASONS
Constant for the AVAIL_ORDERCHANGE_REASONS property name.
|
static java.lang.String | PROP_AVAIL_RETURN_REASONS
Constant for the quote expiry period property name.
|
static java.lang.String | PROP_BLOCK_REASON_CODES
Constant for the block reason codes property name.
|
static java.lang.String | PROP_CACHED_PRODUCTS
Constant for the cached products property name.
|
static java.lang.String | PROP_CHARGE_TYPES
Constant for the charge types property name.
|
static java.lang.String | PROP_DESCRIPTION
Constant for the description property name.
|
static java.lang.String | PROP_LANGUAGE_ID
Constant for the language ID property name.
|
static java.lang.String | PROP_MEMBER_ID
Constant for the member ID property name.
|
static java.lang.String | PROP_OPEN_CUSTOMERS
Constant for the open customers property name.
|
static java.lang.String | PROP_OPEN_ORGANIZATIONS
Constant for the open organizations property name.
|
static java.lang.String | PROP_OPEN_TICKLERS
Constant for the open ticklers property name.
|
static java.lang.String | PROP_ORDER_BLOCKING_ENABLED
Constant for the order block enabled property name.
|
static java.lang.String | PROP_ORGANIZATION
Constant for the organization property name.
|
static java.lang.String | PROP_OVERRIDE_REASONS
Constant for override reasons.
|
static java.lang.String | PROP_QUOTE_EXPIRY_PERIOD
Constant for the quote expiry period property name.
|
static java.lang.String | PROP_QUOTE_MAX_EXPIRY_PERIOD
Constant for the floor value of the quote expiry period.
|
static java.lang.String | PROP_ROLES
Constant for the roles property name.
|
static java.lang.String | PROP_SHIPPING_MODES
Constant for the shipping modes property name.
|
static java.lang.String | PROP_STORE_ID
Constant for the store ID property name.
|
static java.lang.String | PROP_STORE_INVENTORY_SYSTEM
Constant for the inventory system property name.
|
static java.lang.String | PROP_SUPPORTED_CURRENCIES
Constant for the supported currencies property name.
|
static java.lang.String | PROP_SUPPORTED_LANGUAGES
Constant for the supported languages property name.
|
static java.lang.String | PROP_TICKLER_ACTION_CODES
Constant for the tickler action codes property name.
|
static java.lang.String | PROP_TICKLER_REASON_CODES
Constant for the tickler reason codes property name.
|
static java.lang.String | PROP_TYPE
Constant for the type property name.
|
Constructor and Description |
---|
Store()
Constructor for Store.
|
Modifier and Type | Method and Description |
---|---|
void | addBlockReasonCodes(BlockReasonCode blockReasonCode)
This method is a convenience method for updating the "blockReasonCodes" property.
|
void | addCachedProduct(Product product)
This method is a convenience method for updating the cachedProducts property.
|
void | addChargeType(ChargeType type)
This method is a convenience method for updating the "chargeTypes" property.
|
void | addCurrency(Currency currency)
This method is a convenience method for updating the "supportedCurrencies" property.
|
void | addOpenCustomer(Customer customer)
This method is a convenience method for updating the "openCustomers" property.
|
void | addOpenOrganization(Organization organization)
This is a convenience method for updating the PROP_OPEN_ORGANIZATIONS property.
|
void | addOpenTickler(Tickler tickler)
This method is a convenience method for updating the "openTicklers" property.
|
void | addOrderChangeReason(java.lang.String reasonId, java.lang.String reasonDesc)
This method is adds reasons to the HashMap contained in the "orderChangeReasons" property.
|
void | addOverrideReason(OverrideReason reason)
This method is a convenience method for updating the "overrideReasons" property.
|
void | addReturnReason(java.lang.String reasonCode, java.lang.String reasonDesc)
This method is adds reasons to the HashMap contained in the "returnReasons" property.
|
void | addRole(Role role)
This method is a convenience method for updating the "roles" property.
|
void | addShippingMode(ShippingMode mode)
This method is a convenience method for updating the "shippingModes" property.
|
void | addSupportedLanguage(java.lang.String langId)
This method is a convenience method for updating the "supportedLanguages" property.
|
void | addTicklerActionCode(TicklerActionCode actionCode)
This method is a convenience method for updating the "ticklerActionCode" property.
|
void | addTicklerReasonCode(TicklerReasonCode reasonCode)
This method is a convenience method for updating the "ticklerReasonCode" property.
|
void | clearProductCache()
This method is a convenience method for updating the cachedProducts property.
|
void | closeOpenCustomer(Customer customer)
This method is a convenience method for updating the "openCustomers" property.
|
void | closeOpenCustomers()
This method is a convenience method for updating the "openCustomers" property.
|
void | closeOpenOrganization(Organization organization)
This is a convenience method for updating the PROP_OPEN_ORGANIZATIONS property.
|
void | closeOpenOrganizations()
This is a convenience method for updating the PROP_OPEN_ORGANIZATIONS property.
|
void | closeOpenTickler(Tickler tickler)
This method is a convenience method for updating the "openTicklers" property.
|
void | closeOpenTicklers()
This method is a convenience method for updating the "openTicklers" property.
|
Product | findCachedProduct(Product product)
This method is a convenience method for accessing the cachedProducts property.
|
BlockReasonCode | getBlockReasonCodeById(java.lang.String blockReasonCodeId)
This method returns the BlockReasonCode model object from the list of block reason codes based on the Id.
|
BlockReasonCode[] | getBlockReasonCodes()
This method is a convenience method for getting the "blockReasonCodes" property.
|
ModelObjectList | getBlockReasonCodesModelObjectList()
This method is a convenience method for getting the "blockReasonCodes" property.
|
BusinessChannel[] | getBusinessChannels()
Gets the business channels available for the store.
|
java.util.Hashtable | getCachedProducts()
This method is a convenience method for retrieving the current setting of the "cachedProducts" property.
|
ChargeType[] | getChargeTypes()
This method is a convenience method for retrieving the current setting of the "chargeTypes" property.
|
ModelObjectList | getChargeTypesModelObjectList()
This method is a convenience method for retrieving the current setting of the "chargeTypes" property.
|
java.lang.String | getDescription()
This method is a convenience method for retrieving the current setting of the "description" property.
|
java.lang.String | getInventorySystem()
This method is a convenience method for retrieving the current setting of the "inventorySystem" property.
|
java.lang.String | getLanguageId()
This method is a convenience method for retrieving the current setting of the "languageId" property.
|
java.lang.String | getMaxQuoteExpiryPeriod()
This method is a convenience method for retrieving the current setting of the "MaxQuoteExpiryPeriod" property.
|
java.lang.String | getMemberId()
This method is a convenience method for retrieving the current setting of the "memberId" property.
|
Customer | getOpenCustomer(Customer customer)
This method is a convenience method for retrieving a customer from the "openCustomers" property.
|
Customer[] | getOpenCustomers()
This method is a convenience method for retrieving the current setting of the "openCustomers" property.
|
ModelObjectList | getOpenCustomersModelObjectList()
This method is a convenience method for retrieving the current setting of the "openCustomers" property.
|
Organization | getOpenOrganization(Organization organization)
This method is a convenience method for retrieving an organization from the PROP_OPEN_ORGANIZATIONS property.
|
ModelObjectList | getOpenOrganizationModelObjectList()
This method is a convenience method for retrieving the current setting of the PROP_OPEN_ORGANIZATIONS property.
|
Organization[] | getOpenOrganizations()
This is a convenience method for retrieving the current setting of the PROP_OPEN_ORGANIZATIONS property.
|
Tickler | getOpenTickler(Tickler tickler)
This method is a convenience method for retrieving a tickler from the "openTicklers" property.
|
Tickler[] | getOpenTicklers()
This method is a convenience method for retrieving the current setting of the "openTicklers" property.
|
ModelObjectList | getOpenTicklersModelObjectList()
This method is a convenience method for retrieving the current setting of the "openTicklers" property.
|
java.util.HashMap | getOrderChangeReasons()
This method is a convenience method for retrieving the current setting of the "orderChangeReasons" property.
|
Organization | getOrganization()
This method is a convenience method for retrieving the current setting of the "organization" property.
|
ModelObjectList | getOverrideReasonModelObjectList()
This method is a convenience method for retrieving the current setting of the "overrideReasons" property.
|
OverrideReason[] | getOverrideReasons()
This method is a convenience method for retrieving the current setting of the "overrideReasons" property.
|
java.lang.String | getQuoteExpiryPeriod()
This method is a convenience method for retrieving the current setting of the "quoteExpiryPeriod" property.
|
java.util.HashMap | getReturnReasons()
This method is a convenience method for retrieving the current setting of the "returnReasons" property.
|
java.lang.String[] | getRoleIds()
This method is a convenience method for retrieving an array of role IDs.
|
Role[] | getRoles()
This method is a convenience method for retrieving the current setting of the "roles" property.
|
ModelObjectList | getRolesModelObjectList()
This method is a convenience method for retrieving the current setting of the "roles" property.
|
ShippingMode | getShippingMode(java.lang.String shippingModeId)
Returns the shipping mode with the specified shipping mode ID.
|
ShippingMode[] | getShippingModes()
This method is a convenience method for retrieving the current setting of the "shippingModes" property.
|
ModelObjectList | getShippingModesModelObjectList()
This method is a convenience method for retrieving the current setting of the "shippingModes" property.
|
java.lang.String | getStoreId()
This method is a convenience method for retrieving the current setting of the "storeId" property.
|
Currency[] | getSupportedCurrencies()
This method is a convenience method for retrieving the current setting of the "supportedCurrencies" property.
|
ModelObjectList | getSupportedCurrenciesModelObjectList()
This method is a convenience method for retrieving the current setting of the "supportedCurrencies" property.
|
java.lang.String[] | getSupportedLanguages()
This method is a convenience method for retrieving the current setting of the "supportedLanguages" property.
|
ModelObjectList | getSupportedLanguagesModelObjectList()
This method is a convenience method for retrieving the current setting of the "supportedLanguages" property.
|
TicklerActionCode[] | getTicklerActionCodes()
This method is a convenience method for retrieving the current setting of the "ticklerActionCodes" property.
|
ModelObjectList | getTicklerActionCodesModelObjectList()
This method is a convenience method for retrieving the current setting of the "ticklerActionCodes" property.
|
TicklerReasonCode[] | getTicklerReasonCodes()
This method is a convenience method for retrieving the current setting of the "ticklerReasonCodes" property.
|
ModelObjectList | getTicklerReasonCodesModelObjectList()
This method is a convenience method for retrieving the current setting of the "ticklerReasonCodes" property.
|
java.lang.String | getType()
This method is a convenience method for retrieving the current setting of the "type" property.
|
boolean | hasOpenCustomer(Customer openCustomer)
Tests if the specified customer is open in this store.
|
boolean | hasOpenOrganization(Organization organization)
This method tests if the specified Organization is open for this store.
|
boolean | hasOpenTickler(Tickler openTickler)
Tests if the specified tickler is open in this store.
|
boolean | hasRole(java.lang.String roleId)
This method is a convenience method to determine whether a Role with the specified roleId is associated with this store
|
boolean | isOrderBlockingEnabled()
This method is a convenience method for getting the "orderBlockingEnabled" property.
|
void | setBusinessChannels(BusinessChannel[] businessChannels)
Sets the business channels available for the store.
|
void | setChargeTypes(ChargeType[] types)
This method is a convenience method for setting the "chargeTypes" property.
|
void | setDescription(java.lang.String description)
This method is a convenience method for setting the "description" property.
|
void | setInventorySystem(java.lang.String invSystem)
This method is a convenience method for setting the "inventorySystem" property.
|
void | setLanguageId(java.lang.String langId)
This method is a convenience method for setting the "languageId" property.
|
void | setMaxQuoteExpiryPeriod(java.lang.String maxExpiryTime)
This method is a convenience method for setting the "MaxQuoteExpiryPeriod" property.
|
void | setMemberId(java.lang.String memberId)
This method is a convenience method for setting the "memberId" property.
|
void | setOpenCustomers(Customer[] customers)
This method is a convenience method for setting the "openCustomers" property.
|
void | setOpenOrganizations(Organization[] organizationList)
This is a convenience method for setting the PROP_OPEN_ORGANIZATIONS property.
|
void | setOpenTicklers(Tickler[] ticklers)
This method is a convenience method for setting the "openTicklers" property.
|
void | setOrderBlockingEnabled(boolean blockEnabled)
This method is a convenience method for setting the "orderBlockingEnabled" property.
|
void | setOrderChangeReasons(java.util.HashMap reasons)
This method is a convenience method for setting the "orderChangeReasons" property.
|
void | setOrganization(Organization organization)
This method is a convenience method for setting the "organization" property.
|
void | setQuoteExpiryPeriod(java.lang.String quoteExpiryPeriod)
This method is a convenience method for setting the "quoteExpiryPeriod" property.
|
void | setReturnReasons(java.util.HashMap reasons)
This method is a convenience method for setting the "returnReasons" property.
|
void | setRoles(Role[] newRoles)
This method is a convenience method for setting the "roles" property.
|
void | setShippingModes(ShippingMode[] modes)
This method is a convenience method for setting the "shippingModes" property.
|
void | setStoreId(java.lang.String storeId)
This method is a convenience method for setting the "storeId" property.
|
void | setTicklerActionCodes(TicklerActionCode[] actionCodes)
This method is a convenience method for setting the "ticklerActionCodes" property.
|
void | setTicklerReasonCodes(TicklerReasonCode[] reasonCodes)
This method is a convenience method for setting the "ticklerReasonCodes" property.
|
void | setType(java.lang.String type)
This method is a convenience method for setting the "type" property.
|
java.lang.String | toString()
Returns a string representation of this store.
|
public static final java.lang.String B2B
public static final java.lang.String B2C
public static final java.lang.String BBB
public static final java.lang.String PROP_SHIPPING_MODES
The value is "shippingModes".
The data stored under the "shippingModes" property is a ModelObjectList that contains a list of ShippingMode objects that represent the shipping modes available to this store.
public static final java.lang.String PROP_SUPPORTED_LANGUAGES
The value is "supportedLanguages".
The data stored under the "supportedLanguages" property is a ModelObjectList that contains a list of supportedLanguages objects that represent the supported languages available to this store.
public static final java.lang.String PROP_SUPPORTED_CURRENCIES
The value is "supportedCurrencies".
The data stored under the "supportedCurrencies" property is a ModelObjectList that contains a list of Currency objects that represent the supported currencies available to this store.
public static final java.lang.String PROP_CHARGE_TYPES
The value is "chargeTypes".
The data stored under the "chargeTypes" property is a ModelObjectList that contains a list of ChargeType objects that represent the charge types available to this store.
public static final java.lang.String PROP_ROLES
The value is "roles".
The data stored under the "roles" property is a ModelObjectList that contains a list of Role objects that represent the roles available at this store for the currently logged-in operator.
public static final java.lang.String PROP_OPEN_CUSTOMERS
The value is "openCustomers".
The data stored under the "openCustomers" property is a ModelObjectList that contains a list of Customer objects that represent the customers shopping at the store.
public static final java.lang.String PROP_STORE_ID
The value is "storeId".
The data stored under the "storeId" property is a String that contains the store's primary ID.
public static final java.lang.String PROP_DESCRIPTION
The value is "description".
The data stored under the "description" property is a String that contains the store's description.
public static final java.lang.String PROP_MEMBER_ID
The value is "memberID".
The data stored under the "memberID" property is a String that contains the primary ID for the owner of this store.
public static final java.lang.String PROP_LANGUAGE_ID
The value is "languageId".
The data stored under the "languageId" property is a String that contains the current language of this store.
public static final java.lang.String PROP_TYPE
The value is "type".
The data stored under the "type" property is a String that contains the store's type. Possible values are:
public static final java.lang.String PROP_TICKLER_REASON_CODES
The value is "ticklerReasonCodes".
The data stored under the "ticklerReasonCodes" property is a ModelObjectList that contains a list of TicklerReasonCodes objects that represent the tickler reason codes available to this store.
public static final java.lang.String PROP_TICKLER_ACTION_CODES
The value is "ticklerActionCodes".
The data stored under the "ticklerActionCodes" property is a ModelObjectList that contains a list of TicklerActionCodes objects that represent the tickler action codes available to this store.
public static final java.lang.String PROP_ORDER_BLOCKING_ENABLED
The value is "orderBlockingEnabled".
The data stored under the "orderBlockingEnabled" property is a Boolean that specifies whether or not the store is configured to allow order blocking.
public static final java.lang.String PROP_OVERRIDE_REASONS
The value is "overrideReasons".
The data stored under the "overrideReasons" property is a ModelObjectList that contains a list of OverrideReason objects that represent all of the available override reasons.
public static final java.lang.String PROP_OPEN_TICKLERS
The value is "openTicklers".
The data stored under the "openTicklers" property is a ModelObjectList that contains a list of Tickler objects that represent the ticklers opened at the store.
public static final java.lang.String PROP_CACHED_PRODUCTS
The value is "cachedProducts".
The data stored under the "cachedProducts" property is a java.util.Hashtable that contains cached Product objects.
public static final java.lang.String PROP_ORGANIZATION
The value is "organization".
The data stored under the "organization" property is an Organization object that represents the customer's organization.
public static final java.lang.String PROP_QUOTE_EXPIRY_PERIOD
The value is "quoteExpiryPeriod".
The data stored under the "quoteExpiryPeriod" property is a String that contains the quote expiry period of this Store.
public static final java.lang.String PROP_QUOTE_MAX_EXPIRY_PERIOD
The value is "MaxQuoteExpiryPeriod".
The data stored under the "MaxQuoteExpiryPeriod" property is a String that represents the floor value of the quote expiry period and the service representative cannot exceed this value.
public static final java.lang.String PROP_AVAIL_ORDERCHANGE_REASONS
The value is "orderChangeReasons".
The data stored under the "orderChangeReasons" property is a HashMap that contains the available order change reasons for this store.
public static final java.lang.String PROP_AVAIL_RETURN_REASONS
The value is "returnReasons".
The data stored under the "returnReasons" property is a HashMap that contains the available return reasons for this store.
public static final java.lang.String PROP_BLOCK_REASON_CODES
The value is "blockReasonCodes".
The data stored under the "blockReasonCodes" property is an array of BlockReasonCode objects that specifies all of the available Block Reason Codes defined for the store.
public static final java.lang.String PROP_OPEN_ORGANIZATIONS
The value is "openOrganizations".
The data stored under the "openOrganizations" property is a ModelObjectList that contains a list of Organization objects which have been opened for the store.
public static final java.lang.String PROP_STORE_INVENTORY_SYSTEM
The value is "inventorySystem".
The data stored under the "inventorySystem" property.
public void addOpenCustomer(Customer customer)
public void addOverrideReason(OverrideReason reason)
public void addShippingMode(ShippingMode mode)
public void addSupportedLanguage(java.lang.String langId)
public void addCurrency(Currency currency)
public void addChargeType(ChargeType type)
public void addRole(Role role)
public void closeOpenCustomer(Customer customer)
public void closeOpenCustomers()
public java.lang.String getDescription()
public java.lang.String getMemberId()
public java.lang.String getLanguageId()
public Customer getOpenCustomer(Customer customer)
public Customer[] getOpenCustomers()
public ModelObjectList getOpenCustomersModelObjectList()
public ModelObjectList getOverrideReasonModelObjectList()
public OverrideReason[] getOverrideReasons()
public ShippingMode[] getShippingModes()
public ShippingMode getShippingMode(java.lang.String shippingModeId)
public java.lang.String[] getSupportedLanguages()
public Currency[] getSupportedCurrencies()
public ModelObjectList getSupportedCurrenciesModelObjectList()
public Role[] getRoles()
public java.lang.String[] getRoleIds()
public ModelObjectList getShippingModesModelObjectList()
public ModelObjectList getSupportedLanguagesModelObjectList()
public ModelObjectList getRolesModelObjectList()
public ChargeType[] getChargeTypes()
public ModelObjectList getChargeTypesModelObjectList()
public java.lang.String getStoreId()
public java.lang.String getInventorySystem()
public java.lang.String getType()
public boolean hasOpenCustomer(Customer openCustomer)
public void setDescription(java.lang.String description)
public void setMemberId(java.lang.String memberId)
public void setLanguageId(java.lang.String langId)
public void setOpenCustomers(Customer[] customers)
public void setShippingModes(ShippingMode[] modes)
public void setRoles(Role[] newRoles)
public void setChargeTypes(ChargeType[] types)
public void setStoreId(java.lang.String storeId)
public void setType(java.lang.String type)
public void setInventorySystem(java.lang.String invSystem)
public java.lang.String toString()
public void addTicklerReasonCode(TicklerReasonCode reasonCode)
public TicklerReasonCode[] getTicklerReasonCodes()
public ModelObjectList getTicklerReasonCodesModelObjectList()
public void setTicklerReasonCodes(TicklerReasonCode[] reasonCodes)
public void addTicklerActionCode(TicklerActionCode actionCode)
public TicklerActionCode[] getTicklerActionCodes()
public ModelObjectList getTicklerActionCodesModelObjectList()
public void setTicklerActionCodes(TicklerActionCode[] actionCodes)
public boolean isOrderBlockingEnabled()
public void setOrderBlockingEnabled(boolean blockEnabled)
public boolean hasRole(java.lang.String roleId)
public BusinessChannel[] getBusinessChannels()
The return value is an array of BusinessChannel objects.
public void setBusinessChannels(BusinessChannel[] businessChannels)
The single parameter is an array of BusinessChannel objects.
public void addOpenTickler(Tickler tickler)
public void closeOpenTickler(Tickler tickler)
public void closeOpenTicklers()
public Tickler getOpenTickler(Tickler tickler)
public ModelObjectList getOpenTicklersModelObjectList()
public Tickler[] getOpenTicklers()
public boolean hasOpenTickler(Tickler openTickler)
public void setOpenTicklers(Tickler[] ticklers)
public java.util.Hashtable getCachedProducts()
public void addCachedProduct(Product product)
public Product findCachedProduct(Product product)
public void clearProductCache()
public Organization getOrganization()
public void setOrganization(Organization organization)
public java.lang.String getQuoteExpiryPeriod()
public void setQuoteExpiryPeriod(java.lang.String quoteExpiryPeriod)
public java.util.HashMap getReturnReasons()
public void setReturnReasons(java.util.HashMap reasons)
public void addReturnReason(java.lang.String reasonCode, java.lang.String reasonDesc)
public java.util.HashMap getOrderChangeReasons()
public void setOrderChangeReasons(java.util.HashMap reasons)
public void addOrderChangeReason(java.lang.String reasonId, java.lang.String reasonDesc)
public java.lang.String getMaxQuoteExpiryPeriod()
public void setMaxQuoteExpiryPeriod(java.lang.String maxExpiryTime)
public ModelObjectList getBlockReasonCodesModelObjectList()
The return value is list of BlockReasonCode objects.
public void addBlockReasonCodes(BlockReasonCode blockReasonCode)
public BlockReasonCode[] getBlockReasonCodes()
The return value is an array of BlockReasonCode objects.
public BlockReasonCode getBlockReasonCodeById(java.lang.String blockReasonCodeId)
public void setOpenOrganizations(Organization[] organizationList)
public void addOpenOrganization(Organization organization)
public void closeOpenOrganization(Organization organization)
public void closeOpenOrganizations()
public Organization[] getOpenOrganizations()
public Organization getOpenOrganization(Organization organization)
public ModelObjectList getOpenOrganizationModelObjectList()
public boolean hasOpenOrganization(Organization organization)