public class StoreFacadeClient extends AbstractStoreFacadeClient
This class provides common methods that this and other utility class to the Store facade can use. This class also provides a set of convenient Java API to represent particular Store operations. This set of Java API also include APIs for Web based requests to transform the name value pair request into the appropriate request documents.
Modifier and Type | Field and Description |
---|---|
static java.lang.String | COPYRIGHT
IBM Copyright notice field.
|
Constructor and Description |
---|
StoreFacadeClient()
Creates an instance of the client to communicate with the Store facade.
|
StoreFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)
Creates an instance of the client to communicate with the Store facade.
|
Modifier and Type | Method and Description |
---|---|
protected java.lang.String | assignPhysicalStoreFromSearchConditions(java.util.Map searchConditions, java.lang.String conditionKey)
Retrieves the radius, radius unit of measure, maximum number of stores from the map.
|
ExpressionType | findPhysicalStoresByExternalIdentifiers(java.util.Map parameters)
Builds the expression for finding physical stores by one to multiple store external.
|
ExpressionType | findPhysicalStoresByExternalIdentifiersUniqueIDs(java.util.Map parameters)
Builds the expression for finding physical stores by one to multiple store unique IDs and one to multiple store external identifiers.
|
ExpressionType | findPhysicalStoresByGeoNodeUniqueIDWithAttributes(java.util.Map parameters)
Builds the expression for finding physical stores by geonode unique ID with attributes.
|
ExpressionType | findPhysicalStoresByUniqueIDs(java.util.Map parameters)
Builds the expression for finding physical stores by one to multiple store unique IDs.
|
ExpressionType | findPhysicalStoresFromGeoCodeWithAttributes(java.util.Map parameters)
Builds the expression for finding physical stores from geo code with attributes.
|
ExpressionType | findPhysicalStoresFromLocationExternalIdentifierWithAttributes(java.util.Map parameters)
Builds the expression for finding physical stores from location external identifier with attributes.
|
ExpressionType | findPhysicalStoresFromLocationUniqueIDWithAttributes(java.util.Map parameters)
Builds the expression for finding physical stores from location unique ID with attributes.
|
ExpressionType | findStorePhysicalStoresByExternalIdentifiers(java.util.Map parameters)
Builds the expression for finding web store level physical stores by one to multiple store external.
|
ExpressionType | findStorePhysicalStoresByExternalIdentifiersUniqueIDs(java.util.Map parameters)
Builds the expression for finding web store level physical stores by one to multiple store unique IDs and one to multiple store external identifiers.
|
ExpressionType | findStorePhysicalStoresFromGeoCodeWithAttributes(java.util.Map parameters)
Builds the expression for finding web store level physical stores from geo code with attributes.
|
ExpressionType | findStorePhysicalStoresFromLocationExternalIdentifierWithAttributes(java.util.Map parameters)
Builds the expression for finding web store level physical stores from location external identifier with attributes.
|
ExpressionType | findStorePhysicalStoresFromLocationUniqueIDWithAttributes(java.util.Map parameters)
Builds the expression for finding web store level physical stores from location unique ID with attributes.
|
ShowGeoNodeType | getChildGeoNodesByGeoNodeUniqueID(java.lang.String accessProfile, java.lang.String parentUniqueId)
Gets geo nodes by parent geo node unique ID.
|
ShowGeoNodeType | getGeoNodesByGeoNodeTypeAndName(java.lang.String accessProfile, java.lang.String type, java.lang.String name)
Deprecated.
by #getStoreGeoNodesByGeoNodeTypeAndName(String, Long, String, String)
|
ShowPhysicalStoreType | getPhysicalStoresByExternalIdentifiers(java.lang.String accessProfile, java.lang.String[] externalIdentifiers)
Deprecated.
by #getStorePhysicalStoresByExternalIdentifiers(String, Long, String[], BigInteger, String, BigInteger)
|
ShowPhysicalStoreType | getPhysicalStoresByExternalIdentifiers(java.lang.String accessProfile, java.lang.String[] externalIdentifiers, java.math.BigInteger maxItems, java.lang.String refId, java.math.BigInteger startNum)
Deprecated.
by #getStorePhysicalStoresByExternalIdentifiers(String, Long, String[], BigInteger, String, BigInteger)
|
ShowPhysicalStoreType | getPhysicalStoresByExternalIdentifiersUniqueIds(java.lang.String accessProfile, java.lang.String[] externalIdentifiers, java.lang.String[] uniqueIds)
Deprecated.
by #getStorePhysicalStoresByExternalIdentifiersUniqueIds(String, Long, String[], String[], BigInteger, String, BigInteger)
|
ShowPhysicalStoreType | getPhysicalStoresByExternalIdentifiersUniqueIds(java.lang.String accessProfile, java.lang.String[] externalIdentifiers, java.lang.String[] uniqueIds, java.math.BigInteger maxItems, java.lang.String refId, java.math.BigInteger startNum)
Deprecated.
by #getStorePhysicalStoresByExternalIdentifiersUniqueIds(String, Long, String[], String[], BigInteger, String, BigInteger)
|
ShowPhysicalStoreType | getPhysicalStoresByGeoNodeUniqueID(java.lang.String accessProfile, java.lang.String uniqueId)
Gets physical stores by geo node unique ID.
|
ShowPhysicalStoreType | getPhysicalStoresByGeoNodeUniqueID(java.lang.String accessProfile, java.lang.String uniqueId, java.math.BigInteger maxItems, java.lang.String refId, java.math.BigInteger startNum)
Gets physical stores by geo node unique ID.
|
ShowPhysicalStoreType | getPhysicalStoresByGeoNodeUniqueID(java.lang.String accessProfile, java.lang.String uniqueId, java.util.Map searchAttributes)
Gets physical stores by geo node unique ID with attributes.
|
ShowPhysicalStoreType | getPhysicalStoresByGeoNodeUniqueID(java.lang.String accessProfile, java.lang.String uniqueId, java.util.Map searchAttributes, java.math.BigInteger maxItems, java.lang.String refId, java.math.BigInteger startNum)
Gets physical stores by web store entity ID and geo node unique ID with attributes.
|
ShowPhysicalStoreType | getPhysicalStoresByUniqueIDs(java.lang.String accessProfile, java.lang.String[] uniqueIds)
Gets physical stores by store unique IDs.
|
ShowPhysicalStoreType | getPhysicalStoresByUniqueIDs(java.lang.String accessProfile, java.lang.String[] uniqueIds, java.math.BigInteger maxItems, java.lang.String refId, java.math.BigInteger startNum)
Gets physical stores by store unique IDs.
|
ShowPhysicalStoreType | getPhysicalStoresFromGeoCode(java.lang.String accessProfile, java.lang.String latitude, java.lang.String longitude, java.util.Map searchConditions)
Deprecated.
by #getStorePhysicalStoresFromGeoCode(String, Long, String, String, Map, Map)
|
ShowPhysicalStoreType | getPhysicalStoresFromGeoCode(java.lang.String accessProfile, java.lang.String latitude, java.lang.String longitude, java.util.Map searchConditions, java.util.Map searchAttributes)
Deprecated.
by #getStorePhysicalStoresFromGeoCode(String, Long, String, String, Map, Map)
|
ShowPhysicalStoreType | getPhysicalStoresFromLocationExternalIdentifier(java.lang.String accessProfile, java.lang.String externalIdentifier, java.util.Map searchConditions)
Deprecated.
by #getStorePhysicalStoresFromLocationExternalIdentifier(String, Long, String, Map, Map)
|
ShowPhysicalStoreType | getPhysicalStoresFromLocationExternalIdentifier(java.lang.String accessProfile, java.lang.String externalIdentifier, java.util.Map searchConditions, java.util.Map searchAttributes)
Deprecated.
by #getStorePhysicalStoresFromLocationExternalIdentifier(String, Long, String, Map, Map)
|
ShowPhysicalStoreType | getPhysicalStoresFromLocationUniqueID(java.lang.String accessProfile, java.lang.String uniqueId, java.util.Map searchConditions)
Deprecated.
by #getStorePhysicalStoresFromLocationUniqueID(String, Long, String, Map, Map)
|
ShowPhysicalStoreType | getPhysicalStoresFromLocationUniqueID(java.lang.String accessProfile, java.lang.String uniqueId, java.util.Map searchConditions, java.util.Map searchAttributes)
Deprecated.
by #getStorePhysicalStoresFromLocationUniqueID(String, Long, String, Map, Map)
|
ShowGeoNodeType | getStoreGeoNodesByGeoNodeTypeAndName(java.lang.String accessProfile, java.lang.Integer storeId, java.lang.String type, java.lang.String name)
Gets geo nodes by web store entity ID, type and name.
|
ShowPhysicalStoreType | getStorePhysicalStoresByExternalIdentifiers(java.lang.String accessProfile, java.lang.Integer storeId, java.lang.String[] externalIdentifiers, java.math.BigInteger maxItems, java.lang.String refId, java.math.BigInteger startNum)
Gets physical stores by web store entity ID and physical store external identifiers.
|
ShowPhysicalStoreType | getStorePhysicalStoresByExternalIdentifiersUniqueIds(java.lang.String accessProfile, java.lang.Integer storeId, java.lang.String[] externalIdentifiers, java.lang.String[] uniqueIds, java.math.BigInteger maxItems, java.lang.String refId, java.math.BigInteger startNum)
Gets physical stores by web store entity ID, store external identifiers and store unique IDs.
|
ShowPhysicalStoreType | getStorePhysicalStoresFromGeoCode(java.lang.String accessProfile, java.lang.Integer storeId, java.lang.String latitude, java.lang.String longitude, java.util.Map searchConditions, java.util.Map searchAttributes)
Gets physical stores from web store entity ID and a geo code.
|
ShowPhysicalStoreType | getStorePhysicalStoresFromLocationExternalIdentifier(java.lang.String accessProfile, java.lang.Integer storeId, java.lang.String externalIdentifier, java.util.Map searchConditions, java.util.Map searchAttributes)
Gets physical stores based on web store entity ID and another store location (by external identifier) as the starting location with attributes.
|
ShowPhysicalStoreType | getStorePhysicalStoresFromLocationUniqueID(java.lang.String accessProfile, java.lang.Integer storeId, java.lang.String uniqueId, java.util.Map searchConditions, java.util.Map searchAttributes)
Gets physical stores based on the web store entity ID and another store location (by unique ID) as the starting location with attributes.
|
ShowGeoNodeType | getStoreTopGeoNodes(java.lang.String accessProfile, java.lang.Integer storeId)
Gets top geo nodes for store.
|
ShowGeoNodeType | getTopGeoNodes(java.lang.String accessProfile)
Deprecated.
|
protected void | validatePhysicalStoreExternalIdentifiers(java.lang.String[] externalIdentifiers)
Validates the parameter - external identifiers of the physical store.
|
protected void | validatePhysicalStoreGeoCodeAngularDistance(java.lang.String angularDistance, java.lang.String type)
Validates the parameter - 'latitude' or 'longitude' of a geo code.
|
protected void | validatePhysicalStoreUniqueIDs(java.lang.String[] uniqueIds, boolean isOptional)
Validates the parameter - unique IDs of the physical store.
|
protected void | validateSearchAttributes(java.util.Map searchAttributes)
Validates a Map containing the search attributes.
|
protected void | validateSearchAttributes(java.lang.String[] searchNameValuePairs)
Validates a String array containing the search attributes.
|
public static final java.lang.String COPYRIGHT
public StoreFacadeClient()
public StoreFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)
public ShowPhysicalStoreType getPhysicalStoresByUniqueIDs(java.lang.String accessProfile, java.lang.String[] uniqueIds) throws PhysicalStoreException
public ShowPhysicalStoreType getPhysicalStoresByUniqueIDs(java.lang.String accessProfile, java.lang.String[] uniqueIds, java.math.BigInteger maxItems, java.lang.String refId, java.math.BigInteger startNum) throws PhysicalStoreException
public ShowPhysicalStoreType getPhysicalStoresByExternalIdentifiers(java.lang.String accessProfile, java.lang.String[] externalIdentifiers) throws PhysicalStoreException
public ShowPhysicalStoreType getPhysicalStoresByExternalIdentifiers(java.lang.String accessProfile, java.lang.String[] externalIdentifiers, java.math.BigInteger maxItems, java.lang.String refId, java.math.BigInteger startNum) throws PhysicalStoreException
public ShowPhysicalStoreType getStorePhysicalStoresByExternalIdentifiers(java.lang.String accessProfile, java.lang.Integer storeId, java.lang.String[] externalIdentifiers, java.math.BigInteger maxItems, java.lang.String refId, java.math.BigInteger startNum) throws PhysicalStoreException
public ShowPhysicalStoreType getPhysicalStoresByExternalIdentifiersUniqueIds(java.lang.String accessProfile, java.lang.String[] externalIdentifiers, java.lang.String[] uniqueIds) throws PhysicalStoreException
public ShowPhysicalStoreType getPhysicalStoresByExternalIdentifiersUniqueIds(java.lang.String accessProfile, java.lang.String[] externalIdentifiers, java.lang.String[] uniqueIds, java.math.BigInteger maxItems, java.lang.String refId, java.math.BigInteger startNum) throws PhysicalStoreException
public ShowPhysicalStoreType getStorePhysicalStoresByExternalIdentifiersUniqueIds(java.lang.String accessProfile, java.lang.Integer storeId, java.lang.String[] externalIdentifiers, java.lang.String[] uniqueIds, java.math.BigInteger maxItems, java.lang.String refId, java.math.BigInteger startNum) throws PhysicalStoreException
public ShowPhysicalStoreType getPhysicalStoresByGeoNodeUniqueID(java.lang.String accessProfile, java.lang.String uniqueId) throws PhysicalStoreException
public ShowPhysicalStoreType getPhysicalStoresByGeoNodeUniqueID(java.lang.String accessProfile, java.lang.String uniqueId, java.math.BigInteger maxItems, java.lang.String refId, java.math.BigInteger startNum) throws PhysicalStoreException
public ShowPhysicalStoreType getPhysicalStoresByGeoNodeUniqueID(java.lang.String accessProfile, java.lang.String uniqueId, java.util.Map searchAttributes) throws PhysicalStoreException
public ShowPhysicalStoreType getPhysicalStoresByGeoNodeUniqueID(java.lang.String accessProfile, java.lang.String uniqueId, java.util.Map searchAttributes, java.math.BigInteger maxItems, java.lang.String refId, java.math.BigInteger startNum) throws PhysicalStoreException
public ShowPhysicalStoreType getPhysicalStoresFromGeoCode(java.lang.String accessProfile, java.lang.String latitude, java.lang.String longitude, java.util.Map searchConditions) throws PhysicalStoreException
public ShowPhysicalStoreType getPhysicalStoresFromGeoCode(java.lang.String accessProfile, java.lang.String latitude, java.lang.String longitude, java.util.Map searchConditions, java.util.Map searchAttributes) throws PhysicalStoreException
public ShowPhysicalStoreType getStorePhysicalStoresFromGeoCode(java.lang.String accessProfile, java.lang.Integer storeId, java.lang.String latitude, java.lang.String longitude, java.util.Map searchConditions, java.util.Map searchAttributes) throws PhysicalStoreException
public ShowPhysicalStoreType getPhysicalStoresFromLocationUniqueID(java.lang.String accessProfile, java.lang.String uniqueId, java.util.Map searchConditions) throws PhysicalStoreException
public ShowPhysicalStoreType getPhysicalStoresFromLocationUniqueID(java.lang.String accessProfile, java.lang.String uniqueId, java.util.Map searchConditions, java.util.Map searchAttributes) throws PhysicalStoreException
public ShowPhysicalStoreType getStorePhysicalStoresFromLocationUniqueID(java.lang.String accessProfile, java.lang.Integer storeId, java.lang.String uniqueId, java.util.Map searchConditions, java.util.Map searchAttributes) throws PhysicalStoreException
public ShowPhysicalStoreType getPhysicalStoresFromLocationExternalIdentifier(java.lang.String accessProfile, java.lang.String externalIdentifier, java.util.Map searchConditions) throws PhysicalStoreException
public ShowPhysicalStoreType getPhysicalStoresFromLocationExternalIdentifier(java.lang.String accessProfile, java.lang.String externalIdentifier, java.util.Map searchConditions, java.util.Map searchAttributes) throws PhysicalStoreException
public ShowPhysicalStoreType getStorePhysicalStoresFromLocationExternalIdentifier(java.lang.String accessProfile, java.lang.Integer storeId, java.lang.String externalIdentifier, java.util.Map searchConditions, java.util.Map searchAttributes) throws PhysicalStoreException
protected void validatePhysicalStoreUniqueIDs(java.lang.String[] uniqueIds, boolean isOptional) throws PhysicalStoreException
protected void validatePhysicalStoreExternalIdentifiers(java.lang.String[] externalIdentifiers) throws PhysicalStoreException
protected void validatePhysicalStoreGeoCodeAngularDistance(java.lang.String angularDistance, java.lang.String type) throws PhysicalStoreException
protected void validateSearchAttributes(java.util.Map searchAttributes) throws PhysicalStoreException
protected void validateSearchAttributes(java.lang.String[] searchNameValuePairs) throws PhysicalStoreException
protected java.lang.String assignPhysicalStoreFromSearchConditions(java.util.Map searchConditions, java.lang.String conditionKey)
public ShowGeoNodeType getTopGeoNodes(java.lang.String accessProfile) throws GeoNodeException
public ShowGeoNodeType getStoreTopGeoNodes(java.lang.String accessProfile, java.lang.Integer storeId) throws GeoNodeException
public ShowGeoNodeType getChildGeoNodesByGeoNodeUniqueID(java.lang.String accessProfile, java.lang.String parentUniqueId) throws GeoNodeException
public ShowGeoNodeType getGeoNodesByGeoNodeTypeAndName(java.lang.String accessProfile, java.lang.String type, java.lang.String name) throws GeoNodeException
public ShowGeoNodeType getStoreGeoNodesByGeoNodeTypeAndName(java.lang.String accessProfile, java.lang.Integer storeId, java.lang.String type, java.lang.String name) throws GeoNodeException
public ExpressionType findPhysicalStoresByUniqueIDs(java.util.Map parameters)
public ExpressionType findPhysicalStoresByExternalIdentifiers(java.util.Map parameters)
public ExpressionType findStorePhysicalStoresByExternalIdentifiers(java.util.Map parameters)
public ExpressionType findPhysicalStoresByExternalIdentifiersUniqueIDs(java.util.Map parameters)
public ExpressionType findStorePhysicalStoresByExternalIdentifiersUniqueIDs(java.util.Map parameters)
public ExpressionType findPhysicalStoresByGeoNodeUniqueIDWithAttributes(java.util.Map parameters) throws PhysicalStoreException
public ExpressionType findPhysicalStoresFromGeoCodeWithAttributes(java.util.Map parameters) throws PhysicalStoreException
public ExpressionType findStorePhysicalStoresFromGeoCodeWithAttributes(java.util.Map parameters) throws PhysicalStoreException
public ExpressionType findPhysicalStoresFromLocationUniqueIDWithAttributes(java.util.Map parameters) throws PhysicalStoreException
public ExpressionType findStorePhysicalStoresFromLocationUniqueIDWithAttributes(java.util.Map parameters) throws PhysicalStoreException
public ExpressionType findPhysicalStoresFromLocationExternalIdentifierWithAttributes(java.util.Map parameters) throws PhysicalStoreException
public ExpressionType findStorePhysicalStoresFromLocationExternalIdentifierWithAttributes(java.util.Map parameters) throws PhysicalStoreException