Package de.hybris.platform.outboundservices.decorator

Class DecoratorContext

java.lang.Object

de.hybris.platform.outboundservices.decorator.DecoratorContext

public class DecoratorContext
extends Object

Context that is used to hold & transfer data pertaining to outbound requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DecoratorContext.DecoratorContextBuilder	Deprecated, for removal: This API element is subject to removal in a future version. use DecoratorContextBuilder instead

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DecoratorContext()	Deprecated, for removal: This API element is subject to removal in a future version. use DecoratorContext(ItemModel, IntegrationObjectDescriptor, ConsumedDestinationModel, OutboundSource, Collection) instead
protected	DecoratorContext(ItemModel item, @NotNull IntegrationObjectDescriptor io, @NotNull ConsumedDestinationModel destination, OutboundSource source, Collection<String> errors)	Deprecated, for removal: This API element is subject to removal in a future version. Use DecoratorContextBuilder to create instances.

Method Summary

Modifier and Type	Method	Description
static DecoratorContext.DecoratorContextBuilder	decoratorContextBuilder()
@NotNull ConsumedDestinationModel	getDestinationModel()	Retrieves destination, to which the item should be sent.
@NotNull Collection<String>	getErrors()	Retrieves a list of errors that indicate why this context is not valid or returns an empty list.
EventType	getEventType()	Retrieves EventType of the value
@NotNull HttpMethod	getHttpMethod()	Retrieves httpMethod of the item synchronization.
String	getIntegrationKey()
@NotNull IntegrationObjectDescriptor	getIntegrationObject()	Retrieves the GeneratedIntegrationObject.getCode() value.
String	getIntegrationObjectCode()	A convenience/shortcut method for retrieving the context integration object code.
Optional<TypeDescriptor>	getIntegrationObjectItem()	Retrieves integration object item type descriptor for the context integration object and item model.
String	getIntegrationObjectItemCode()	Deprecated, for removal: This API element is subject to removal in a future version. No longer used.
ItemModel	getItemModel()	Retrieves the item model under concern.
@NotNull OutboundSource	getSource()	Retrieves source of the item synchronization.
@javax.validation.constraints.NotNull boolean	hasErrors()	Retrieves a value indicating if this context is valid based off the presence of errors.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DecoratorContext

@Deprecated(since="2011.0",
            forRemoval=true)
protected DecoratorContext()

Deprecated, for removal: This API element is subject to removal in a future version.

use DecoratorContext(ItemModel, IntegrationObjectDescriptor, ConsumedDestinationModel, OutboundSource, Collection) instead

DecoratorContext

@Deprecated(since="2105",
            forRemoval=true)
protected DecoratorContext(ItemModel item,
 @NotNull
 @NotNull IntegrationObjectDescriptor io,
 @NotNull
 @NotNull ConsumedDestinationModel destination,
 OutboundSource source,
 Collection<String> errors)

Deprecated, for removal: This API element is subject to removal in a future version.

Use DecoratorContextBuilder to create instances.

Instantiates a new context.

Parameters:

item - item model being synchronized to an external system.

io - integration object that governs the item presentation in the external system

destination - destination where the item is being sent.

source - platform module that is performing the item synchronization. If value is not provided, i.e. it is null, then a default value of OutboundSource.UNKNOWN is used.

errors - errors that will be included in the monitoring request if any are present

Method Details

decoratorContextBuilder

public static DecoratorContext.DecoratorContextBuilder decoratorContextBuilder()

getItemModel

public ItemModel getItemModel()

Retrieves the item model under concern.

Returns:

item model

getIntegrationObject

@NotNull
public @NotNull IntegrationObjectDescriptor getIntegrationObject()

Retrieves the GeneratedIntegrationObject.getCode() value.

Returns:

integration object code

getIntegrationObjectCode

public String getIntegrationObjectCode()

A convenience/shortcut method for retrieving the context integration object code. Calling this method is same as getIntegrationObject().getCode()

Returns:

code of the context integration object.

getIntegrationObjectItem

public Optional<TypeDescriptor> getIntegrationObjectItem()

Retrieves integration object item type descriptor for the context integration object and item model.

Returns:

an Optional containing a TypeDescriptor, if the integration object contains at least one item for the context item model type. I.e. there is a integration object item model matching the getItemModel().getItemtype(). Otherwise, an Optional.empty() is returned.

getIntegrationObjectItemCode

@Deprecated(since="2011.0",
            forRemoval=true)
public String getIntegrationObjectItemCode()

Deprecated, for removal: This API element is subject to removal in a future version.

No longer used. Use getIntegrationObjectItem() instead.

getDestinationModel

@NotNull
public @NotNull ConsumedDestinationModel getDestinationModel()

Retrieves destination, to which the item should be sent.

Returns:

consumed destination

getErrors

@NotNull
public @NotNull Collection<String> getErrors()

Retrieves a list of errors that indicate why this context is not valid or returns an empty list.

Returns:

a list of errors

hasErrors

@NotNull
public @javax.validation.constraints.NotNull boolean hasErrors()

Retrieves a value indicating if this context is valid based off the presence of errors.

Returns:

true if this context has errors, else false

getSource

@NotNull
public @NotNull OutboundSource getSource()

Retrieves source of the item synchronization.

Returns:

a platform module that sends the item to external system.

getEventType

public EventType getEventType()

Retrieves EventType of the value

Returns:

value of event type

getHttpMethod

@NotNull
public @NotNull HttpMethod getHttpMethod()

Retrieves httpMethod of the item synchronization.

Returns:

httpMethod for the delta being sent

getIntegrationKey

public String getIntegrationKey()