com.ibm.commerce.membergroup.commands

Interface AddMemberGroupMembersCmd

  • 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:
    AddMemberGroupMembersCmdImpl


    public interface AddMemberGroupMembersCmd
    extends TaskCommand
    This interface must be implemented to provide a task command that adds a member to a member group. 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

      • setMemberGroupId

        void setMemberGroupId(java.lang.Long memberGroupId)
        Sets the member group ID. This parameter is required.
        Parameters:
        memberGroupId - The ID of the member group.
      • setMemberIds

        void setMemberIds(java.lang.Long[] userIds)
        Sets the member IDs of the members that are to be added to the specified member group. This parameter is required.
        Parameters:
        memberIds - The IDs of the member.
      • setExclude

        void setExclude(java.lang.String exclude)
        Sets the exclude value. If the specifiec member should be explicitly excluded from the member group, specify "0", otherwise specify "1". This parameter is required.
        Parameters:
        exclude - .
      • setField1

        void setField1(java.lang.String field1)
        Sets field 1 for the member group to member relationship. This parameter is optional. It is available for customization.
        Parameters:
        field1 - The value for field 1.
      • setField1s

        void setField1s(java.lang.String[] field1s)
        Sets field 1 values for the member group to member relationship. This parameter is optional. If the parameter is null code uses setField1 method for all the members It is available for customization.
        Parameters:
        field1s - The array of field 1 for all the members belonging to the membergroup.
      • setCustomerId

        void setCustomerId(java.lang.String customerId)
        Sets the customer ID value for the member group to member relationship. This parameter is optional. It is available for customization.
        Parameters:
        customerId - The value for customer ID.
      • setCustomerIds

        void setCustomerIds(java.lang.String[] customerIds)
        Sets customer ID values for the member group to member relationship. This parameter is optional. If the parameter is null code uses setCustomerId method for all the members It is available for customization.
        Parameters:
        customerIds - The array of customer Id for all the members belonging to the membergroup.
      • getMemberGroupId

        java.lang.Long getMemberGroupId()
        Returns the member group ID of the member group that had members added.
        Returns:
        The ID of the member group.
      • enableContentManagement

        void enableContentManagement(boolean enabled)
        Indicates whether Content Management flow should be used for the command
        Parameters:
        enabled - true will use the Content Management flow