Package de.hybris.platform.outboundservices.facade

Class SyncParameters

java.lang.Object

de.hybris.platform.outboundservices.facade.SyncParameters

public class SyncParameters
extends Object

Item synchronization parameters.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SyncParameters.SyncParametersBuilder	Deprecated, for removal: This API element is subject to removal in a future version. Use SyncParametersBuilder instead.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SyncParameters(ItemModel item, String ioCode, IntegrationObjectModel ioModel, String destId, ConsumedDestinationModel destModel, OutboundSource source)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ConsumedDestinationModel	getDestination()	Retrieves destination to which data should be sent.
String	getDestinationId()	Retrieves information about the destination, to which data should be sent.
EventType	getEventType()	Retrieves type of the event that triggered outbound synchronization.
String	getIntegrationKey()	Retrieves integration key value.
IntegrationObjectModel	getIntegrationObject()	Retrieves integration object used for outbound communication.
String	getIntegrationObjectCode()	Retrieves information about the integration object used for outbound communication.
ItemModel	getItem()
OutboundSource	getSource()	Retrieves information about the module that initiated the data exchange with the destination.
int	hashCode()
static SyncParameters.SyncParametersBuilder	syncParametersBuilder()	Returns a builder for creation of SyncParameters.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SyncParameters

protected SyncParameters(ItemModel item,
 String ioCode,
 IntegrationObjectModel ioModel,
 String destId,
 ConsumedDestinationModel destModel,
 OutboundSource source)

Method Details

getItem

public ItemModel getItem()

getIntegrationObjectCode

public String getIntegrationObjectCode()

Retrieves information about the integration object used for outbound communication.

Returns:

code of the integration object to be used.

getDestinationId

public String getDestinationId()

Retrieves information about the destination, to which data should be sent.

Returns:

ID of the ConsumedDestinationModel to send data to.

getSource

public OutboundSource getSource()

Retrieves information about the module that initiated the data exchange with the destination.

Returns:

module that sends data to the remote system.

See Also:

• getDestination()

getDestination

public ConsumedDestinationModel getDestination()

Retrieves destination to which data should be sent.

Returns:

a destination representing a remote system receiving data.

getIntegrationObject

public IntegrationObjectModel getIntegrationObject()

Retrieves integration object used for outbound communication.

Returns:

integration object to be used.

getEventType

public EventType getEventType()

Retrieves type of the event that triggered outbound synchronization.

Returns:

type of the event or DefaultEventType.UNKNOWN, if the synchronization is not triggered by event but is a scheduled batch synchronization.

getIntegrationKey

public String getIntegrationKey()

Retrieves integration key value.

Returns:

integration key of the item being synchronized.

syncParametersBuilder

public static SyncParameters.SyncParametersBuilder syncParametersBuilder()

Returns a builder for creation of SyncParameters.

Returns:

a builder to use for SyncParameters creation. Returned builder has empty state, that is no SyncParameters property is specified for it.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object