AbstractGenericConditionalSearchChip (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

java.lang.Object
- de.hybris.platform.hmc.webchips.AbstractChip
- - de.hybris.platform.hmc.webchips.ListChip
  - - de.hybris.platform.hmc.generic.AbstractGenericConditionalSearchChip

All Implemented Interfaces:

ToolbarProvider, Chip, ChipEventListener, Serializable, Cloneable, EventListener

Direct Known Subclasses:

GenericConditionalSearchChip, OrganizerSearchChip
```
public abstract class AbstractGenericConditionalSearchChip
extends ListChip
implements ToolbarProvider, ChipEventListener
```
Searches for instances of types. Allows for sub type selection and various search options.

Version:

, checked in by $Author: max.friedmann $

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AbstractGenericConditionalSearchChip.SearchPerformer
Internal use!

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AbstractGenericConditionalSearchChip.SearchPerformer` Internal use!

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`FLEXIBLESEARCH`
`static String`	`GENERICSEARCH`
`static String`	`INCLUDE_SUBTYPES`
`static String`	`RESET_CONDITIONS`
`static String`	`SAVEDQUERY`
`static String`	`SEARCH`
`static String`	`SELECT_ATTRIBUTE`
`static String`	`SET_TYPE`
`static String`	`URI`

Fields inherited from class de.hybris.platform.hmc.webchips.ListChip
CLEAR, SELECT

Fields inherited from class de.hybris.platform.hmc.webchips.AbstractChip
CHIP_KEY, FALSE, FRAME_KEY, SHOW_JSP_COMMENTS, TRUE, USE_SOCKET_NAMING

Fields inherited from interface de.hybris.platform.hmc.webchips.Chip
DISPLAY_EVENT, FILTERED_PREFIX

Constructor Summary

Constructors
Constructor and Description
`AbstractGenericConditionalSearchChip(DisplayState displayState, TypedChip parent)` Creates new GenericConditionsSearchParametersChip

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCondition(FlexibleConditionChip chip)`
`protected void`	`addDefaultConditions()` Adds the defaultconditions to the conditionlist according to the configuration for the current type.
`void`	`addListEntryForDescriptor(AttributeDescriptor descriptor)` Adds a list entry (a condition chip) for the given attribute descriptor.
`void`	`addTypeChangeListener(ComposedTypeChangeListener listener)` Adds a `ComposedTypeChangeListener` to this chip which will be notified if the search type has been changed.
`boolean`	`canOpenType()`
`void`	`checkValid()` Gives the chip the possibility to check if its objects are still valid.
`boolean`	`containsCondition(String attributeName)` Returns true if there is already a conditionchip for the given attributename.
`AbstractToolbarChip`	`createToolbar()`
`protected void`	`executeSearch()`
`abstract void`	`flexibleSearch()`
`GenericConditionChip`	`getCondition(String attributeName)` Returns the first found condition chip for the given attributename or null if there is no such condition chip.
`String`	`getCurrentTypeCode()`
`String`	`getItemNotValidErrorMessage()` Returns a localized error message in case one or more list entries are not valid.
`ComposedType`	`getItemType()`
`String`	`getJSPURI()` Returns the jsp uri to use for this chip.
`protected String`	`getProposedUniqueName()`
`SavedQuery`	`getSavedQuery()` Returns the currently selected SavedQuery for this search chip.
`protected SearchNode`	`getSearchNode()`
`ComposedType`	`getSearchType()`
`String`	`getTitle()`
`AbstractToolbarChip`	`getToolbar()`
`Collection<ComposedTypeChangeListener>`	`getTypeChangeListeners()`
`protected TypedChip`	`getTypedChip()`
`List`	`getTypeEntries()` Returns a list of `TypeEntry` instances
`boolean`	`hasEmptySearchConditionInAView()` If in a search chip for a ViewType a search condition is empty this method returns true. If all search conditions are set the return value is false and in the jsp the XPButton will not be disabled.
`boolean`	`hasSubtypes()` If a Type has Subtypes this method returns `true`.
`boolean`	`isFlexibleSearchMode()`
`boolean`	`isIncludeSubtypes()`
`boolean`	`isMultipleSelectionAllowed()` This is to differentiate between multiple chip selection or single chip selection.
`boolean`	`isNewSearch()`
`void`	`notify(ChipEvent event)`
`protected void`	`notifyTypeChange(ComposedTypeChangeEvent typeChangeEvent)` Notifies all registered `ComposedTypeChangeListeners` of the type change using the given `ComposedTypeChangeEvent`.
`void`	`processEvents(Map<String,List<String>> events)` Handles all incoming requests for this chip.
`protected void`	`resetConditions()`
`abstract void`	`search()`
`void`	`selectSearch(SavedQuery savedQuery)`
`void`	`setFlexibleSearchMode(boolean flexibleSearchMode)`
`void`	`setIncludeSubtypes(boolean include)`
`void`	`setSavedQuery(SavedQuery savedQuery)`
`void`	`setSearchParameters(GenericSearchContainer container)`
`void`	`setSearchType(ComposedType type)`
`void`	`setTitle(String headline)`
`void`	`setToolbar(AbstractToolbarChip toolbar)`

Methods inherited from class de.hybris.platform.hmc.webchips.ListChip
addListEntry, addSelectedListEntries, addSelectedListEntry, clearListEntries, clearSelectedListEntries, getListEntries, getListEntryCount, getPosition, getSelectedListEntries, getSelectedListEntryCount, hasFancyRows, isListEntrySelected, moveDown, moveUp, removeListEntry, setFancyRows, setMultipleSelection, setMultipleSelectionAllowed, sort, sort

Methods inherited from class de.hybris.platform.hmc.webchips.AbstractChip
addEventListener, clearInfoMessages, clone, containsDisplayEvent, createMenuEntriesForJS, dispose, errorQueueEmpty, getClipboard, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getFrame, getID, getInfoMessages, getJaloSession, getLocalizedString, getLocalizedString, getLogger, getMenuEntries, getNameSpace, getNameSpaceFor, getParent, getProposedUniqueNameFor, getRequestFocus, getSessionIdentifier, getStringValue, getUniqueName, getWindow, goFullScreen, hasVisibleContextMenuEntries, isButtonPushed, isButtonPushed, isErrorQueueEmpty, isValid, leaveFullScreen, notifyEventListeners, notifyEventListeners, postErrorMessage, postInfoMessage, postWindowEvent, refresh, refreshChild, registerUniqueName, removeEventListener, removeInfoMessage, render, render, setClipboard, setParent, setRequestFocus, setValid, setWindowStatus, translateFormFieldToEventName, translateFormFieldToEventValue

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

Methods inherited from interface de.hybris.platform.hmc.webchips.Chip
addEventListener, dispose, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getID, getJaloSession, getMenuEntries, getParent, getUniqueName, goFullScreen, isValid, leaveFullScreen, registerUniqueName, removeEventListener, render, translateFormFieldToEventName, translateFormFieldToEventValue

- Field Detail
  - URI
```
public static final String URI
```
    See Also:
    
    Constant Field Values
  - SET_TYPE
```
public static final String SET_TYPE
```
    See Also:
    
    Constant Field Values
  - SEARCH
```
public static final String SEARCH
```
    See Also:
    
    Constant Field Values
  - SELECT_ATTRIBUTE
```
public static final String SELECT_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
  - FLEXIBLESEARCH
```
public static final String FLEXIBLESEARCH
```
    See Also:
    
    Constant Field Values
  - GENERICSEARCH
```
public static final String GENERICSEARCH
```
    See Also:
    
    Constant Field Values
  - RESET_CONDITIONS
```
public static final String RESET_CONDITIONS
```
    See Also:
    
    Constant Field Values
  - SAVEDQUERY
```
public static final String SAVEDQUERY
```
    See Also:
    
    Constant Field Values
  - INCLUDE_SUBTYPES
```
public static final String INCLUDE_SUBTYPES
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractGenericConditionalSearchChip
```
public AbstractGenericConditionalSearchChip(DisplayState displayState,
                                            TypedChip parent)
```
    Creates new GenericConditionsSearchParametersChip
- Method Detail
  - checkValid
```
public void checkValid()
```
    Description copied from class: AbstractChip
    
    Gives the chip the possibility to check if its objects are still valid. If you override this method, call super.checkValid()
    
    Specified by:
    
    checkValid in interface Chip
    
    Overrides:
    
    checkValid in class ListChip
  - search
```
public abstract void search()
```
  - flexibleSearch
```
public abstract void flexibleSearch()
```
  - getSearchType
```
public ComposedType getSearchType()
```
  - setSearchType
```
public void setSearchType(ComposedType type)
```
  - processEvents
```
public void processEvents(Map<String,List<String>> events)
```
    Handles all incoming requests for this chip. Map contains name (String) and value (List of Strings)
    
    Specified by:
    
    processEvents in interface Chip
    
    Overrides:
    
    processEvents in class ListChip
  - notify
```
public void notify(ChipEvent event)
```
    Specified by:
    
    notify in interface ChipEventListener
    
    Since:
    
    2.30
  - executeSearch
```
protected void executeSearch()
```
    Since:
    
    2.20
  - getTypeEntries
```
public List getTypeEntries()
```
    Returns a list of TypeEntry instances
  - getCurrentTypeCode
```
public String getCurrentTypeCode()
```
  - addCondition
```
public void addCondition(FlexibleConditionChip chip)
```
  - containsCondition
```
public boolean containsCondition(String attributeName)
```
    Returns true if there is already a conditionchip for the given attributename.
  - getCondition
```
public GenericConditionChip getCondition(String attributeName)
```
    Returns the first found condition chip for the given attributename or null if there is no such condition chip.
    
    Returns:
    
    the first found condition chip for the given attributename or null if there is no such condition chip.
  - addDefaultConditions
```
protected void addDefaultConditions()
```
    Adds the defaultconditions to the conditionlist according to the configuration for the current type.
    
    Since:
    
    2.10 (used to be private)
  - getSearchNode
```
protected SearchNode getSearchNode()
```
    Since:
    
    3.0 M2
  - addListEntryForDescriptor
```
public void addListEntryForDescriptor(AttributeDescriptor descriptor)
```
    Adds a list entry (a condition chip) for the given attribute descriptor.
    
    Parameters:
    
    descriptor -
    
    Since:
    
    2.20 SP1
  - setSearchParameters
```
public void setSearchParameters(GenericSearchContainer container)
```
  - getItemType
```
public ComposedType getItemType()
```
  - getItemNotValidErrorMessage
```
public String getItemNotValidErrorMessage()
```
    Returns a localized error message in case one or more list entries are not valid. Might return null which would lead to no message displayed.
    
    Specified by:
    
    getItemNotValidErrorMessage in class ListChip
  - isMultipleSelectionAllowed
```
public boolean isMultipleSelectionAllowed()
```
    Description copied from class: ListChip
    
    This is to differentiate between multiple chip selection or single chip selection.
    
    Overrides:
    
    isMultipleSelectionAllowed in class ListChip
  - isNewSearch
```
public boolean isNewSearch()
```
  - getTitle
```
public String getTitle()
```
  - setTitle
```
public void setTitle(String headline)
```
  - resetConditions
```
protected void resetConditions()
```
  - getTypedChip
```
protected TypedChip getTypedChip()
```
  - getToolbar
```
public AbstractToolbarChip getToolbar()
```
    Specified by:
    
    getToolbar in interface ToolbarProvider
  - setToolbar
```
public void setToolbar(AbstractToolbarChip toolbar)
```
  - createToolbar
```
public AbstractToolbarChip createToolbar()
```
    Specified by:
    
    createToolbar in interface ToolbarProvider
  - canOpenType
```
public boolean canOpenType()
```
  - getJSPURI
```
public String getJSPURI()
```
    Returns the jsp uri to use for this chip.
    
    Specified by:
    
    getJSPURI in interface Chip
  - selectSearch
```
public void selectSearch(SavedQuery savedQuery)
```
  - getSavedQuery
```
public SavedQuery getSavedQuery()
```
    Returns the currently selected SavedQuery for this search chip.
    
    Returns:
    
    the currently selected SavedQuery for this search chip.
  - setSavedQuery
```
public void setSavedQuery(SavedQuery savedQuery)
```
  - isFlexibleSearchMode
```
public boolean isFlexibleSearchMode()
```
  - setFlexibleSearchMode
```
public void setFlexibleSearchMode(boolean flexibleSearchMode)
```
  - isIncludeSubtypes
```
public boolean isIncludeSubtypes()
```
    Returns:
    
    true if subtypes should be included in search
  - setIncludeSubtypes
```
public void setIncludeSubtypes(boolean include)
```
    Parameters:
    
    include - if true subtypes will be searched, too
  - hasEmptySearchConditionInAView
```
public boolean hasEmptySearchConditionInAView()
```
    If in a search chip for a ViewType a search condition is empty this method returns true.
    If all search conditions are set the return value is false and in the jsp the XPButton will not be disabled.
    
    Returns:
    
    a value
  - hasSubtypes
```
public boolean hasSubtypes()
```
    If a Type has Subtypes this method returns true. False otherwise.
    
    Returns:
    
    a boolean
  - getProposedUniqueName
```
protected String getProposedUniqueName()
```
    Overrides:
    
    getProposedUniqueName in class AbstractChip
  - getTypeChangeListeners
```
public Collection<ComposedTypeChangeListener> getTypeChangeListeners()
```
    Returns:
    
    the list of ComposedTypeChangeListeners which have been registered to this chip
    
    Since:
    
    3.0 M2
  - addTypeChangeListener
```
public void addTypeChangeListener(ComposedTypeChangeListener listener)
```
    Adds a ComposedTypeChangeListener to this chip which will be notified if the search type has been changed.
    
    Parameters:
    
    listener - the ComposedTypeChangeListener to register with this chip
    
    Since:
    
    3.0 M2
  - notifyTypeChange
```
protected void notifyTypeChange(ComposedTypeChangeEvent typeChangeEvent)
```
    Notifies all registered ComposedTypeChangeListeners of the type change using the given ComposedTypeChangeEvent.
    
    Parameters:
    
    typeChangeEvent - the event which is associated with the recent type change
    
    Since:
    
    3.0 M2

Class AbstractGenericConditionalSearchChip

Nested Class Summary

Field Summary

Fields inherited from class de.hybris.platform.hmc.webchips.ListChip

Fields inherited from class de.hybris.platform.hmc.webchips.AbstractChip

Fields inherited from interface de.hybris.platform.hmc.webchips.Chip

Constructor Summary

Method Summary

Methods inherited from class de.hybris.platform.hmc.webchips.ListChip

Methods inherited from class de.hybris.platform.hmc.webchips.AbstractChip

Methods inherited from class java.lang.Object

Methods inherited from interface de.hybris.platform.hmc.webchips.Chip

Field Detail

URI

SET_TYPE

SEARCH

SELECT_ATTRIBUTE

FLEXIBLESEARCH

GENERICSEARCH

RESET_CONDITIONS

SAVEDQUERY

INCLUDE_SUBTYPES

Constructor Detail

AbstractGenericConditionalSearchChip

Method Detail

checkValid

search

flexibleSearch

getSearchType

setSearchType

processEvents

notify

executeSearch

getTypeEntries

getCurrentTypeCode

addCondition

containsCondition

getCondition

addDefaultConditions

getSearchNode

addListEntryForDescriptor

setSearchParameters

getItemType

getItemNotValidErrorMessage

isMultipleSelectionAllowed

isNewSearch

getTitle

setTitle

resetConditions

getTypedChip

getToolbar

setToolbar

createToolbar

canOpenType

getJSPURI

selectSearch

getSavedQuery

setSavedQuery

isFlexibleSearchMode

setFlexibleSearchMode

isIncludeSubtypes

setIncludeSubtypes

hasEmptySearchConditionInAView

hasSubtypes

getProposedUniqueName

getTypeChangeListeners

addTypeChangeListener

notifyTypeChange