com.ibm.commerce.membergroup.commands

Interface AddMemberGroupCmd

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:

AddMemberGroupCmdImpl

public interface AddMemberGroupCmd
extends TaskCommand

This interface must be implemented to provide a task command that creates member groups. 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.Long	getMemberGroupId() Returns the member group ID of the member group that was just created.
void	setIsCalledFromService(boolean bService) Indicates whether this task command is called from a service.
void	setMemberGroupConditions(java.lang.String conditions) Sets the conditions for the member group.
void	setMemberGroupDescription(java.lang.String description) Sets the description of the member group.
void	setMemberGroupDN(java.lang.String dn) Sets the distingushed name for the member group.
void	setMemberGroupField1(java.lang.String field1) Sets field 1 for the member group.
void	setMemberGroupField2(java.lang.String field2) Sets field 2 for the member group.
void	setMemberGroupField3(java.lang.String field3) Sets field 3 for the member group.
void	setMemberGroupName(java.lang.String name) Sets the member group name.
void	setMemberGroupOID(java.lang.String oid) Sets the OID value for the member group.
void	setMemberGroupOwnerId(java.lang.Long ownerId) Sets the owner of the member group.
void	setMemberGroupUsageTypeId(java.lang.Integer usageTypeId) Sets the usage type ID for the 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

setMemberGroupName

void setMemberGroupName(java.lang.String name)

Sets the member group name. This parameter is required.

Parameters:

name - The name of the member group.

setMemberGroupOwnerId

void setMemberGroupOwnerId(java.lang.Long ownerId)

Sets the owner of the member group. If this parameter is not specified then owner of the current store will be used.

Parameters:

ownerId - The member ID of the owner of the member group.

setMemberGroupDescription

void setMemberGroupDescription(java.lang.String description)

Sets the description of the member group. This parameter is optional.

Parameters:

description - The description of the member group.

setMemberGroupConditions

void setMemberGroupConditions(java.lang.String conditions)

Sets the conditions for the member group. This parameter is optional. This parameter is an XML document that describes the conditions that must evaluate to true in order for a user to belong to this member group.

Parameters:

conditions - The conditions for this member group.

setMemberGroupDN

void setMemberGroupDN(java.lang.String dn)

Sets the distingushed name for the member group. This parameter is optional. It is used for coordination with LDAP.

Parameters:

dn - The distingushed name for this member group.

setMemberGroupField1

void setMemberGroupField1(java.lang.String field1)

Sets field 1 for the member group. This parameter is optional. It is reserved for customization.

Parameters:

field1 - The value for field 1.

setMemberGroupField2

void setMemberGroupField2(java.lang.String field2)

Sets field 2 for the member group. This parameter is optional. It is reserved for customization.

Parameters:

field2 - The value for field 2.

setMemberGroupField3

void setMemberGroupField3(java.lang.String field3)

Sets field 3 for the member group. This parameter is optional. It is reserved for customization.

Parameters:

field3 - The value for field 3.

setMemberGroupOID

void setMemberGroupOID(java.lang.String oid)

Sets the OID value for the member group. This parameter is optional. It is reserved by IBM.

Parameters:

oid - The OID value.

setMemberGroupUsageTypeId

void setMemberGroupUsageTypeId(java.lang.Integer usageTypeId)

Sets the usage type ID for the member group. This parameter is optional. If you do not specify this parameter, then "general" usage type is used to create this member group.

Parameters:

usageTypeId - The ID of the usage type.

getMemberGroupId

java.lang.Long getMemberGroupId()

Returns the member group ID of the member group that was just created. You must execute this task command before accessing this value.

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

setIsCalledFromService

void setIsCalledFromService(boolean bService)

Indicates whether this task command is called from a service.

Parameters:

bService - true the command is called from a service.