com.ibm.commerce.membergroup.commands

Interface ListMemberGroupsForUserCmd

  • All Superinterfaces:
    com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand
    All Known Implementing Classes:
    ListMemberGroupsForUserCmdImpl


    public interface ListMemberGroupsForUserCmd
    extends TaskCommand
    This interface must be implemented to provide a task command that lists the member groups to which a user belongs. Different implementations of this interface can be provided for different stores.
    • Field Detail

      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The name of the default implementation of this interface.
        See Also:
        Constant Field Values
    • Method Detail

      • setUser

        void setUser(UserAccessBean user)
        Sets the user access bean. This parameter is required.
        Parameters:
        user - The user that you want to profile.
      • setMemberGroupUsageTypeId

        void setMemberGroupUsageTypeId(java.lang.Integer memberGroupUsageTypeId)
        Sets the member group usage type ID. If this parameter is not specified, then the general usage type is assumed.
        Parameters:
        memberGroupUsageTypeId - The ID of the desired usage type.
      • getMemberGroups

        java.lang.String[] getMemberGroups()
        Returns the names of the member groups to which the specified user belongs. You must execute this task command before accessing this value.
        Returns:
        An array of member group names.
      • getMemberGroupIds

        java.lang.Long[] getMemberGroupIds()
        Returns the IDs of the member groups to which the specified user belongs. You must execute this task command before accessing this value.
        Returns:
        An array of member group IDs.
      • setFindByMemberGroupUsageTypeOnly

        void setFindByMemberGroupUsageTypeOnly(boolean bFindByUsageTypeOnly)
        Set a flag to specify whether to find the member groups by MemberGroupUsageType only or to find by MemberGroupUsageType and Store. By default, the flag is set to false. (i.e. find by MemberGroupUsageType and Store)
        Parameters:
        true - if find the member groups by MemberGroupUsageType only
      • setStoreId

        void setStoreId(java.lang.Integer storeId)
        Sets the store ID that is used to find member group from the database.
        Parameters:
        storeId - The ID of the store.
      • setStoreIds

        void setStoreIds(java.lang.Integer[] storeIds)
        Sets the store IDs that are used to find member group from the database.
        Parameters:
        storeIds - The ID of stores.