com.ibm.commerce.search.facade.client

Class AbstractSearchFacadeClient

  • Direct Known Subclasses:
    SearchFacadeClient

    public abstract class AbstractSearchFacadeClient
extends AbstractBusinessObjectDocumentFacadeClient

    This class provides a set of methods that can be used to communicate with the Search facade. This class represents a library of Search 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 Search facade.

    • Field Detail

      • COPYRIGHT

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

    • Constructor Detail

      • AbstractSearchFacadeClient

        public AbstractSearchFacadeClient()
        Creates an instance of the client to communicate with the Search facade.

      • AbstractSearchFacadeClient

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

      • getSearchTermAssociation

        public ShowSearchTermAssociationType getSearchTermAssociation(GetSearchTermAssociationType aGetSearchTermAssociation)
        This method will communicate with the Search facade and send the specified GetSearchTermAssociation. request.
        Parameters:
        aGetSearchTermAssociation - The GetSearchTermAssociation request document.
        Returns:
        The resulting ShowSearchTermAssociation response document.

      • processSearchTermAssociation

        public AcknowledgeSearchTermAssociationType processSearchTermAssociation(ProcessSearchTermAssociationType aProcessSearchTermAssociation)
        This method will communicate with the Search facade and send the specified ProcessSearchTermAssociation request.
        Parameters:
        aProcessSearchTermAssociation - The ProcessSearchTermAssociation request document.
        Returns:
        The resulting AcknowledgeSearchTermAssociation response document.

      • changeSearchTermAssociation

        public RespondSearchTermAssociationType changeSearchTermAssociation(ChangeSearchTermAssociationType aChangeSearchTermAssociation)
        This method will communicate with the SearchTermAssociation facade and send the specified ChangeSearchTermAssociation request.
        Parameters:
        aChangeSearchTermAssociation - The ChangeSearchTermAssociation request document.
        Returns:
        The resulting RespondSearchTermAssociation response document.

      • getSearchTermAssociation

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

      • getSearchTermAssociation

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