ListBusinessOrgEntityCmdImpl

java.lang.Object
- MeasuredCacheableCommandImpl
- - com.ibm.commerce.command.AbstractECTargetableCommand
  - - com.ibm.commerce.command.TaskCommandImpl
    - - com.ibm.commerce.usermanagement.commands.ListBusinessOrgEntityCmdImpl

All Implemented Interfaces:

com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, ListBusinessOrgEntityCmd, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable
```
public class ListBusinessOrgEntityCmdImpl
extends TaskCommandImpl
implements ListBusinessOrgEntityCmd
```
Finds a list of Business organization entities.
Currently this command lists all organization entities under Root Organization (Except 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
`protected java.lang.Long[]`	`businessOrgEntityList` List of business organization entities.
`static java.lang.String`	`CLASSNAME` The name of this implementation of the command.
`static java.lang.String`	`COPYRIGHT` IBM Copyright notice field.
`protected boolean`	`searchCriteriaApplied` The flag to indicate caller set up the search criteria
`protected java.lang.String`	`searchKeyword` The search keyword for matching business organization entity's names
`protected int`	`searchType` The search criteria type.
`static int`	`SEARCHTYPE_EXACT_MATCH` Exact Match with keyword search type constant
`static int`	`SEARCHTYPE_IGNORE_CASE_BEGIN` Ignore case beginning with keyword search type constant
`static int`	`SEARCHTYPE_IGNORE_CASE_CONTAIN` Ignore case containing with keyword search type constant
`static int`	`SEARCHTYPE_MATCH_CASE_BEGIN` Match case beginning with keyword search type constant
`static int`	`SEARCHTYPE_MATCH_CASE_CONTAIN` Match case containing with keyword search type constant
`static int`	`SEARCHTYPE_SEARCH_ALL` Default - searches all search type constant.

Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
commandContext

Fields inherited from interface com.ibm.commerce.usermanagement.commands.ListBusinessOrgEntityCmd
defaultCommandClassName, NAME

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

Constructor Summary

Constructors
Constructor and Description

ListBusinessOrgEntityCmdImpl()

Constructors
Constructor and Description
`ListBusinessOrgEntityCmdImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.Long[]`	`getBusinessOrgEntityList()` Returns the business organization entities.
`void`	`performExecute()` Finds all the business organizations and puts the organization identifiers in a list.
`void`	`setSearchCriteria(int criteriaType, java.lang.String keyword)` Sets the search criteria type

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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, 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, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    IBM Copyright notice field.
    
    See Also:
    
    Constant Field Values
  - CLASSNAME
```
public static final java.lang.String CLASSNAME
```
    The name of this implementation of the command.
    
    See Also:
    
    Constant Field Values
  - businessOrgEntityList
```
protected java.lang.Long[] businessOrgEntityList
```
    List of business organization entities.
  - searchCriteriaApplied
```
protected boolean searchCriteriaApplied
```
    The flag to indicate caller set up the search criteria
  - searchKeyword
```
protected java.lang.String searchKeyword
```
    The search keyword for matching business organization entity's names
  - searchType
```
protected int searchType
```
    The search criteria type. Valid constants are: SEARCHTYPE_SEARCH_ALL
    SEARCHTYPE_MATCH_CASE_BEGIN
    SEARCHTYPE_MATCH_CASE_CONTAIN
    SEARCHTYPE_IGNORE_CASE_BEGIN
    SEARCHTYPE_IGNORE_CASE_CONTAIN
    SEARCHTYPE_EXACT_MATCH
  - SEARCHTYPE_SEARCH_ALL
```
public static final int SEARCHTYPE_SEARCH_ALL
```
    Default - searches all search type constant.
    
    See Also:
    
    Constant Field Values
  - SEARCHTYPE_MATCH_CASE_BEGIN
```
public static final int SEARCHTYPE_MATCH_CASE_BEGIN
```
    Match case beginning with keyword search type constant
    
    See Also:
    
    Constant Field Values
  - SEARCHTYPE_MATCH_CASE_CONTAIN
```
public static final int SEARCHTYPE_MATCH_CASE_CONTAIN
```
    Match case containing with keyword search type constant
    
    See Also:
    
    Constant Field Values
  - SEARCHTYPE_IGNORE_CASE_BEGIN
```
public static final int SEARCHTYPE_IGNORE_CASE_BEGIN
```
    Ignore case beginning with keyword search type constant
    
    See Also:
    
    Constant Field Values
  - SEARCHTYPE_IGNORE_CASE_CONTAIN
```
public static final int SEARCHTYPE_IGNORE_CASE_CONTAIN
```
    Ignore case containing with keyword search type constant
    
    See Also:
    
    Constant Field Values
  - SEARCHTYPE_EXACT_MATCH
```
public static final int SEARCHTYPE_EXACT_MATCH
```
    Exact Match with keyword search type constant
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ListBusinessOrgEntityCmdImpl
```
public ListBusinessOrgEntityCmdImpl()
```
- Method Detail
  - getBusinessOrgEntityList
```
public java.lang.Long[] getBusinessOrgEntityList()
```
    Returns the business organization entities.
    
    Specified by:
    
    getBusinessOrgEntityList in interface ListBusinessOrgEntityCmd
    
    Returns:
    
    The business organization entities.
  - performExecute
```
public void performExecute()
                    throws ECException
```
    Finds all the business organizations and puts the organization identifiers in a list.
    
    Specified by:
    
    performExecute in interface ECCommand
    
    Specified by:
    
    performExecute in interface com.ibm.websphere.command.TargetableCommand
    
    Overrides:
    
    performExecute in class AbstractECTargetableCommand
    
    Throws:
    
    ECException - If there was a problem finding the business organizations from the database.
  - setSearchCriteria
```
public void setSearchCriteria(int criteriaType,
                     java.lang.String keyword)
```
    Sets the search criteria type
    
    Specified by:
    
    setSearchCriteria in interface ListBusinessOrgEntityCmd
    
    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

Class ListBusinessOrgEntityCmdImpl

Field Summary

Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

Fields inherited from interface com.ibm.commerce.usermanagement.commands.ListBusinessOrgEntityCmd

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

Constructor Summary

Method Summary

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

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

Methods inherited from interface com.ibm.websphere.command.CommandCaller

Methods inherited from interface com.ibm.commerce.command.ECCommand

Field Detail

COPYRIGHT

CLASSNAME

businessOrgEntityList

searchCriteriaApplied

searchKeyword

searchType

SEARCHTYPE_SEARCH_ALL

SEARCHTYPE_MATCH_CASE_BEGIN

SEARCHTYPE_MATCH_CASE_CONTAIN

SEARCHTYPE_IGNORE_CASE_BEGIN

SEARCHTYPE_IGNORE_CASE_CONTAIN

SEARCHTYPE_EXACT_MATCH

Constructor Detail

ListBusinessOrgEntityCmdImpl

Method Detail

getBusinessOrgEntityList

performExecute

setSearchCriteria