com.ibm.commerce.store.facade.client

Class StoreFacadeClient


  • 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.

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM Copyright notice field.
        See Also:
        Constant Field Values

    • Constructor Detail

      • StoreFacadeClient

        public StoreFacadeClient()
        Creates an instance of the client to communicate with the Store facade.

      • StoreFacadeClient

        public StoreFacadeClient(BusinessContextType businessContext,
                         javax.security.auth.callback.CallbackHandler callbackHandler)
        Creates an instance of the client to communicate with the Store facade.
        Parameters:
        businessContext - The default business context to associate with the messages when making requests.
        callbackHandler - Used for authentication purposes so the controller can give the authentication information to the transport when required.

    • Method Detail

      • getPhysicalStoresByUniqueIDs

        public ShowPhysicalStoreType getPhysicalStoresByUniqueIDs(java.lang.String accessProfile,
                                                          java.lang.String[] uniqueIds)
                                                   throws PhysicalStoreException
        Gets physical stores by store unique IDs.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_DETAILS_INFORMATION is used.
        uniqueIds - The unique IDs of the physical stores to be located.
        Returns:
        the ShowPhysicalStoreType response
        Throws:
        PhysicalStoreException - Exception is thrown when the parameter 'uniqueIds' contains nothing or at least one of them does not contain numeric value.

      • getPhysicalStoresByUniqueIDs

        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
        Gets physical stores by store unique IDs.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_DETAILS_INFORMATION is used.
        uniqueIds - The unique IDs of the physical stores to be located.
        maxItems - Specifies the maximum number of records to be retrieved.
        refId - The internal identifier for the result set, so that it can be resolved on a subsequent request.
        startNum - The starting index from which to retrieve results from the result set.
        Returns:
        the ShowPhysicalStoreType response
        Throws:
        PhysicalStoreException - Exception is thrown when the parameter 'uniqueIds' contains nothing or at least one of them does not contain numeric value.

      • getPhysicalStoresByExternalIdentifiers

        public ShowPhysicalStoreType getPhysicalStoresByExternalIdentifiers(java.lang.String accessProfile,
                                                                    java.lang.String[] externalIdentifiers)
                                                             throws PhysicalStoreException
        Deprecated. by #getStorePhysicalStoresByExternalIdentifiers(String, Long, String[], BigInteger, String, BigInteger)
        Gets physical stores by store external identifiers.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_DETAILS_INFORMATION is used.
        externalIdentifiers - The external identifiers of the physical stores to be located.
        Returns:
        the ShowPhysicalStoreType response
        Throws:
        PhysicalStoreException - Exception is thrown when the parameter 'externalIdentifiers' contains nothing

      • getPhysicalStoresByExternalIdentifiers

        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
        Deprecated. by #getStorePhysicalStoresByExternalIdentifiers(String, Long, String[], BigInteger, String, BigInteger)
        Gets physical stores by store external identifiers.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_DETAILS_INFORMATION is used.
        externalIdentifiers - The external identifiers of the physical stores to be located.
        maxItems - Specifies the maximum number of records to be retrieved.
        refId - The internal identifier for the result set, so that it can be resolved on a subsequent request.
        startNum - The starting index from which to retrieve results from the result set.
        Returns:
        the ShowPhysicalStoreType response
        Throws:
        PhysicalStoreException - Exception is thrown when the parameter 'externalIdentifiers' contains nothing

      • getStorePhysicalStoresByExternalIdentifiers

        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
        Gets physical stores by web store entity ID and physical store external identifiers.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_DETAILS_INFORMATION is used.
        storeId - The web store entity ID. It can be null for site wide search.
        externalIdentifiers - The external identifiers of the physical stores to be located.
        maxItems - Specifies the maximum number of records to be retrieved.
        refId - The internal identifier for the result set, so that it can be resolved on a subsequent request.
        startNum - The starting index from which to retrieve results from the result set.
        Returns:
        the ShowPhysicalStoreType response
        Throws:
        PhysicalStoreException - Exception is thrown when the parameter 'externalIdentifiers' contains nothing

      • getPhysicalStoresByExternalIdentifiersUniqueIds

        public ShowPhysicalStoreType getPhysicalStoresByExternalIdentifiersUniqueIds(java.lang.String accessProfile,
                                                                             java.lang.String[] externalIdentifiers,
                                                                             java.lang.String[] uniqueIds)
                                                                      throws PhysicalStoreException
        Deprecated. by #getStorePhysicalStoresByExternalIdentifiersUniqueIds(String, Long, String[], String[], BigInteger, String, BigInteger)
        Gets physical stores by store external identifiers and store unique IDs.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_DETAILS_INFORMATION is used.
        externalIdentifiers - The external identifiers of the physical stores to be located.
        uniqueIds - The unique IDs of the physical stores to be located.
        Returns:
        the ShowPhysicalStoreType response
        Throws:
        PhysicalStoreException - Exception is thrown when either parameter 'externalIdentifiers' or 'uniqueIds' contains nothing, and when 'uniqueIds' is non-numeric value

      • getPhysicalStoresByExternalIdentifiersUniqueIds

        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
        Deprecated. by #getStorePhysicalStoresByExternalIdentifiersUniqueIds(String, Long, String[], String[], BigInteger, String, BigInteger)
        Gets physical stores by store external identifiers and store unique IDs.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_DETAILS_INFORMATION is used.
        externalIdentifiers - The external identifiers of the physical stores to be located.
        uniqueIds - The unique IDs of the physical stores to be located.
        maxItems - Specifies the maximum number of records to be retrieved.
        refId - The internal identifier for the result set, so that it can be resolved on a subsequent request.
        startNum - The starting index from which to retrieve results from the result set.
        Returns:
        the ShowPhysicalStoreType response
        Throws:
        PhysicalStoreException - Exception is thrown when either parameter 'externalIdentifiers' or 'uniqueIds' contains nothing, and when 'uniqueIds' is non-numeric value

      • getStorePhysicalStoresByExternalIdentifiersUniqueIds

        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
        Gets physical stores by web store entity ID, store external identifiers and store unique IDs.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_DETAILS_INFORMATION is used.
        storeId - The web store entity ID. It can be null for site wide search.
        externalIdentifiers - The external identifiers of the physical stores to be located.
        uniqueIds - The unique IDs of the physical stores to be located.
        maxItems - Specifies the maximum number of records to be retrieved.
        refId - The internal identifier for the result set, so that it can be resolved on a subsequent request.
        startNum - The starting index from which to retrieve results from the result set
        Returns:
        the ShowPhysicalStoreType response
        Throws:
        PhysicalStoreException - Exception is thrown when either parameter 'externalIdentifiers' or 'uniqueIds' contains nothing, and when 'uniqueIds' is non-numeric value

      • getPhysicalStoresByGeoNodeUniqueID

        public ShowPhysicalStoreType getPhysicalStoresByGeoNodeUniqueID(java.lang.String accessProfile,
                                                                java.lang.String uniqueId)
                                                         throws PhysicalStoreException
        Gets physical stores by geo node unique ID.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_DETAILS_INFORMATION is used.
        uniqueId - The unique ID of the geo node in which the physical stores are located.
        Returns:
        the ShowPhysicalStoreType response
        Throws:
        PhysicalStoreException - Exception is thrown when the parameter 'uniqueId' contains nothing or is not numeric value.

      • getPhysicalStoresByGeoNodeUniqueID

        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
        Gets physical stores by geo node unique ID.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_DETAILS_INFORMATION is used.
        uniqueId - The unique ID of the geo node in which the physical stores are located.
        maxItems - Specifies the maximum number of records to be retrieved.
        refId - The internal identifier for the result set, so that it can be resolved on a subsequent request.
        startNum - The starting index from which to retrieve results from the result set.
        Returns:
        the ShowPhysicalStoreType response
        Throws:
        PhysicalStoreException - Exception is thrown when the parameter 'uniqueId' contains nothing or is not numeric value.

      • getPhysicalStoresByGeoNodeUniqueID

        public ShowPhysicalStoreType getPhysicalStoresByGeoNodeUniqueID(java.lang.String accessProfile,
                                                                java.lang.String uniqueId,
                                                                java.util.Map searchAttributes)
                                                         throws PhysicalStoreException
        Gets physical stores by geo node unique ID with attributes.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_DETAILS_INFORMATION is used.
        uniqueId - The unique ID of the geo node in which the physical stores are located.
        searchAttributes - A Map that contains the name/value pairs of the store attributes.
        Returns:
        the ShowPhysicalStoreType response
        Throws:
        PhysicalStoreException - Exception is thrown when the parameter 'uniqueId' contains nothing or is not numeric value; or when no attribute is found.

      • getPhysicalStoresByGeoNodeUniqueID

        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
        Gets physical stores by web store entity ID and geo node unique ID with attributes.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_DETAILS_INFORMATION is used.
        uniqueId - The unique ID of the geo node in which the physical stores are located.
        searchAttributes - A Map that contains the name/value pairs of the store attributes. It can be null.
        maxItems - Specifies the maximum number of records to be retrieved.
        refId - The internal identifier for the result set, so that it can be resolved on a subsequent request.
        startNum - The starting index from which to retrieve results from the result set.
        Returns:
        the ShowPhysicalStoreType response
        Throws:
        PhysicalStoreException - Exception is thrown when the parameter 'uniqueId' contains nothing or is not numeric value; or when no attribute is found.

      • getPhysicalStoresFromGeoCode

        public ShowPhysicalStoreType getPhysicalStoresFromGeoCode(java.lang.String accessProfile,
                                                          java.lang.String latitude,
                                                          java.lang.String longitude,
                                                          java.util.Map searchConditions)
                                                   throws PhysicalStoreException
        Deprecated. by #getStorePhysicalStoresFromGeoCode(String, Long, String, String, Map, Map)
        Gets physical stores based on a geo code as the stating location.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_DETAILS_INFORMATION is used.
        latitude - The latitude of the geo code and is the starting point from which the physical stores are located.
        longitude - The longitude of the geo code and is the starting point from which the physical stores are located.
        searchConditions - This includes 'radius', 'radiusUOM' and 'maxNumOfStores'.
        Returns:
        the ShowPhysicalStoreType response
        Throws:
        PhysicalStoreException - Exception is thrown when the parameter 'latitude' or 'longitude' contains nothing or is not numeric value.

      • getPhysicalStoresFromGeoCode

        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
        Deprecated. by #getStorePhysicalStoresFromGeoCode(String, Long, String, String, Map, Map)
        Gets physical stores from a geo code.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_DETAILS_INFORMATION is used.
        latitude - The latitude of the geo code and is the starting point from which the physical stores are located.
        longitude - The longitude of the geo code and is the starting point from which the physical stores are located.
        searchConditions - This includes 'radius', 'radiusUOM' and 'maxNumOfStores'.
        searchAttributes - A Map that contains the name/value pairs of the store attributes.
        Returns:
        the ShowPhysicalStoreType response
        Throws:
        PhysicalStoreException - Exception is thrown when the parameter 'latitude' or 'longitude' contains nothing or is not numeric value; or when no attribute is found.

      • getStorePhysicalStoresFromGeoCode

        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
        Gets physical stores from web store entity ID and a geo code.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_DETAILS_INFORMATION is used.
        storeId - The web store entity ID. It can be null for site wide search.
        latitude - The latitude of the geo code and is the starting point from which the physical stores are located.
        longitude - The longitude of the geo code and is the starting point from which the physical stores are located.
        searchConditions - This includes 'radius', 'radiusUOM' and 'maxNumOfStores'. It can be null.
        searchAttributes - A Map that contains the name/value pairs of the store attributes. It can be null.
        Returns:
        the ShowPhysicalStoreType response
        Throws:
        PhysicalStoreException - Exception is thrown when the parameter 'latitude' or 'longitude' contains nothing or is not numeric value; or when no attribute is found.

      • getPhysicalStoresFromLocationUniqueID

        public ShowPhysicalStoreType getPhysicalStoresFromLocationUniqueID(java.lang.String accessProfile,
                                                                   java.lang.String uniqueId,
                                                                   java.util.Map searchConditions)
                                                            throws PhysicalStoreException
        Deprecated. by #getStorePhysicalStoresFromLocationUniqueID(String, Long, String, Map, Map)
        Gets physical stores based on another store location (by unique ID) as the starting location.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_DETAILS_INFORMATION is used.
        uniqueId - The unique ID of the store location and is the starting point from which the physical stores are located.
        searchConditions - This includes 'radius', 'radiusUOM' and 'maxNumOfStores'.
        Returns:
        the ShowPhysicalStoreType response
        Throws:
        PhysicalStoreException - Exception is thrown when the parameter 'uniqueId' contains nothing or is not numeric value.

      • getPhysicalStoresFromLocationUniqueID

        public ShowPhysicalStoreType getPhysicalStoresFromLocationUniqueID(java.lang.String accessProfile,
                                                                   java.lang.String uniqueId,
                                                                   java.util.Map searchConditions,
                                                                   java.util.Map searchAttributes)
                                                            throws PhysicalStoreException
        Deprecated. by #getStorePhysicalStoresFromLocationUniqueID(String, Long, String, Map, Map)
        Gets physical stores based on another store location (by unique ID) as the starting location with attributes.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_DETAILS_INFORMATION is used.
        uniqueId - The unique ID of the store location and is the starting point from which the physical stores are located.
        searchConditions - This includes 'radius', 'radiusUOM' and 'maxNumOfStores'.
        searchAttributes - A Map that contains the name/value pairs of the store attributes. It can be null.
        Returns:
        the ShowPhysicalStoreType response
        Throws:
        PhysicalStoreException - Exception is thrown when the parameter 'uniqueId' contains nothing or is not numeric value; or when no attribute is found.

      • getStorePhysicalStoresFromLocationUniqueID

        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
        Gets physical stores based on the web store entity ID and another store location (by unique ID) as the starting location with attributes.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_DETAILS_INFORMATION is used.
        storeId - The web store entity ID. It can be null for site wide search.
        uniqueId - The unique ID of the store location and is the starting point from which the physical stores are located.
        searchConditions - This includes 'radius', 'radiusUOM' and 'maxNumOfStores'. It can be null.
        searchAttributes - A Map that contains the name/value pairs of the store attributes. It can be null.
        Returns:
        the ShowPhysicalStoreType response
        Throws:
        PhysicalStoreException - Exception is thrown when the parameter 'uniqueId' contains nothing or is not numeric value; or when no attribute is found.

      • getPhysicalStoresFromLocationExternalIdentifier

        public ShowPhysicalStoreType getPhysicalStoresFromLocationExternalIdentifier(java.lang.String accessProfile,
                                                                             java.lang.String externalIdentifier,
                                                                             java.util.Map searchConditions)
                                                                      throws PhysicalStoreException
        Deprecated. by #getStorePhysicalStoresFromLocationExternalIdentifier(String, Long, String, Map, Map)
        Gets physical stores based on another store location (by external identifier) as the starting location.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_DETAILS_INFORMATION is used.
        externalIdentifier - The external identifier of the store location and is the starting point from which the physical stores are located.
        searchConditions - This includes 'radius', 'radiusUOM' and 'maxNumOfStores'.
        Returns:
        the ShowPhysicalStoreType response
        Throws:
        PhysicalStoreException - Exception is thrown when the parameter 'externalIdentifier' contains nothing.

      • getPhysicalStoresFromLocationExternalIdentifier

        public ShowPhysicalStoreType getPhysicalStoresFromLocationExternalIdentifier(java.lang.String accessProfile,
                                                                             java.lang.String externalIdentifier,
                                                                             java.util.Map searchConditions,
                                                                             java.util.Map searchAttributes)
                                                                      throws PhysicalStoreException
        Deprecated. by #getStorePhysicalStoresFromLocationExternalIdentifier(String, Long, String, Map, Map)
        Gets physical stores based on another store location (by external identifier) as the starting location with attributes.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_DETAILS_INFORMATION is used.
        externalIdentifier - The external identifier of the store location and is the starting point from which the physical stores are located.
        searchConditions - This includes 'radius', 'radiusUOM' and 'maxNumOfStores'.
        searchAttributes - A Map that contains the name/value pairs of the store attributes.
        Returns:
        the ShowPhysicalStoreType response
        Throws:
        PhysicalStoreException - Exception is thrown when the parameter 'externalIdentifier' contains nothing; or when no attribute is found.

      • getStorePhysicalStoresFromLocationExternalIdentifier

        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
        Gets physical stores based on web store entity ID and another store location (by external identifier) as the starting location with attributes.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_DETAILS_INFORMATION is used.
        storeId - The web store entity ID. It can be null for site wide search.
        externalIdentifier - The external identifier of the store location and is the starting point from which the physical stores are located.
        searchConditions - This includes 'radius', 'radiusUOM' and 'maxNumOfStores'. It can be null.
        searchAttributes - A Map that contains the name/value pairs of the store attributes. It can be null.
        Returns:
        the ShowPhysicalStoreType response
        Throws:
        PhysicalStoreException - Exception is thrown when the parameter 'externalIdentifier' contains nothing; or when no attribute is found.

      • getTopGeoNodes

        public ShowGeoNodeType getTopGeoNodes(java.lang.String accessProfile)
                               throws GeoNodeException
        Deprecated. by getStoreTopGeoNodes(String, Integer)
        Gets top geo nodes.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_ALL_INFORMATION is used.
        Returns:
        the ShowGeoNodeType response
        Throws:
        GeoNodeException - Exception is thrown when error occurs

      • getStoreTopGeoNodes

        public ShowGeoNodeType getStoreTopGeoNodes(java.lang.String accessProfile,
                                           java.lang.Integer storeId)
                                    throws GeoNodeException
        Gets top geo nodes for store.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_ALL_INFORMATION is used.
        storeId - The web store entity ID. It can be null for site wide search.
        Returns:
        the ShowGeoNodeType response
        Throws:
        GeoNodeException - Exception is thrown when error occurs

      • getChildGeoNodesByGeoNodeUniqueID

        public ShowGeoNodeType getChildGeoNodesByGeoNodeUniqueID(java.lang.String accessProfile,
                                                         java.lang.String parentUniqueId)
                                                  throws GeoNodeException
        Gets geo nodes by parent geo node unique ID.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_ALL_INFORMATION is used.
        parentUniqueId - The unique ID of the parent geo node.
        Returns:
        the ShowGeoNodeType response
        Throws:
        GeoNodeException - Exception is thrown when the parameter 'parentUniqueId' is null, empty or does not contain numeric value.

      • getGeoNodesByGeoNodeTypeAndName

        public ShowGeoNodeType getGeoNodesByGeoNodeTypeAndName(java.lang.String accessProfile,
                                                       java.lang.String type,
                                                       java.lang.String name)
                                                throws GeoNodeException
        Deprecated. by #getStoreGeoNodesByGeoNodeTypeAndName(String, Long, String, String)
        Gets geo nodes by type and name.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_ALL_INFORMATION is used.
        type - The type of the geo node.
        name - The name of the geo node.
        Returns:
        the ShowGeoNodeType response
        Throws:
        GeoNodeException - Exception is thrown when the parameter 'type' or 'name' is null or empty.

      • getStoreGeoNodesByGeoNodeTypeAndName

        public ShowGeoNodeType getStoreGeoNodesByGeoNodeTypeAndName(java.lang.String accessProfile,
                                                            java.lang.Integer storeId,
                                                            java.lang.String type,
                                                            java.lang.String name)
                                                     throws GeoNodeException
        Gets geo nodes by web store entity ID, type and name.
        Parameters:
        accessProfile - The accessProfile to set; if this is not provided, the default value - StoreFacadeConstants.ACCESS_PROFILE_ALL_INFORMATION is used.
        storeId - The web store entity ID. It can be null for site wide search.
        type - The type of the geo node.
        name - The name of the geo node.
        Returns:
        the ShowGeoNodeType response
        Throws:
        GeoNodeException - Exception is thrown when the parameter 'type' or 'name' is null or empty.

      • findPhysicalStoresByUniqueIDs

        public ExpressionType findPhysicalStoresByUniqueIDs(java.util.Map parameters)
        Builds the expression for finding physical stores by one to multiple store unique IDs.
        Parameters:
        parameters - The map of name/value pairs. The values are expected in String[] format.
        Returns:
        the expression of ExpressionType

      • findPhysicalStoresByExternalIdentifiers

        public ExpressionType findPhysicalStoresByExternalIdentifiers(java.util.Map parameters)
        Builds the expression for finding physical stores by one to multiple store external.
        Parameters:
        parameters - The map of name/value pairs. The values are expected in String[] format.
        Returns:
        the expression of ExpressionType

      • findStorePhysicalStoresByExternalIdentifiers

        public ExpressionType findStorePhysicalStoresByExternalIdentifiers(java.util.Map parameters)
        Builds the expression for finding web store level physical stores by one to multiple store external.
        Parameters:
        parameters - The map of name/value pairs. The values are expected in String[] format.
        Returns:
        the expression of ExpressionType

      • findPhysicalStoresByExternalIdentifiersUniqueIDs

        public 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.
        Parameters:
        parameters - The map of name/value pairs. The values are expected in String[] format.
        Returns:
        the expression of ExpressionType

      • findStorePhysicalStoresByExternalIdentifiersUniqueIDs

        public 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.
        Parameters:
        parameters - The map of name/value pairs. The values are expected in String[] format.
        Returns:
        the expression of ExpressionType

      • findPhysicalStoresByGeoNodeUniqueIDWithAttributes

        public ExpressionType findPhysicalStoresByGeoNodeUniqueIDWithAttributes(java.util.Map parameters)
                                                                 throws PhysicalStoreException
        Builds the expression for finding physical stores by geonode unique ID with attributes.
        Parameters:
        parameters - The map of name/value pairs. The values are expected in String[] format.
        Returns:
        the expression of ExpressionType
        Throws:
        PhysicalStoreException - Exception is thrown when error occurs

      • findPhysicalStoresFromGeoCodeWithAttributes

        public ExpressionType findPhysicalStoresFromGeoCodeWithAttributes(java.util.Map parameters)
                                                           throws PhysicalStoreException
        Builds the expression for finding physical stores from geo code with attributes.
        Parameters:
        parameters - The map of name/value pairs. The values are expected in String[] format.
        Returns:
        the expression of ExpressionType
        Throws:
        PhysicalStoreException - Exception is thrown when error occurs

      • findStorePhysicalStoresFromGeoCodeWithAttributes

        public ExpressionType findStorePhysicalStoresFromGeoCodeWithAttributes(java.util.Map parameters)
                                                                throws PhysicalStoreException
        Builds the expression for finding web store level physical stores from geo code with attributes.
        Parameters:
        parameters - The map of name/value pairs. The values are expected in String[] format.
        Returns:
        the expression of ExpressionType
        Throws:
        PhysicalStoreException - Exception is thrown when error occurs

      • findPhysicalStoresFromLocationUniqueIDWithAttributes

        public ExpressionType findPhysicalStoresFromLocationUniqueIDWithAttributes(java.util.Map parameters)
                                                                    throws PhysicalStoreException
        Builds the expression for finding physical stores from location unique ID with attributes.
        Parameters:
        parameters - The map of name/value pairs. The values are expected in String[] format.
        Returns:
        the expression of ExpressionType
        Throws:
        PhysicalStoreException - Exception is thrown when error occurs

      • findStorePhysicalStoresFromLocationUniqueIDWithAttributes

        public ExpressionType findStorePhysicalStoresFromLocationUniqueIDWithAttributes(java.util.Map parameters)
                                                                         throws PhysicalStoreException
        Builds the expression for finding web store level physical stores from location unique ID with attributes.
        Parameters:
        parameters - The map of name/value pairs. The values are expected in String[] format.
        Returns:
        the expression of ExpressionType
        Throws:
        PhysicalStoreException - Exception is thrown when error occurs

      • findPhysicalStoresFromLocationExternalIdentifierWithAttributes

        public ExpressionType findPhysicalStoresFromLocationExternalIdentifierWithAttributes(java.util.Map parameters)
                                                                              throws PhysicalStoreException
        Builds the expression for finding physical stores from location external identifier with attributes.
        Parameters:
        parameters - The map of name/value pairs. The values are expected in String[] format.
        Returns:
        the expression of ExpressionType
        Throws:
        PhysicalStoreException - Exception is thrown when error occurs

      • findStorePhysicalStoresFromLocationExternalIdentifierWithAttributes

        public ExpressionType findStorePhysicalStoresFromLocationExternalIdentifierWithAttributes(java.util.Map parameters)
                                                                                   throws PhysicalStoreException
        Builds the expression for finding web store level physical stores from location external identifier with attributes.
        Parameters:
        parameters - The map of name/value pairs. The values are expected in String[] format.
        Returns:
        the expression of ExpressionType
        Throws:
        PhysicalStoreException - Exception is thrown when error occurs
Skip navigation links