SearchEntityMembersCommand (bonita-server 9.0.0 API)

java.lang.Object
- org.bonitasoft.engine.command.RuntimeCommand
- - org.bonitasoft.engine.external.identitymapping.MemberCommand
  - - org.bonitasoft.engine.external.identitymapping.ExternalIdentityMappingCommand
    - - org.bonitasoft.engine.external.identitymapping.EntityMemberCommand
      - org.bonitasoft.engine.external.identitymapping.SearchEntityMembersCommand

All Implemented Interfaces:

Command<ServiceAccessor>
```
public class SearchEntityMembersCommand
extends EntityMemberCommand
```
Parameter keys: DISCRIMINATOR_ID_KEY: the discriminator to isolate the different functional notions, SEARCH_OPTIONS_KEY: the Search options to filter & sort the results, MEMBER_TYPE_KEY: Member Type to search for (USER, GROUP, ROLE, or MEMBERSHIP).

Author:

Emmanuel Duchastenier

Nested Class Summary
- Nested classes/interfaces inherited from class org.bonitasoft.engine.external.identitymapping.ExternalIdentityMappingCommand
  ExternalIdentityMappingCommand.ExternalIdentityMappingSearchEntity

Field Summary
- Fields inherited from class org.bonitasoft.engine.external.identitymapping.ExternalIdentityMappingCommand
  DISCRIMINATOR_ID_KEY, ENTITY_MEMBER_ID_KEY, EXTERNAL_ID_KEY, GROUP_ID_KEY, ROLE_ID_KEY, SEARCH_OPTIONS_KEY, serviceAccessor, USER_ID_KEY

Constructor Summary

Constructors
Constructor Description

SearchEntityMembersCommand()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.io.Serializable`	`execute(java.util.Map<java.lang.String,java.io.Serializable> parameters, ServiceAccessor serviceAccessor)`	Method that is called by the engine on the server side when the client calls `CommandAPI.execute(String, Map)` with the name or id of this command.

Methods inherited from class org.bonitasoft.engine.external.identitymapping.EntityMemberCommand
searchEntityMembers, searchEntityMembersInvolvingUser

Methods inherited from class org.bonitasoft.engine.external.identitymapping.ExternalIdentityMappingCommand
addExternalIdentityMapping, deleteExternalIdentityMappings, getServiceAccessor, removeExternalIdentityMapping, toEntityMember

Methods inherited from class org.bonitasoft.engine.external.identitymapping.MemberCommand
getGroupIdParameter, getMemberType, getProfileIdParameter, getQuerySuffix, getRoleIdParameter, getUserIdParameter

Methods inherited from class org.bonitasoft.engine.command.RuntimeCommand
getIntegerMandatoryParameter, getLongMandatoryParameter, getMandatoryParameter, getParameter, getParameter, getStringMandatoryParameter

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

- Constructor Detail
  - SearchEntityMembersCommand
```
public SearchEntityMembersCommand()
```
- Method Detail
  - execute
```
public java.io.Serializable execute(java.util.Map<java.lang.String,java.io.Serializable> parameters,
                                    ServiceAccessor serviceAccessor)
                             throws SCommandParameterizationException,
                                    SCommandExecutionException
```
    Description copied from interface: Command
    
    Method that is called by the engine on the server side when the client calls CommandAPI.execute(String, Map) with the name or id of this command. Implementors of commands must put here the code to be executed on the server side
    
    Parameters:
    
    parameters - a map of parameters that can be used by the command and that is given by the client when executing the command
    
    serviceAccessor - the ServiceAccessor that provides access to the engine's server-side services
    
    Returns:
    
    a result that will be returned to the client
    
    Throws:
    
    SCommandParameterizationException - can be thrown if insufficient or wrong parameters are given by the client
    
    SCommandExecutionException - can be thrown when something unexpected happens while executing the command