com.ibm.commerce.member.facade.client

Class AbstractMemberFacadeClient

  • Direct Known Subclasses:
    MemberFacadeClient

    public abstract class AbstractMemberFacadeClient
extends AbstractBusinessObjectDocumentFacadeClient

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

    • Field Detail

      • COPYRIGHT

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

    • Constructor Detail

      • AbstractMemberFacadeClient

        public AbstractMemberFacadeClient()
        Creates an instance of the client to communicate with the Member facade.

      • AbstractMemberFacadeClient

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

      • getMemberGroup

        public ShowMemberGroupType getMemberGroup(GetMemberGroupType aGetMemberGroup)
        This method will communicate with the Member facade and send the specified GetMemberGroup. request.
        Parameters:
        aGetMemberGroup - The GetMemberGroup request document.
        Returns:
        The resulting ShowMemberGroup response document.

      • processMemberGroup

        public com.ibm.commerce.member.facade.datatypes.AcknowledgeMemberGroupType processMemberGroup(com.ibm.commerce.member.facade.datatypes.ProcessMemberGroupType aProcessMemberGroup)
        This method will communicate with the Member facade and send the specified ProcessMemberGroup request.
        Parameters:
        aProcessMemberGroup - The ProcessMemberGroup request document.
        Returns:
        The resulting AcknowledgeMemberGroup response document.

      • changeMemberGroup

        public com.ibm.commerce.member.facade.datatypes.RespondMemberGroupType changeMemberGroup(com.ibm.commerce.member.facade.datatypes.ChangeMemberGroupType aChangeMemberGroup)
        This method will communicate with the MemberGroup facade and send the specified ChangeMemberGroup request.
        Parameters:
        aChangeMemberGroup - The ChangeMemberGroup request document.
        Returns:
        The resulting RespondMemberGroup response document.

      • getMemberGroup

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

      • getMemberGroup

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

      • getPerson

        public ShowPersonType getPerson(GetPersonType aGetPerson)
        This method will communicate with the Member facade and send the specified GetPerson. request.
        Parameters:
        aGetPerson - The GetPerson request document.
        Returns:
        The resulting ShowPerson response document.

      • processPerson

        public AcknowledgePersonType processPerson(ProcessPersonType aProcessPerson)
        This method will communicate with the Member facade and send the specified ProcessPerson request.
        Parameters:
        aProcessPerson - The ProcessPerson request document.
        Returns:
        The resulting AcknowledgePerson response document.

      • processPerson

        public AcknowledgePersonType processPerson(ProcessPersonType aProcessPerson,
                                           java.util.Map<java.lang.String,java.lang.String[]> transformedRestRequestMap)
        This method is added for REST customization. This default implementation of this method is calling processPerson(ProcessPersonType).
        Parameters:
        aProcessPerson - The ProcessPerson request document.
        transformedRestRequestMap - a flattened map containing the request parameters
        Returns:
        The resulting AcknowledgePerson response document.

      • changePerson

        public RespondPersonType changePerson(ChangePersonType aChangePerson)
        This method will communicate with the Person facade and send the specified ChangePerson request.
        Parameters:
        aChangePerson - The ChangePerson request document.
        Returns:
        The resulting RespondPerson response document.

      • changePerson

        public RespondPersonType changePerson(ChangePersonType aChangePerson,
                                      java.util.Map<java.lang.String,java.lang.String[]> transformedRestRequestMap)
        This method is added for REST customization. This default implementation of this method is calling changePerson(ChangePersonType).
        Parameters:
        aChangePerson - The ChangePerson request document.
        transformedRestRequestMap - a flattened map containing the request parameters
        Returns:
        The resulting RespondPerson response document.

      • syncPerson

        public ConfirmBODType syncPerson(SyncPersonType aSyncPerson)
        This method will communicate with the Person facade and send the specified SyncPerson request.
        Parameters:
        aSyncPerson - The SyncPerson request document.
        Returns:
        The resulting ConfirmBOD response document.

      • getPerson

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

      • getPerson

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

      • getOrganization

        public ShowOrganizationType getOrganization(GetOrganizationType aGetOrganization)
        This method will communicate with the Member facade and send the specified GetOrganization. request.
        Parameters:
        aGetOrganization - The GetOrganization request document.
        Returns:
        The resulting ShowOrganization response document.

      • processOrganization

        public AcknowledgeOrganizationType processOrganization(ProcessOrganizationType aProcessOrganization)
        This method will communicate with the Member facade and send the specified ProcessOrganization request.
        Parameters:
        aProcessOrganization - The ProcessOrganization request document.
        Returns:
        The resulting AcknowledgeOrganization response document.

      • changeOrganization

        public RespondOrganizationType changeOrganization(ChangeOrganizationType aChangeOrganization)
        This method will communicate with the Organization facade and send the specified ChangeOrganization request.
        Parameters:
        aChangeOrganization - The ChangeOrganization request document.
        Returns:
        The resulting RespondOrganization response document.

      • syncOrganization

        public ConfirmBODType syncOrganization(SyncOrganizationType aSyncOrganization)
        This method will communicate with the Organization facade and send the specified SyncOrganization request.
        Parameters:
        aSyncOrganization - The SyncOrganization request document.
        Returns:
        The resulting ConfirmBOD response document.

      • getOrganization

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

      • getOrganization

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