com.ibm.commerce.location.facade.client

Class AbstractLocationFacadeClient

  • Direct Known Subclasses:
    LocationFacadeClientExtended


    public abstract class AbstractLocationFacadeClient
    extends AbstractBusinessObjectDocumentFacadeClient

    This class provides a set of methods that can be used to communicate with the Location facade. This class represents a library of Location operations that can be performed. The purpose of this class is to hide the details about constructing the business object document that represents the service request into simple Java methods. The complexity of building the request document and making the request is all managed by this client class of the Location facade.

    • Constructor Detail

      • AbstractLocationFacadeClient

        public AbstractLocationFacadeClient()
        Creates an instance of the client to communicate with the Location facade.
      • AbstractLocationFacadeClient

        public AbstractLocationFacadeClient(BusinessContextType businessContext,
                                            javax.security.auth.callback.CallbackHandler callbackHandler)
        Creates an instance of the client to communicate with the Location 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

      • getPointOfInterest

        public ShowPointOfInterestType getPointOfInterest(GetPointOfInterestType aGetPointOfInterest)
        This method will communicate with the Location facade and send the specified GetPointOfInterest. request.
        Parameters:
        aGetPointOfInterest - The GetPointOfInterest request document.
        Returns:
        The resulting ShowPointOfInterest response document.
      • processPointOfInterest

        public AcknowledgePointOfInterestType processPointOfInterest(ProcessPointOfInterestType aProcessPointOfInterest)
        This method will communicate with the Location facade and send the specified ProcessPointOfInterest request.
        Parameters:
        aProcessPointOfInterest - The ProcessPointOfInterest request document.
        Returns:
        The resulting AcknowledgePointOfInterest response document.
      • changePointOfInterest

        public RespondPointOfInterestType changePointOfInterest(ChangePointOfInterestType aChangePointOfInterest)
        This method will communicate with the PointOfInterest facade and send the specified ChangePointOfInterest request.
        Parameters:
        aChangePointOfInterest - The ChangePointOfInterest request document.
        Returns:
        The resulting RespondPointOfInterest response document.
      • getPointOfInterest

        public ShowPointOfInterestDataAreaType getPointOfInterest(GetType getVerb)
                                                           throws PointOfInterestException
        This method returns the ShowPointOfInterestDataArea when issuing the specified get expression to fetch PointOfInterests. This method will be used by other framworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowPointOfInterestDataArea response when issuing the get expression.
        Throws:
        PointOfInterestException - The PointOfInterestException is thrown if error information is found in the specified ShowPointOfInterestDataArea. This will represent that there was a problem when performing the operation.
      • getPointOfInterest

        public java.util.List getPointOfInterest(java.lang.String expressionLanguage,
                                                 java.lang.String expression)
                                          throws PointOfInterestException
        This method returns a list of PointOfInterests based on the expression specified.
        Parameters:
        expressionLanguage - The expression lanaguage.
        expression - The expression to return a list of PointOfInterests.
        Returns:
        The list of PointOfInterests that matches the expression specified.
        Throws:
        PointOfInterestException - The PointOfInterestException is thrown if error information is found in the specified ShowPointOfInterestDataArea. This will represent that there was a problem when performing the operation.
      • getClientLocation

        public ShowClientLocationType getClientLocation(GetClientLocationType aGetClientLocation)
        This method will communicate with the Location facade and send the specified GetClientLocation. request.
        Parameters:
        aGetClientLocation - The GetClientLocation request document.
        Returns:
        The resulting ShowClientLocation response document.
      • processClientLocation

        public AcknowledgeClientLocationType processClientLocation(ProcessClientLocationType aProcessClientLocation)
        This method will communicate with the Location facade and send the specified ProcessClientLocation request.
        Parameters:
        aProcessClientLocation - The ProcessClientLocation request document.
        Returns:
        The resulting AcknowledgeClientLocation response document.
      • changeClientLocation

        public RespondClientLocationType changeClientLocation(ChangeClientLocationType aChangeClientLocation)
        This method will communicate with the ClientLocation facade and send the specified ChangeClientLocation request.
        Parameters:
        aChangeClientLocation - The ChangeClientLocation request document.
        Returns:
        The resulting RespondClientLocation response document.
      • getClientLocation

        public ShowClientLocationDataAreaType getClientLocation(GetType getVerb)
                                                         throws ClientLocationException
        This method returns the ShowClientLocationDataArea when issuing the specified get expression to fetch ClientLocations. This method will be used by other framworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowClientLocationDataArea response when issuing the get expression.
        Throws:
        ClientLocationException - The ClientLocationException is thrown if error information is found in the specified ShowClientLocationDataArea. This will represent that there was a problem when performing the operation.
      • getClientLocation

        public java.util.List getClientLocation(java.lang.String expressionLanguage,
                                                java.lang.String expression)
                                         throws ClientLocationException
        This method returns a list of ClientLocations based on the expression specified.
        Parameters:
        expressionLanguage - The expression lanaguage.
        expression - The expression to return a list of ClientLocations.
        Returns:
        The list of ClientLocations that matches the expression specified.
        Throws:
        ClientLocationException - The ClientLocationException is thrown if error information is found in the specified ShowClientLocationDataArea. This will represent that there was a problem when performing the operation.