com.ibm.commerce.member.facade.server.commands

Interface FetchMemberGroupCmd

  • All Superinterfaces:
    com.ibm.websphere.command.Command, java.io.Serializable
    All Known Implementing Classes:
    FetchMemberGroupCmdImpl

    public interface FetchMemberGroupCmd
extends com.ibm.websphere.command.Command
    Fetches member groups based on the GetType search criteria below. Currently, only member groups with usage of General Purpose are returned. Customer segments created using the Accelerator have this usage.
  • {_wcf.ap=$accessProfile$}/MemberGroup[MemberGroupIdentifier[(UniqueID='$ID1$' or UniqueID='$ID2' or ...)]]
    - finds member groups based on an arbitrary number of unique IDs
  • {_wcf.ap=$accessProfile$}/MemberGroup[MemberGroupIdentifier[ExternalIdentifier[Name='$name$' and @ownerID='$ownerID$']]]
    - finds member groups based on name and owner ID
  • {_wcf.ap=$accessProfile$}/MemberGroup[Usage='$usage$']]
    - finds member groups based on usage
  • {_wcf.ap=$accessProfile$}/MemberGroup[ search(MemberGroupIdentifier/ExternalIdentifier/Name='$name$') and Usage='$usage$']
    - finds member groups by name and usage; name is "case-insensitive, equals"
  • {_wcf.ap=$accessProfile$}/MemberGroup[ search(contains(MemberGroupIdentifier/ExternalIdentifier/Name, '$name$')) and Usage='$usage$']
    - finds member groups by name and usage; name is "case-insensitive, contains"
  • {_wcf.ap=$accessProfile$}/MemberGroup[ search(starts-with(MemberGroupIdentifier/ExternalIdentifier/Name, '$name$')) and Usage='$usage$']
    - finds member groups by name and usage; name is "case-insensitive, starts with"
  • {_wcf.ap=$accessProfile$}/MemberGroup[ search(ends-with(MemberGroupIdentifier/ExternalIdentifier/Name, '$name$')) and Usage='$usage$']
    - finds member groups by name and usage; name is "case-insensitive, ends with"
  • {_wcf.ap=$accessProfile$}/MemberGroup[MemberGroupIdentifier[UniqueID='$memberGroupID$'] and IncludedPerson[UniqueID='$personID$']]
    - checks if a member group contains a specified person. The member group is specified using its unique ID. The person is also specified using its unique ID.


    Returns a list of SegmentDataBean representing the Member Groups found

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM Copyright notice field.

      • Fields inherited from interface com.ibm.websphere.command.Command

        serialVersionUID

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      java.util.List getMemberGroups()
      Returns a list of SegmentDataBean representing the Member Groups found based on the GetType search criteria.
      ShowType getShow()
      Returns the show verb that represents the results returned.
      void setGet(GetType getVerb)
      This method sets the get expression to base the fetch operation on.

      • Methods inherited from interface com.ibm.websphere.command.Command

        execute, isReadyToCallExecute, reset

    • Field Detail

      • COPYRIGHT

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

    • Method Detail

      • getShow

        ShowType getShow()
        Returns the show verb that represents the results returned.
        Returns:
        The show verb that corresponds with the results returned.

      • setGet

        void setGet(GetType getVerb)
        This method sets the get expression to base the fetch operation on.
        Parameters:
        getVerb - The get expression to execute.