com.ibm.commerce.membergroup.commands

Interface AddMemberGroupMemberCmd

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:

AddMemberGroupMemberCmdImpl

public interface AddMemberGroupMemberCmd
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

Fields

Modifier and Type	Field and Description
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.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
void	enableContentManagement(boolean enabled) Indicates whether Content Management flow should be used for the command
java.lang.String	getMemberId() Returns the member ID of the member being 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	setMemberId(java.lang.Long userId) Sets the member ID of the member that is to be added to the specified member group.

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

execute

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties

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

isReadyToCallExecute, reset

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

Methods inherited from interface com.ibm.commerce.command.ECCommand

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

Copyright.

See Also:

Constant Field Values

Name

static final java.lang.String Name

The name of this interface.

See Also:

Constant Field Values

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.

setMemberId

void setMemberId(java.lang.Long userId)

Sets the member ID of the member that is to be added to the specified member group. This parameter is required.

Parameters:

memberId - The ID 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:

memberId - The ID of the member.

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.

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.

getMemberId

java.lang.String getMemberId()

Returns the member ID of the member being added.

Returns:

The ID of the member being added.

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