SearchResultAction (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

java.lang.Object
- de.hybris.platform.hmc.util.action.SearchResultAction

All Implemented Interfaces:

HMCAction, HMCStatefulAction, Serializable

Direct Known Subclasses:

AcceptDifferencesSearchResultAction, CatalogOverviewSearchAction, CSVExportAction, DontAcceptDifferencesSearchResultAction, DuplicateCodesSearchAction, ExtendedRemoveAction, GenericSetAttributeSearchResultAction, ImpExExportAction, ItemsCopyAction, MoveMediaSearchResultAction, PreviewCatalogVersionAction, ProductComparisonSearchResultAction, SetProductApprovalStatusAction, SyncItemsSearchResultAction, TypeLocalizationSearchResultAction, TypeSystemExportAction
```
public abstract class SearchResultAction
extends Object
implements HMCStatefulAction
```
Extend this class to implement a search result action.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`FLEXIBLESEARCH_PARAMETERS` action parameter - flexible search parameter map
`static String`	`FLEXIBLESEARCH_QUERY` action parameter - flexible search query String
`static String`	`GENERIC_QUERY`
`static String`	`ITEM_TYPE` action parameter - the type of the item
`static String`	`SEARCH_CONTEXT`
`static String`	`SELECTED_ITEMS` action parameter - the list of currently selected items
`static String`	`USE_SELECTED_ONLY` action parameter - Boolean flag, use only the selected items when set to true

Constructor Summary

Constructors
Constructor and Description

SearchResultAction()

Constructors
Constructor and Description
`SearchResultAction()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`AbstractActionDialogChip`	`createDialogChip(Chip parent, AbstractActionChip actionChip)`
`protected Collection<Item>`	`getAllItems(ActionEvent actionEvent)` Convenience method to fetch all items regardless of a selection is made or the complete item range is requested.
`String`	`getConfirmationMessage()` This default implementation returns `null` (It means the standard confirmation message will be used if confirmation is on).
`protected Map`	`getFlexibleSearchParameters(ActionEvent actionEvent)` Reads the flexible search query from the ActionEvent.
`protected String`	`getFlexibleSearchQuery(ActionEvent actionEvent)` Reads the flexible search query from the ActionEvent.
`protected GenericQuery`	`getGenericQuery(ActionEvent actionEvent)` Reads the generic search query from the ActionEvent if available.
`protected HMCContext`	`getHMCContext(ActionEvent actionEvent)`
`protected ComposedType`	`getItemType(ActionEvent actionEvent)` Reads item type from the ActionEvent.
`protected Map`	`getNodeParams()`
`protected List`	`getSelectedItems(ActionEvent actionEvent)` Reads the list of selected items from the ActionEvent.
`protected boolean`	`getUseSelectedOnly(ActionEvent actionEvent)` Reads the useSelectedOnly flag from the ActionEvent.
`boolean`	`hasDialogChip(AbstractActionChip actionChip)`
`void`	`initialize(SearchResultActionNode node)`
`boolean`	`isActive(ActionEvent actionEvent)`
`boolean`	`isVisible(ActionEvent actionEvent)`
`boolean`	`needConfirmation()` This default implementation returns `false`.
`abstract ActionResult`	`perform(ActionEvent actionEvent)` This action requires Map of parameters in ActionEvent data.
`protected SearchResult`	`search(String query, Map parameters, int start, int count, boolean dontNeedTotal)` Executes search via `FlexibleSearch`.

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

- Field Detail
  - ITEM_TYPE
```
public static final String ITEM_TYPE
```
    action parameter - the type of the item
    
    See Also:
    
    Constant Field Values
  - FLEXIBLESEARCH_QUERY
```
public static final String FLEXIBLESEARCH_QUERY
```
    action parameter - flexible search query String
    
    See Also:
    
    Constant Field Values
  - FLEXIBLESEARCH_PARAMETERS
```
public static final String FLEXIBLESEARCH_PARAMETERS
```
    action parameter - flexible search parameter map
    
    See Also:
    
    Constant Field Values
  - SELECTED_ITEMS
```
public static final String SELECTED_ITEMS
```
    action parameter - the list of currently selected items
    
    See Also:
    
    Constant Field Values
  - USE_SELECTED_ONLY
```
public static final String USE_SELECTED_ONLY
```
    action parameter - Boolean flag, use only the selected items when set to true
    
    See Also:
    
    Constant Field Values
  - GENERIC_QUERY
```
public static final String GENERIC_QUERY
```
    See Also:
    
    Constant Field Values
  - SEARCH_CONTEXT
```
public static final String SEARCH_CONTEXT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SearchResultAction
```
public SearchResultAction()
```
- Method Detail
  - initialize
```
public final void initialize(SearchResultActionNode node)
```
  - getNodeParams
```
protected Map getNodeParams()
```
  - getHMCContext
```
protected HMCContext getHMCContext(ActionEvent actionEvent)
```
  - perform
```
public abstract ActionResult perform(ActionEvent actionEvent)
                              throws JaloBusinessException
```
    This action requires Map of parameters in ActionEvent data.
    
    Specified by:
    
    perform in interface HMCAction
    
    Parameters:
    
    actionEvent -
    
    Returns:
    
    actionresult containing informations about the action's outcome
    
    Throws:
    
    JaloBusinessException
    
    See Also:
    
    ITEM_TYPE, FLEXIBLESEARCH_QUERY, FLEXIBLESEARCH_PARAMETERS, SELECTED_ITEMS, USE_SELECTED_ONLY
  - needConfirmation
```
public boolean needConfirmation()
```
    This default implementation returns false. Overwrite this method if you want confirmation for this action.
    
    Specified by:
    
    needConfirmation in interface HMCAction
  - getConfirmationMessage
```
public String getConfirmationMessage()
```
    This default implementation returns null (It means the standard confirmation message will be used if confirmation is on). Overwrite this method if you want your own confirmation message for this action.
    
    Specified by:
    
    getConfirmationMessage in interface HMCAction
  - getItemType
```
protected ComposedType getItemType(ActionEvent actionEvent)
```
    Reads item type from the ActionEvent.
    
    Parameters:
    
    actionEvent -
    
    Returns:
    
    item type from the given ActionEvent
  - getFlexibleSearchQuery
```
protected String getFlexibleSearchQuery(ActionEvent actionEvent)
```
    Reads the flexible search query from the ActionEvent.
    
    Parameters:
    
    actionEvent -
    
    Returns:
    
    the flexible search query from the given ActionEvent
  - getGenericQuery
```
protected GenericQuery getGenericQuery(ActionEvent actionEvent)
```
    Reads the generic search query from the ActionEvent if available.
    
    Parameters:
    
    actionEvent -
    
    Returns:
    
    the generic search query from the given ActionEvent
    
    Since:
    
    2.10
  - getFlexibleSearchParameters
```
protected Map getFlexibleSearchParameters(ActionEvent actionEvent)
```
    Reads the flexible search query from the ActionEvent.
    
    Parameters:
    
    actionEvent -
    
    Returns:
    
    the flexible search query from the given ActionEvent
  - getSelectedItems
```
protected List getSelectedItems(ActionEvent actionEvent)
```
    Reads the list of selected items from the ActionEvent.
    
    Parameters:
    
    actionEvent -
    
    Returns:
    
    the list of selected items from the given ActionEvent
  - getUseSelectedOnly
```
protected boolean getUseSelectedOnly(ActionEvent actionEvent)
```
    Reads the useSelectedOnly flag from the ActionEvent.
    
    Parameters:
    
    actionEvent -
    
    Returns:
    
    the useSelectedOnly flag from the given ActionEvent
  - search
```
protected SearchResult search(String query,
                              Map parameters,
                              int start,
                              int count,
                              boolean dontNeedTotal)
```
    Executes search via FlexibleSearch.
    Please note that this method does not work for viewtypes - use getAllItems(ActionEvent) instead to fetch all viewtype result items.
    
    Parameters:
    
    query -
    
    parameters -
    
    start -
    
    count -
    
    dontNeedTotal -
    
    Returns:
    
    search result
  - getAllItems
```
protected Collection<Item> getAllItems(ActionEvent actionEvent)
```
    Convenience method to fetch all items regardless of a selection is made or the complete item range is requested.
    
    Parameters:
    
    actionEvent - the action event
    
    Returns:
    
    the complete item collection which the action should be applied to
    
    Since:
    
    2.10
  - hasDialogChip
```
public boolean hasDialogChip(AbstractActionChip actionChip)
```
    Specified by:
    
    hasDialogChip in interface HMCAction
    
    Since:
    
    2.10
  - createDialogChip
```
public AbstractActionDialogChip createDialogChip(Chip parent,
                                                 AbstractActionChip actionChip)
```
    Specified by:
    
    createDialogChip in interface HMCAction
    
    Since:
    
    2.10
  - isActive
```
public boolean isActive(ActionEvent actionEvent)
```
    Specified by:
    
    isActive in interface HMCStatefulAction
    
    Returns:
    
    true if the action can be performed
    
    Since:
    
    3.00 (beta1)
  - isVisible
```
public boolean isVisible(ActionEvent actionEvent)
```
    Specified by:
    
    isVisible in interface HMCStatefulAction
    
    Since:
    
    3.00

Class SearchResultAction

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ITEM_TYPE

FLEXIBLESEARCH_QUERY

FLEXIBLESEARCH_PARAMETERS

SELECTED_ITEMS

USE_SELECTED_ONLY

GENERIC_QUERY

SEARCH_CONTEXT

Constructor Detail

SearchResultAction

Method Detail

initialize

getNodeParams

getHMCContext

perform

needConfirmation

getConfirmationMessage

getItemType

getFlexibleSearchQuery

getGenericQuery

getFlexibleSearchParameters

getSelectedItems

getUseSelectedOnly

search

getAllItems

hasDialogChip

createDialogChip

isActive

isVisible