com.ibm.commerce.membergroup.commands
Interface ListMemberGroupsForUserCmd

All Superinterfaces:
ECCommand, TaskCommand
All Known Implementing Classes:
ListMemberGroupsForUserCmdImpl

public interface ListMemberGroupsForUserCmd
extends TaskCommand

This interface must be implemented to provide a task command that lists the member groups to which a user belongs. 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[] getMemberGroupIds()
          Returns the ids of the member groups to which the specified user belongs.
 java.lang.String[] getMemberGroups()
          Returns the names of the member groups to which the specified user belongs.
 void setMemberGroupUsageTypeId(java.lang.Integer memberGroupUsageTypeId)
          Sets the member group usage type ID.
 void setUser(UserAccessBean user)
          Sets the user access bean.
 
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

getMemberGroupIds

public java.lang.Long[] getMemberGroupIds()
Returns the ids of the member groups to which the specified user belongs. You must execute this task command before accessing this value.
Returns:
An array of member group ids.

getMemberGroups

public java.lang.String[] getMemberGroups()
Returns the names of the member groups to which the specified user belongs. You must execute this task command before accessing this value.
Returns:
An array of member group names.

setMemberGroupUsageTypeId

public void setMemberGroupUsageTypeId(java.lang.Integer memberGroupUsageTypeId)
Sets the member group usage type ID. If this parameter is not specified, then the general usage type is assumed.
Parameters:
memberGroupUsageTypeId - The ID of the desired usage type.

setUser

public void setUser(UserAccessBean user)
Sets the user access bean. This parameter is required.
Parameters:
user - The user that you want to profile.