com.ibm.commerce.membergroup.commands

Interface ListUsersInMemberGroupCmd

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:

ListUsersInMemberGroupCmdImpl

public interface ListUsersInMemberGroupCmd
extends TaskCommand

This interface must be implemented to provide a task command that returns the complete list users that belong to a specified 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
java.lang.String	getQuery() Returns the SQL query used to generate the list of members in the group.
java.lang.String[]	getUserIds() Returns the ID for the users that belong to the specified member group.
UserAccessBean[]	getUsers() Returns the user access beans for the users that belong to the specified member group.
void	setAdditionalAndCondition(Condition condition) Adds an additonal condition that must also be met on top of the conditions outlined in the member group rules.
void	setMemberGroupAccessBean(MemberGroupAccessBean memberGroupAccessBean) Sets the member group access bean.
void	setMemberGroupIds(java.lang.String[] mbrGrpIds, java.lang.String anyOrAll) This method sets the additonal member group IDs of the customer segments to which to return the list of users.
void	setMemberGroupName(java.lang.String memberGroupName) Sets the member group name.
void	setMemberGroupOwnerId(java.lang.Long ownerId) Sets the owner of the member group.
void	setOrgEntityIds(java.lang.Long[] orgEntityIds) Sets the organization IDs.
void	setQueryOnly(boolean flag) Defers executing the query generated for querying members of the group to the caller.
void	setQueryWrapper(java.lang.String queryWrapper) Wraps the query used to determine the members of the group with the passed parameter.

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

getUserIds

java.lang.String[] getUserIds()

Returns the ID for the users that belong to the specified member group. You must execute this task command before accessing this value.

Returns:

An array of user IDs.

getUsers

UserAccessBean[] getUsers()

Returns the user access beans for the users that belong to the specified member group. You must execute this task command before accessing this value.

Returns:

An array of UserAccessBean objects.

setMemberGroupAccessBean

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.

setMemberGroupName

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

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:

memberGroupOwnerId - The member id of the owner of the member group.

setOrgEntityIds

void setOrgEntityIds(java.lang.Long[] orgEntityIds)

Sets the organization IDs. This parameter is optional.

Parameters:

orgEntityIds - The list of organization IDs.

setAdditionalAndCondition

void setAdditionalAndCondition(Condition condition)

Adds an additonal condition that must also be met on top of the conditions outlined in the member group rules.

Parameters:

condition - The condition that must also be met.

setQueryWrapper

void setQueryWrapper(java.lang.String queryWrapper)

Wraps the query used to determine the members of the group with the passed parameter. The parameter should be a string containing "%3CQUERY%3E" in the location the original query should be placed. All queries generated will return a set of MEMBER_ID values. Query wrappers may be any query fragment that uses %3CQUERY%3E to represent such a result set.

Parameters:

queryWrapper - the query with which to wrap the original query.

setQueryOnly

void setQueryOnly(boolean flag)

Defers executing the query generated for querying members of the group to the caller. Useful when the caller wishes to manage the database connection and result set. The caller should use getQuery() to retreive the resulting SQL.

Parameters:

flag - Set to true if only the SQL query is required, false otherwise.

getQuery

java.lang.String getQuery()

Returns the SQL query used to generate the list of members in the group.

Returns:

the SQL query used to generate the list of members in the group.

setMemberGroupIds

void setMemberGroupIds(java.lang.String[] mbrGrpIds,
                       java.lang.String anyOrAll)

This method sets the additonal member group IDs of the customer segments to which to return the list of users. These member group IDs are in addition to the member group passed in through the request property parameter memberGroupId to this command.

Parameters:

mbrGrpIds - The set of IDs of the member groups to which to return the list of users.

anyOrAll - Should the list of users be the customers in each of the specified groups (any), or should the list of users be those who are in all of the specified groups (all). Valid values are: any, all.