com.ibm.commerce.membergroup.commands
Interface CheckUserInMemberGroupCmd

All Superinterfaces:
ECCommand, Evaluator, TaskCommand
All Known Implementing Classes:
CheckUserInMemberGroupCmdImpl

public interface CheckUserInMemberGroupCmd
extends TaskCommand, Evaluator

This interface must be implemented to provide a task command that checks to see if a user belongs to a specified 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
 boolean getResult()
          Returns true if the current user belongs to the specified member group.
 void setMemberGroupAccessBean(MemberGroupAccessBean memberGroupAccessBean)
          Sets the member group access bean.
 void setMemberGroupCondition(Condition condition)
          Sets the condition object.
 void setMemberGroupName(java.lang.String memberGroupName)
          Sets the member group name.
 void setMemberGroupOwnerId(java.lang.Long memberGroupOwnerId)
          Sets the owner of the member group.
 void setUser(UserAccessBean user)
          Sets the user that you want to test.
 
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
 
Methods inherited from interface com.ibm.commerce.condition.Evaluator
evaluate, evaluate
 

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

getResult

public boolean getResult()
Returns true if the current user belongs to the specified member group. Otherwise, it returns false. You must execute this task command before accessing this value.
Returns:
true if the current user belongs to the member group.

setMemberGroupAccessBean

public void setMemberGroupAccessBean(MemberGroupAccessBean memberGroupAccessBean)
Sets the member group access bean. This parameter is required unless the member group name is specified. If you specify this parameter, then the conditions used to evaluate the implicit inclusion of users in a member group will be taken from the access bean.
Parameters:
memberGroupAccessBean - The member group access bean.

setMemberGroupCondition

public void setMemberGroupCondition(Condition condition)
Sets the condition object. This parameter is optional. If you specify this parameter, then it will be used to evaluate the implicit inclusion of users in a member group.
Parameters:
memberGroupCondition - The condition used for implicit membership.

setMemberGroupName

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

setMemberGroupOwnerId

public void setMemberGroupOwnerId(java.lang.Long memberGroupOwnerId)
Sets the owner of the member group. If this parameter is not specified then owner of the current store will be used.
Parameters:
memberGroupOwnerId - The member id of the owner of the member group.

setUser

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