com.ibm.commerce.usermanagement.commands

Interface ListBusinessOrgEntityCmd

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:

ListBusinessOrgEntityCmdImpl

public interface ListBusinessOrgEntityCmd
extends TaskCommand

This task command is used to give a list of Business organization entities.

Currently this command lists all organization entities under the Root Organization (except the default organization) during self-registration.

Outputs of this task command are:

 Long[] getBusinessOrgEntityList(TypedProperty)
 - returns a Long array of all business organization entities.
 

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.
static java.lang.String	defaultCommandClassName The default implementation of this command.
static java.lang.String	NAME The name of this command.

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Method Summary

Modifier and Type	Method and Description
java.lang.Long[]	getBusinessOrgEntityList() Gets the list of all business organization entities.
void	setSearchCriteria(int criteriaType, java.lang.String keyword) Sets the search criteria type

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

IBM Copyright notice field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The name of this command.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default implementation of this command.

See Also:

Constant Field Values

Method Detail

getBusinessOrgEntityList

java.lang.Long[] getBusinessOrgEntityList()

Gets the list of all business organization entities.

Returns:

The list of all business organization entities.

setSearchCriteria

void setSearchCriteria(int criteriaType,
                       java.lang.String keyword)

Sets the search criteria type

Parameters:

criteriaType - Specifies a search criteria option, the valid options are:
0 - No criteria, it will search all accounts in system
1 - Match case, beginning with
2 - Match case, containing
3 - Ignore case, beginning with
4 - Ignore case, containing
5 - Exact match

keyword - specify a search keyword for organization name