Package com.broadleafcommerce.datafeed.service.publisher.file.support

Class DataFeedFileTransformResponseDetails

java.lang.Object
com.broadleafcommerce.datafeed.service.publisher.file.support.DataFeedFileTransformResponseDetails
public class DataFeedFileTransformResponseDetails extends Object
A payload describing the results of a DataFeedFileTransformer.transform(FilePublishContext) operation.

  • Constructor Details

    • DataFeedFileTransformResponseDetails

      public DataFeedFileTransformResponseDetails()

  • Method Details

    • isResultShouldBeSubmitted

      public boolean isResultShouldBeSubmitted()
      In some rare cases, the transform step may find that it naturally didn't have any data to operate on, or didn't have any data to write after transformation. In such cases, the final file would be empty, and thus we should not upload anything to the remote provider and simply exit with success. This flag should be set to true in such cases.
      Returns:
      whether the resulting file from the transform step should be submitted to the destination provider

    • isContainsErrors

      public boolean isContainsErrors()
      A simple flag indicating whether the file transformation process encountered any errors.
      Returns:
      whether this file transformation process experienced errors
      See Also:

    • getErrorDetails

      public List<String> getErrorDetails()
      If errors are encountered during the run of this file transformation process (ex: isContainsErrors() is true), details should be added here. Otherwise, this will be empty.
      Returns:
      details about any errors experienced by this file transformation process
      See Also:

    • setResultShouldBeSubmitted

      public void setResultShouldBeSubmitted(boolean resultShouldBeSubmitted)
      In some rare cases, the transform step may find that it naturally didn't have any data to operate on, or didn't have any data to write after transformation. In such cases, the final file would be empty, and thus we should not upload anything to the remote provider and simply exit with success. This flag should be set to true in such cases.
      Parameters:
      resultShouldBeSubmitted - whether the resulting file from the transform step should be submitted to the destination provider

    • setContainsErrors

      public void setContainsErrors(boolean containsErrors)
      A simple flag indicating whether the file transformation process encountered any errors.
      Parameters:
      containsErrors - whether this file transformation process experienced errors
      See Also:

    • setErrorDetails

      public void setErrorDetails(List<String> errorDetails)
      If errors are encountered during the run of this file transformation process (ex: isContainsErrors() is true), details should be added here. Otherwise, this will be empty.
      Parameters:
      errorDetails - details about any errors experienced by this file transformation process
      See Also:

    • 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