com.ibm.commerce.membergroup.commands
Interface AddMemberGroupCmd

All Superinterfaces:
ECCommand, 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
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 was just created.
 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.ECCommand
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright.

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The name of the default implementation of this interface.

Name

public static final java.lang.String Name
The name of this interface.
Method Detail

getMemberGroupId

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

setMemberGroupConditions

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

setMemberGroupDescription

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

setMemberGroupDN

public 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

public 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

public 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

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

setMemberGroupName

public void setMemberGroupName(java.lang.String name)
Sets the member group name. This parameter is required.
Parameters:
name - The name of the member group.

setMemberGroupOID

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

setMemberGroupOwnerId

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

setMemberGroupUsageTypeId

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