com.adobe.cq.commerce.api

Interface OrderHistoryTraitDataProvider

@ProviderType
public interface OrderHistoryTraitDataProvider

OrderHistoryTraitDataProvider is a service interface for services which process the order history to extract relevant data and provide it for a given order history trait. The provided data is placed in the orderhistory context store where the related order history trait can access it for evaluation. Implementations of this service should follow certain rules (see getTraitData(PlacedOrderResult)) to ensure that the data can be rendered in a human readable manner in the client context by the provided orderhistory context store renderer. A trait can access in the client context the data returned by getTraitData(PlacedOrderResult) using its jsObject parameter with the following value: clientcontext.orderhistory.traits.identifier.data, where identifier is the string returned by getIdentifier().

Method Summary

Modifier and Type	Method and Description
java.lang.String	getIdentifier() Returns the string identifier of the trait for which this service is providing data.
java.lang.String	getName() Returns a human readable name of the related trait.
java.lang.Object	getTraitData(PlacedOrderResult result) Extracts data from order history relevant to the trait.

Method Detail

getIdentifier

java.lang.String getIdentifier()

Returns the string identifier of the trait for which this service is providing data. It will be used as a JavaScript object property in the trait.

Returns:

the order history trait identifier

getName

java.lang.String getName()

Returns a human readable name of the related trait. Used as a label in the client context when rendering the trait data.

Returns:

the name of the trait

getTraitData

java.lang.Object getTraitData(PlacedOrderResult result)
                       throws CommerceException

Extracts data from order history relevant to the trait. The extracted data should be minimal, focused, most often of statistical nature and strictly targeted to the needs of the related trait. Returning the order history or large parts of it can have undesired implications regarding storage, network traffic and security therefor it should be avoided. The data returned by this method can be Object, Collection<Object> and Map<String, Object> where Object should be a String or other data type which represents an atomic value having concise string representation provided by toString(). These return values are supported by the client context render.

Parameters:

result - the order history

Returns:

the extracted data

Throws:

CommerceException