Package ch.tocco.nice2.netui.api.actions.entityoperation

Interface EntityExplorerActionSelectionService

All Known Implementing Classes:

EntityExplorerActionSelectionServiceImpl

public interface EntityExplorerActionSelectionService

The EntityExplorerActionSelectionService is used to query the actual entities for the selection when performing an action on a selection made in the entity explorer

Method Summary

Modifier and Type	Method	Description
QueryDefinition	getQueryDefinition(EntityExplorerActionSelection selection, boolean confirmSelection)	Converts the EntityExplorerActionSelection into a QueryDefinition which can be used to create query builders (like SinglePathQueryBuilder or PathQueryBuilder).
Entity	getSelectedEntity(EntityExplorerActionSelection selection)	Returns exactly one entity (for actions which expect exactly one) or throws.
EntityList	getSelectionEntityList(EntityExplorerActionSelection selection)	Returns the list of entities for the selection made in the entity explorer, taking the EntityExplorerActionSelection.SelectionType into consideration.
EntityList	getSelectionEntityList(EntityExplorerActionSelection selection, int limit)	Returns the list of entities for the selection made in the entity explorer, taking the EntityExplorerActionSelection.SelectionType into consideration.
EntityList	getSelectionEntityListConfirmed(EntityExplorerActionSelection selection)	Returns the list of entities for the selection made in the entity explorer, taking the EntityExplorerActionSelection.SelectionType into consideration.

Method Details

getSelectionEntityList

EntityList getSelectionEntityList(EntityExplorerActionSelection selection)
                           throws PersistException,
RpcExecutionException

Returns the list of entities for the selection made in the entity explorer, taking the EntityExplorerActionSelection.SelectionType into consideration. In case of a rather large or unusual selection, the user is asked for confirmation to avoid unnecessary long execution time caused by a unwanted selection.

Parameters:

selection - the selection of entries in the entity explorer.

Returns:

the resolved list of entities.

Throws:

PersistException

RpcExecutionException

getSelectionEntityList

EntityList getSelectionEntityList(EntityExplorerActionSelection selection,
 int limit)
                           throws PersistException,
RpcExecutionException

Returns the list of entities for the selection made in the entity explorer, taking the EntityExplorerActionSelection.SelectionType into consideration. In case of a rather large or unusual selection, the user is asked for confirmation to avoid unnecessary long execution time caused by a unwanted selection. If the size of the selection even exceeds the given limit, an error message is shown instead of the confirmation dialog and the user has to reduce the selection size.

Parameters:

selection - the selection of entries in the entity explorer.

limit - the limit for the selection size.

Returns:

the resolved list of entities.

Throws:

PersistException

RpcExecutionException

getSelectionEntityListConfirmed

EntityList getSelectionEntityListConfirmed(EntityExplorerActionSelection selection)
                                    throws PersistException,
RpcExecutionException

Returns the list of entities for the selection made in the entity explorer, taking the EntityExplorerActionSelection.SelectionType into consideration. In contrary to getSelectionEntityList(EntityExplorerActionSelection), this method does not ask the user for confirmation of his selection. Use this method if getSelectionEntityList(EntityExplorerActionSelection) has already been called and confirmed by the user during a previous step of the action or if the action is known to definitely not take a long time to proceed, event if the selection is very large.

Parameters:

selection - the selection of entries in the entity explorer.

Returns:

the resolved list of entities.

Throws:

PersistException

RpcExecutionException

getQueryDefinition

QueryDefinition getQueryDefinition(EntityExplorerActionSelection selection,
 boolean confirmSelection)

Converts the EntityExplorerActionSelection into a QueryDefinition which can be used to create query builders (like SinglePathQueryBuilder or PathQueryBuilder).

getSelectedEntity

Entity getSelectedEntity(EntityExplorerActionSelection selection)
                  throws PersistException,
RpcExecutionException

Returns exactly one entity (for actions which expect exactly one) or throws.

Parameters:

selection - the selection of entries in the entity explorer.

Returns:

a single selected entity

Throws:

PersistException

RpcExecutionException