de.hybris.platform.adaptivesearchbackoffice.editors.configurablemultireference

Interface DataHandler<D extends AbstractEditorData,V>

Type Parameters:

D - - the type of the item data

V - - the type of the item value

All Known Implementing Classes:

AbstractDataHandler, AsBoostRulesDataHandler, AsExcludedFacetsDataHandler, AsExcludedItemsDataHandler, AsExcludedSortsDataHandler, AsFacetsDataHandler, AsPromotedFacetsDataHandler, AsPromotedItemsDataHandler, AsPromotedSortsDataHandler, AsSortsDataHandler

public interface DataHandler<D extends AbstractEditorData,V>

Data handler for the generic configurable reference editor.

Method Summary

Modifier and Type	Method and Description
default void	addReference(V model) Deprecated. Since 6.7, instances of DataHandler should be stateless.
default void	deleteReference(D data) Deprecated. Since 6.7, instances of DataHandler should be stateless.
java.lang.Class<?>	getAttributeType(D data, java.lang.String attributeName) Extracts an attribute class from a specific editor data object.
java.lang.Object	getAttributeValue(D data, java.lang.String attributeName) Extracts an attribute value from a specific editor data object.
V	getItemValue(D data) Returns the value for a single item.
java.lang.String	getTypeCode() Returns the type code for the model.
default java.util.List<V>	getValue() Deprecated. Since 6.7, instances of DataHandler should be stateless (an empty should be returned).
java.util.Collection<V>	getValue(<any> data) Returns the value.
<any>	loadData(java.util.Collection<V> initialValue, SearchResultData searchResult, java.util.Map<java.lang.String,java.lang.Object> parameters) Initializes the data handler with new data.
default void	moveReference(D data, int index) Deprecated. Since 6.7, instances of DataHandler should be stateless.
void	setAttributeValue(D data, java.lang.String attributeName, java.lang.Object attributeValue) Sets an attribute value to a specific data object.

Method Detail

getTypeCode

java.lang.String getTypeCode()

Returns the type code for the model.

Returns:

the type code

loadData

<any> loadData(java.util.Collection<V> initialValue,
               SearchResultData searchResult,
               java.util.Map<java.lang.String,java.lang.Object> parameters)

Initializes the data handler with new data.

Parameters:

initialValue - - the initial value

searchResult - - the search result

parameters - - the data handler parameters

Returns:

the data

getValue

java.util.Collection<V> getValue(<any> data)

Returns the value.

Parameters:

data - - the data object

Returns:

the current value

Since:

6.7

getItemValue

V getItemValue(D data)

Returns the value for a single item.

Parameters:

data - - the data object

Returns:

the current value

Since:

6.7

getValue

@Deprecated
default java.util.List<V> getValue()

Deprecated. Since 6.7, instances of DataHandler should be stateless (an empty should be returned).

Returns the current value.

Returns:

the current value

getAttributeType

java.lang.Class<?> getAttributeType(D data,
                                    java.lang.String attributeName)

Extracts an attribute class from a specific editor data object.

Parameters:

data - - the data object

attributeName - - the attribute name

Returns:

the attribute class

getAttributeValue

java.lang.Object getAttributeValue(D data,
                                   java.lang.String attributeName)

Extracts an attribute value from a specific editor data object.

Parameters:

data - - the data object

attributeName - - the attribute name

Returns:

the attribute value

setAttributeValue

void setAttributeValue(D data,
                       java.lang.String attributeName,
                       java.lang.Object attributeValue)

Sets an attribute value to a specific data object.

Parameters:

data - - the data object.

attributeName - - the attribute name

attributeValue - - new attribute value

addReference

@Deprecated
default void addReference(V model)

Deprecated. Since 6.7, instances of DataHandler should be stateless.

Adds a new reference to the data handler.

Parameters:

model - - the model object

moveReference

@Deprecated
default void moveReference(D data,
                                       int index)

Deprecated. Since 6.7, instances of DataHandler should be stateless.

Move the reference from it's current location to the new index location.

Parameters:

data - - the data object

index - - the index to be inserted at

deleteReference

@Deprecated
default void deleteReference(D data)

Deprecated. Since 6.7, instances of DataHandler should be stateless.

Deletes a reference from the data handler.

Parameters:

data - - the data object