Package com.onenetwork.platform.ixm

Class IXMPlanResult

java.lang.Object
com.onenetwork.platform.ixm.IXMPlanResult
public class IXMPlanResult
extends java.lang.Object
Captures the results of an IXM Engine run. This includes a hierarchy of parent/child results for nesting the results of smaller jobs within larger ones.

  • Constructor Summary

    Constructors 
    Constructor Description
    IXMPlanResult()
    Creates a new empty PlanResult (success = false).
    IXMPlanResult​(java.lang.String id, boolean success)
    Creates a new PlanResult

  • Method Summary

    Modifier and Type Method Description
    void addChild​(IXMPlanResult childResult)
    Add a "child" result to this parent
    java.util.List<IXMPlanResult> getChildren()
    Returns a collection of child results
    java.lang.String getPlanId()
    Returns a unique plan identifier
    java.lang.String getReason()
    Returns a failure reason
    java.lang.String getReasonCode()
    Returns a failure "reason code", usually a larger category of errors within which getReason() provides further explanation
    boolean isSuccess()
    Returns true iff the plan was run successfully
    void setPlanId​(java.lang.String planId)
    Sets a unique plan identifier param planId plan identifier
    void setReason​(java.lang.String reason)
    Sets a failure reason
    void setReasonCode​(java.lang.String reasonCode)
    Sets a failure "reason code", usually a larger category of errors within which getReason() provides further explanation
    void setSuccess​(boolean success)
    Sets whether the plan was run successfully
    java.lang.String toString()  

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • IXMPlanResult

      public IXMPlanResult()
      Creates a new empty PlanResult (success = false).

    • IXMPlanResult

      public IXMPlanResult​(java.lang.String id, boolean success)
      Creates a new PlanResult
      Parameters:
      id - unique identifier for the plan result
      success - true if the plan execution was successful

  • Method Details

    • getPlanId

      public java.lang.String getPlanId()
      Returns a unique plan identifier
      Returns:
      plan identifier

    • setPlanId

      public void setPlanId​(java.lang.String planId)
      Sets a unique plan identifier param planId plan identifier

    • getChildren

      public java.util.List<IXMPlanResult> getChildren()
      Returns a collection of child results

    • isSuccess

      public boolean isSuccess()
      Returns true iff the plan was run successfully

    • setSuccess

      public void setSuccess​(boolean success)
      Sets whether the plan was run successfully
      Parameters:
      success - whether the plan was run successfully

    • getReason

      public java.lang.String getReason()
      Returns a failure reason
      Returns:
      failure reason

    • setReason

      public void setReason​(java.lang.String reason)
      Sets a failure reason
      Parameters:
      reason - failure reason

    • getReasonCode

      public java.lang.String getReasonCode()
      Returns a failure "reason code", usually a larger category of errors within which getReason() provides further explanation

    • setReasonCode

      public void setReasonCode​(java.lang.String reasonCode)
      Sets a failure "reason code", usually a larger category of errors within which getReason() provides further explanation
      Parameters:
      reasonCode - reason code

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object

    • addChild

      public void addChild​(IXMPlanResult childResult)
      Add a "child" result to this parent
      Parameters:
      childResult - child result to be added