Class WorkflowExplorationEntry

All Implemented Interfaces:
HasHandlers

public class WorkflowExplorationEntry extends DataClass
One entry of explorationHistory / explorationHistory - the outcome of executing one candidate step in "exploration mode" (see explorationSettings) before it was committed to the Workflow.
  • Constructor Details

    • WorkflowExplorationEntry

      public WorkflowExplorationEntry()
    • WorkflowExplorationEntry

      public WorkflowExplorationEntry(JavaScriptObject jsObj)
  • Method Details

    • getOrCreateRef

      public static WorkflowExplorationEntry getOrCreateRef(JavaScriptObject jsObj)
    • setDataSourceID

      public WorkflowExplorationEntry setDataSourceID(String dataSourceID)
      The DataSource the explored candidate step targeted.
      Parameters:
      dataSourceID - New dataSourceID value. Default value is null
      Returns:
      WorkflowExplorationEntry instance, for chaining setter calls
      See Also:
    • getDataSourceID

      public String getDataSourceID()
      The DataSource the explored candidate step targeted.
      Returns:
      Current dataSourceID value. Default value is null
      See Also:
    • setReason

      public WorkflowExplorationEntry setReason(String reason)
      Present only when status is "refused" - why the candidate step did not qualify for exploration.
      Parameters:
      reason - New reason value. Default value is null
      Returns:
      WorkflowExplorationEntry instance, for chaining setter calls
    • getReason

      public String getReason()
      Present only when status is "refused" - why the candidate step did not qualify for exploration.
      Returns:
      Current reason value. Default value is null
    • setRowCount

      public WorkflowExplorationEntry setRowCount(Integer rowCount)
      Present only when status is "succeeded" - the number of rows the exploratory fetch returned.
      Parameters:
      rowCount - New rowCount value. Default value is null
      Returns:
      WorkflowExplorationEntry instance, for chaining setter calls
    • getRowCount

      public Integer getRowCount()
      Present only when status is "succeeded" - the number of rows the exploratory fetch returned.
      Returns:
      Current rowCount value. Default value is null
    • setSample

      public WorkflowExplorationEntry setSample(Map sample)
      Present only on the most recent entry in the history array, and only when status is "succeeded" - the real data returned by the exploratory fetch. Earlier entries are trimmed to summary only, so history size stays bounded regardless of how large individual result samples are.
      Parameters:
      sample - New sample value. Default value is null
      Returns:
      WorkflowExplorationEntry instance, for chaining setter calls
    • getSample

      public Map getSample()
      Present only on the most recent entry in the history array, and only when status is "succeeded" - the real data returned by the exploratory fetch. Earlier entries are trimmed to summary only, so history size stays bounded regardless of how large individual result samples are.
      Returns:
      Current sample value. Default value is null
    • setStatus

      public WorkflowExplorationEntry setStatus(String status)
      One of "succeeded", "failed", or "refused" (the candidate step did not qualify for exploration - see explorationSettings).
      Parameters:
      status - New status value. Default value is null
      Returns:
      WorkflowExplorationEntry instance, for chaining setter calls
    • getStatus

      public String getStatus()
      One of "succeeded", "failed", or "refused" (the candidate step did not qualify for exploration - see explorationSettings).
      Returns:
      Current status value. Default value is null
    • setSummary

      public WorkflowExplorationEntry setSummary(String summary)
      A one-line text summary of this entry - see +link{WorkflowBuilderCoTProcess. summarizeExploration()}. Always present.
      Parameters:
      summary - New summary value. Default value is null
      Returns:
      WorkflowExplorationEntry instance, for chaining setter calls
    • getSummary

      public String getSummary()
      A one-line text summary of this entry - see +link{WorkflowBuilderCoTProcess. summarizeExploration()}. Always present.
      Returns:
      Current summary value. Default value is null
    • setTaskType

      public WorkflowExplorationEntry setTaskType(String taskType)
      The Task class of the explored candidate step.
      Parameters:
      taskType - New taskType value. Default value is null
      Returns:
      WorkflowExplorationEntry instance, for chaining setter calls
      See Also:
    • getTaskType

      public String getTaskType()
      The Task class of the explored candidate step.
      Returns:
      Current taskType value. Default value is null
      See Also: