Package org.odpi.openmetadata.commonservices.ffdc.rest

Class ActionRequestBody

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.search.BasicOptions
org.odpi.openmetadata.frameworks.openmetadata.search.MetadataSourceOptions
org.odpi.openmetadata.frameworks.openmetadata.search.AnchorOptions
org.odpi.openmetadata.commonservices.ffdc.rest.ActionRequestBody
public class ActionRequestBody extends AnchorOptions
ActionRequestBody provides a structure for passing action details over a REST API. It is used for creating To Do, Meetings and engine action elements.

  • Constructor Details

    • ActionRequestBody

      public ActionRequestBody()
      Default constructor

    • ActionRequestBody

      public ActionRequestBody(ActionRequestBody template)
      Copy/clone constructor
      Parameters:
      template - object to copy

  • Method Details

    • getNewActionTargets

      public List<NewActionTarget> getNewActionTargets()
      Return any specific action targets for the action.
      Returns:
      list

    • setNewActionTargets

      public void setNewActionTargets(List<NewActionTarget> newActionTargets)
      Set up any specific action targets for the action.
      Parameters:
      newActionTargets - list

    • getProperties

      public ActionProperties getProperties()
      Return the properties of the action.
      Returns:
      properties

    • setProperties

      public void setProperties(ActionProperties properties)
      Set up the properties of the action.
      Parameters:
      properties - properties

    • getOriginatorGUID

      public String getOriginatorGUID()
      Return the unique identifier of the element that originated the action.
      Returns:
      guid

    • setOriginatorGUID

      public void setOriginatorGUID(String originatorGUID)
      Set up the unique identifier of the element that originated the action.
      Parameters:
      originatorGUID - guid

    • getActionSponsorGUID

      public String getActionSponsorGUID()
      Return the unique identifier of the sponsor of the action.
      Returns:
      guid

    • setActionSponsorGUID

      public void setActionSponsorGUID(String actionSponsorGUID)
      Set up the unique identifier of the sponsor of the action.
      Parameters:
      actionSponsorGUID - guid

    • getAssignToActorGUID

      public String getAssignToActorGUID()
      Return the unique identifier of the action assigned to perform the work.
      Returns:
      guid

    • setAssignToActorGUID

      public void setAssignToActorGUID(String assignToActorGUID)
      Set up the unique identifier of the action assigned to perform the work.
      Parameters:
      assignToActorGUID - guid

    • toString

      public String toString()
      JSON-style toString.
      Overrides:
      toString in class AnchorOptions
      Returns:
      list of properties and their values.

    • equals

      public boolean equals(Object objectToCompare)
      Equals method that returns true if containing properties are the same.
      Overrides:
      equals in class AnchorOptions
      Parameters:
      objectToCompare - object to compare
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class AnchorOptions
      Returns:
      int hash code