Class SyncParameters

java.lang.Object
de.hybris.platform.outboundservices.facade.SyncParameters

public class SyncParameters extends Object
Item synchronization parameters.
  • Constructor Details

  • Method Details

    • getItem

      @Deprecated(since="2211.FP1", forRemoval=true) @Nullable public ItemModel getItem()
      Deprecated, for removal: This API element is subject to removal in a future version.
      use getPayloadObject() instead.
      This will return the ItemModel as the payload object.
      Returns:
      the item model, or null when the payload object is not of type ItemModel.
    • getPayloadObject

      public Object getPayloadObject()
      This will return the payload object according to the integration object specs. It can be traditional ItemModel or any POJO.
      Returns:
      the payload object.
    • 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

      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.
    • getChangeId

      public String 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

      public static 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