de.hybris.platform.adaptivesearchbackoffice.editors.configurablemultireference

Interface DataHandler<D extends AbstractEditorData,M extends ItemModel>

Type Parameters:

D - - the type of the editor data

M - - the type of the model

All Known Implementing Classes:

AbstractDataHandler, AsBoostRulesDataHandler, AsExcludedFacetsDataHandler, AsExcludedItemsDataHandler, AsFacetsDataHandler, AsPromotedFacetsDataHandler, AsPromotedItemsDataHandler

public interface DataHandler<D extends AbstractEditorData,M extends ItemModel>

Data handler for the generic configurable reference editor.

Method Summary

Modifier and Type	Method and Description
void	addReference(M model) Adds a new reference to the data handler.
void	deleteReference(D data) Deletes a reference from the data handler.
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.
java.lang.String	getTypeCode() Returns the type code for the model.
java.util.List<M>	getValue() Returns the current value.
<any>	loadData(java.util.List<M> initialValue, SearchResultData searchResult, java.util.Map<java.lang.String,java.lang.Object> parameters) Initializes the data handler with new data.
void	moveReference(D data, int index) Move the reference from it's current location to the new index location.
void	setAttributeValue(D data, java.lang.String attributeName, java.lang.Object value) 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.List<M> 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.List<M> getValue()

Returns the current value.

Returns:

the current value

getAttributeValue

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

Extracts an attribute value from a specific editor data object.

Parameters:

data - - the editor data object.

attributeName - - the attribute name

Returns:

the attribute 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 editor data object.

attributeName - - the attribute name

Returns:

the attribute class

moveReference

void moveReference(D data,
                   int index)

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

setAttributeValue

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

Sets an attribute value to a specific data object.

Parameters:

data - - the data object.

attributeName - - the attribute name

value - - new attribute value

addReference

void addReference(M model)

Adds a new reference to the data handler.

Parameters:

model - - the model object

deleteReference

void deleteReference(D data)

Deletes a reference from the data handler.

Parameters:

data - - the editor data object