Class SyncParameters
java.lang.Object
de.hybris.platform.outboundservices.facade.SyncParameters
Item synchronization parameters.
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedSyncParameters(ItemModel item, String ioCode, IntegrationObjectModel ioModel, String destId, ConsumedDestinationModel destModel, OutboundSource source) Deprecated, for removal: This API element is subject to removal in a future version. -
Method Summary
Modifier and TypeMethodDescriptionbooleanRetrieves the change idRetrieves destination to which data should be sent.Retrieves information about the destination, to which data should be sent.Retrieves type of the event that triggered outbound synchronization.Retrieves integration key value.Retrieves integration object used for outbound communication.Retrieves information about the integration object used for outbound communication.getItem()Deprecated, for removal: This API element is subject to removal in a future version.usegetPayloadObject()instead.This will return the payload object according to the integration object specs.Retrieves information about the module that initiated the data exchange with the destination.inthashCode()booleanDetermines whether the given SyncParameters supports outbound batch requests based on the type of IntegrationObject modeling.static SyncParametersBuilderReturns a builder for creation ofSyncParameters.toString()
-
Constructor Details
-
SyncParameters
@Deprecated(since="2211.FP1", forRemoval=true) protected SyncParameters(ItemModel item, String ioCode, IntegrationObjectModel ioModel, String destId, ConsumedDestinationModel destModel, OutboundSource source) Deprecated, for removal: This API element is subject to removal in a future version.useSyncParametersBuilderinstead.
-
-
Method Details
-
getItem
Deprecated, for removal: This API element is subject to removal in a future version.usegetPayloadObject()instead.This will return theItemModelas the payload object.- Returns:
- the item model, or
nullwhen the payload object is not of typeItemModel.
-
getPayloadObject
This will return the payload object according to the integration object specs. It can be traditionalItemModelor any POJO.- Returns:
- the payload object.
-
getIntegrationObjectCode
Retrieves information about the integration object used for outbound communication.- Returns:
- code of the integration object to be used.
-
getDestinationId
Retrieves information about the destination, to which data should be sent.- Returns:
- ID of the
ConsumedDestinationModelto send data to.
-
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
Retrieves destination to which data should be sent.- Returns:
- a destination representing a remote system receiving data.
-
getIntegrationObject
Retrieves integration object used for outbound communication.- Returns:
- integration object to be used.
-
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
Retrieves integration key value.- Returns:
- integration key of the item being synchronized.
-
getChangeId
Retrieves the change id- Returns:
- change id
-
isBatchSupported
public boolean isBatchSupported()Determines whether the given SyncParameters supports outbound batch requests based on the type of IntegrationObject modeling.- Returns:
true, if the integration object has no class types.false, otherwise.
-
syncParametersBuilder
Returns a builder for creation ofSyncParameters.- Returns:
- a builder to use for
SyncParameterscreation. Returned builder has empty state, that is noSyncParametersproperty is specified for it.
-
equals
-
hashCode
public int hashCode() -
toString
-
SyncParametersBuilderinstead.