Package com.broadleafcommerce.dataexchange.service

Class HandlerArgs<T1 extends ExchangeObject,T2 extends ExchangeObject>

java.lang.Object
com.broadleafcommerce.dataexchange.service.HandlerArgs<T1,T2>
Type Parameters:
T1 -
T2 -
public class HandlerArgs<T1 extends ExchangeObject,T2 extends ExchangeObject> extends Object
DTO for passing arguments to BatchItemHandler.handle(HandlerArgs).

  • Constructor Details

    • HandlerArgs

      public HandlerArgs(T1 topLevelEntity, T2 beforeSaveItem, BatchContext<T1> batchContext, org.springframework.core.task.AsyncTaskExecutor executor, org.springframework.retry.support.RetryTemplate retryTemplate)

    • HandlerArgs

      public HandlerArgs(T1 topLevelEntity, T2 beforeSaveItem, @Nullable T2 savedItem, BatchContext<T1> batchContext, BatchItemOperationType operationType, org.springframework.core.task.AsyncTaskExecutor executor, org.springframework.retry.support.RetryTemplate retryTemplate)

    • HandlerArgs

      public HandlerArgs()

  • Method Details

    • getProperty

      public <T> T getProperty(String key)
      Get a property for this specific handler.
      Parameters:
      key - the key of the property
      Returns:
      the value of the property

    • setProperty

      public void setProperty(String key, Object value)
      Set a property for this specific handler.
      Parameters:
      key - the key of the property
      value - the value of the property

    • getTopLevelEntity

      public T1 getTopLevelEntity()
      The parent item that the item being saved belongs to.

    • getBeforeSaveItem

      public T2 getBeforeSaveItem()
      The item that is being saved. It is the item received from the caller.

    • getSavedItem

      @Nullable public T2 getSavedItem()
      The item that was saved. By default, this will only be populated after BatchItemHandler.handle(HandlerArgs) has been executed.

    • getBatchContext

      public BatchContext<T1> getBatchContext()
      The batch context that the item is being saved in.

    • getProperties

      public Map<String,Object> getProperties()
      Additional properties that can be used to pass information between steps in the handler.

    • getOperationType

      public BatchItemOperationType getOperationType()
      The type of operation that is being performed on the item. See BatchItemHandler.handle(HandlerArgs).

    • getExecutor

      public org.springframework.core.task.AsyncTaskExecutor getExecutor()
      The executor that should be used to run asynchronous tasks.

    • getRetryTemplate

      public org.springframework.retry.support.RetryTemplate getRetryTemplate()
      The retry template that should be used to retry operations.

    • setTopLevelEntity

      public void setTopLevelEntity(T1 topLevelEntity)
      The parent item that the item being saved belongs to.

    • setBeforeSaveItem

      public void setBeforeSaveItem(T2 beforeSaveItem)
      The item that is being saved. It is the item received from the caller.

    • setSavedItem

      public void setSavedItem(@Nullable T2 savedItem)
      The item that was saved. By default, this will only be populated after BatchItemHandler.handle(HandlerArgs) has been executed.

    • setBatchContext

      public void setBatchContext(BatchContext<T1> batchContext)
      The batch context that the item is being saved in.

    • setOperationType

      public void setOperationType(BatchItemOperationType operationType)
      The type of operation that is being performed on the item. See BatchItemHandler.handle(HandlerArgs).

    • setExecutor

      public void setExecutor(org.springframework.core.task.AsyncTaskExecutor executor)
      The executor that should be used to run asynchronous tasks.

    • setRetryTemplate

      public void setRetryTemplate(org.springframework.retry.support.RetryTemplate retryTemplate)
      The retry template that should be used to retry operations.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object