com.ibm.commerce.membergroup.commands
Interface AddMemberGroupMembersCmd

All Superinterfaces:
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 Summary
static java.lang.String COPYRIGHT
          Copyright.
static java.lang.String defaultCommandClassName
          The name of the default implementation of this interface.
static java.lang.String NAME
          The name of this interface.
 
Method Summary
 java.lang.Long getMemberGroupId()
          Returns the member group ID of the member group that had members added.
 void setCustomerId(java.lang.String customerId)
          Sets the customer ID value for the member group to member relationship.
 void setExclude(java.lang.String exclude)
          Sets the exclude value.
 void setField1(java.lang.String field1)
          Sets field 1 for the member group to member relationship.
 void setMemberGroupId(java.lang.Long memberGroupId)
          Sets the member group ID.
 void setMemberIds(java.lang.Long[] userIds)           Sets the member IDs of the members that are to be added to the specified member group.
 

Field Detail
public static final java.lang.String COPYRIGHT
Copyright.
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
The name of this interface.
See Also:
Constant Field Values

defaultCommandClassName

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

setMemberGroupId

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

setMemberIds

public 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.

setExclude

public 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

public 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.

setCustomerId

public 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.

getMemberGroupId

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