Package com.broadleafcommerce.orchestration.client

Class HistoryElement

java.lang.Object
com.broadleafcommerce.orchestration.client.HistoryElement
public class HistoryElement extends Object
Specific start, end, status, and optional failure information for every SimpleActivity executed in a SimpleWorkflow, and every workflow start and exit.

  • Constructor Details

  • Method Details

    • withLogs

      public HistoryElement withLogs(Map<String,String> logs)

    • withIgnoreOnReplay

      public HistoryElement withIgnoreOnReplay(boolean ignoreOnReplay)

    • withIdentifier

      public HistoryElement withIdentifier(String identifier)

    • getIdentifier

      public String getIdentifier()
      An identifying tag that can correlate a start and end history element

    • isIgnoreOnReplay

      public boolean isIgnoreOnReplay()
      Whether this history element should simply be stripped from side effects during replay. This is a special case for history elements that are known to not be generated during replay, and would otherwise fail the replay integrity check.

    • getName

      public String getName()
      The name for this item. Usually points to SimpleActivity.getName() or SimpleWorkflow.getName()

    • getDescription

      public String getDescription()
      Optional description for this item. Usually points to SimpleActivity.getDescription() or SimpleWorkflow.getDescription()

    • getStartTime

      public Instant getStartTime()
      The time execution was started for this item

    • getEndTime

      public Instant getEndTime()
      The time execution was concluded for this item

    • getStatus

      public ProcessStatus getStatus()
      The state of the outcome of execution. This is different from getResponseState(), which simply reports an output state from the activity, but is still considered "completed". Instead, here we define whether the item completed successfully, is still processing, or fatally exited because of an uncaught exception.

    • getResponseState

      public String getResponseState()
      The response reported by the activity. See ActivityResponse.getResponseState(). This value is optional, and generally only applies to activity execution.

    • getResultingContext

      public Map<String,Object> getResultingContext()
      Any context information the activity wants to add to the main context

    • getErrorInformation

      public String getErrorInformation()
      Any error information related to a failed state. Usually a stack trace.

    • getType

      public HistoryElementType getType()
      The type of item

    • getLogs

      public Map<String,String> getLogs()
      Arbitrary logs set during the execution of the activity. This is a map of log name to log message.

    • setIdentifier

      public void setIdentifier(String identifier)
      An identifying tag that can correlate a start and end history element

    • setIgnoreOnReplay

      public void setIgnoreOnReplay(boolean ignoreOnReplay)
      Whether this history element should simply be stripped from side effects during replay. This is a special case for history elements that are known to not be generated during replay, and would otherwise fail the replay integrity check.

    • setName

      public void setName(String name)
      The name for this item. Usually points to SimpleActivity.getName() or SimpleWorkflow.getName()

    • setDescription

      public void setDescription(String description)
      Optional description for this item. Usually points to SimpleActivity.getDescription() or SimpleWorkflow.getDescription()

    • setStartTime

      public void setStartTime(Instant startTime)
      The time execution was started for this item

    • setEndTime

      public void setEndTime(Instant endTime)
      The time execution was concluded for this item

    • setStatus

      public void setStatus(ProcessStatus status)
      The state of the outcome of execution. This is different from getResponseState(), which simply reports an output state from the activity, but is still considered "completed". Instead, here we define whether the item completed successfully, is still processing, or fatally exited because of an uncaught exception.

    • setResponseState

      public void setResponseState(String responseState)
      The response reported by the activity. See ActivityResponse.getResponseState(). This value is optional, and generally only applies to activity execution.

    • setResultingContext

      public void setResultingContext(Map<String,Object> resultingContext)
      Any context information the activity wants to add to the main context

    • setErrorInformation

      public void setErrorInformation(String errorInformation)
      Any error information related to a failed state. Usually a stack trace.

    • setType

      public void setType(HistoryElementType type)
      The type of item

    • setLogs

      public void setLogs(Map<String,String> logs)
      Arbitrary logs set during the execution of the activity. This is a map of log name to log message.

    • 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