Package org.odpi.openmetadata.frameworkservices.gaf.rest

Class ToDoRequestBody

java.lang.Object
org.odpi.openmetadata.frameworkservices.gaf.rest.ToDoRequestBody
public class ToDoRequestBody extends Object
ToDoRequestBody provides a structure for passing the properties for a new to do.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ToDoRequestBody()
    Default constructor
    ToDoRequestBody(ToDoRequestBody template)
    Copy/clone constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Equals method that returns true if containing properties are the same.
    List<org.odpi.openmetadata.frameworks.governanceaction.properties.NewActionTarget>
    getActionTargets()
    Return the list of elements that should be acted upon.
    Map<String,String>
    getAdditionalProperties()
    Return any additional properties.
    String
    getAssignToQualifiedName()
    Return the unique name of the person that should perform the to do.
    String
    getCategory()
    Return a category of to dos (for example, "data error", "access request").
    String
    getCauseGUID()
    Return the unique identifier of the element that describes the rule, project that this is on behalf of.
    Date
    getDueDate()
    Return the date/time that to do should be completed.
    String
    getInstructions()
    Return the instructions that describe the action to perform.
    int
    getPriority()
    Return the identifier of the governance domain that this incident report belongs to (0=ALL/ANY).
    String
    getQualifiedName()
    Return the unique name of the new to do.
    String
    getTitle()
    Return the short description of the action to perform.
    int
    hashCode()
    Return hash code for this object
    void
    setActionTargets(List<org.odpi.openmetadata.frameworks.governanceaction.properties.NewActionTarget> actionTargets)
    Set up the list of elements that should be acted upon.
    void
    setAdditionalProperties(Map<String,String> additionalProperties)
    Set up any additional properties.
    void
    setAssignToQualifiedName(String assignToQualifiedName)
    Set up the unique name of the person that should perform the to do.
    void
    setCategory(String category)
    Set up a category of to dos (for example, "data error", "access request").
    void
    setCauseGUID(String causeGUID)
    Set up the unique identifier of the element that describes the rule, project that this is on behalf of.
    void
    setDueDate(Date dueDate)
    Set up the date/time that to do should be completed.
    void
    setInstructions(String instructions)
    Set up the instructions that describe the action to perform.
    void
    setPriority(int priority)
    Set up the identifier of the governance domain that this incident report belongs to (0=ALL/ANY).
    void
    setQualifiedName(String qualifiedName)
    Set up the unique name of the new to do.
    void
    setTitle(String title)
    Set up the short description of the action to perform.
    String
    toString()
    JSON-style toString.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ToDoRequestBody

      public ToDoRequestBody()
      Default constructor

    • ToDoRequestBody

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

  • Method Details

    • getQualifiedName

      public String getQualifiedName()
      Return the unique name of the new to do.
      Returns:
      string name

    • setQualifiedName

      public void setQualifiedName(String qualifiedName)
      Set up the unique name of the new to do.
      Parameters:
      qualifiedName - string name

    • getTitle

      public String getTitle()
      Return the short description of the action to perform. It could be used as the subject of an email or message.
      Returns:
      string text

    • setTitle

      public void setTitle(String title)
      Set up the short description of the action to perform. It could be used as the subject of an email or message.
      Parameters:
      title - string text

    • getInstructions

      public String getInstructions()
      Return the instructions that describe the action to perform.
      Returns:
      text

    • setInstructions

      public void setInstructions(String instructions)
      Set up the instructions that describe the action to perform.
      Parameters:
      instructions - text

    • getCategory

      public String getCategory()
      Return a category of to dos (for example, "data error", "access request").
      Returns:
      name string

    • setCategory

      public void setCategory(String category)
      Set up a category of to dos (for example, "data error", "access request").
      Parameters:
      category - name string

    • getPriority

      public int getPriority()
      Return the identifier of the governance domain that this incident report belongs to (0=ALL/ANY).
      Returns:
      int

    • setPriority

      public void setPriority(int priority)
      Set up the identifier of the governance domain that this incident report belongs to (0=ALL/ANY).
      Parameters:
      priority - int

    • getDueDate

      public Date getDueDate()
      Return the date/time that to do should be completed.
      Returns:
      date/time

    • setDueDate

      public void setDueDate(Date dueDate)
      Set up the date/time that to do should be completed.
      Parameters:
      dueDate - date/time

    • getAdditionalProperties

      public Map<String,String> getAdditionalProperties()
      Return any additional properties.
      Returns:
      property map

    • setAdditionalProperties

      public void setAdditionalProperties(Map<String,String> additionalProperties)
      Set up any additional properties.
      Parameters:
      additionalProperties - property map

    • getAssignToQualifiedName

      public String getAssignToQualifiedName()
      Return the unique name of the person that should perform the to do.
      Returns:
      string name

    • setAssignToQualifiedName

      public void setAssignToQualifiedName(String assignToQualifiedName)
      Set up the unique name of the person that should perform the to do.
      Parameters:
      assignToQualifiedName - string name

    • getCauseGUID

      public String getCauseGUID()
      Return the unique identifier of the element that describes the rule, project that this is on behalf of.
      Returns:
      string guid

    • setCauseGUID

      public void setCauseGUID(String causeGUID)
      Set up the unique identifier of the element that describes the rule, project that this is on behalf of.
      Parameters:
      causeGUID - string guid

    • getActionTargets

      public List<org.odpi.openmetadata.frameworks.governanceaction.properties.NewActionTarget> getActionTargets()
      Return the list of elements that should be acted upon.
      Returns:
      list of action targets

    • setActionTargets

      public void setActionTargets(List<org.odpi.openmetadata.frameworks.governanceaction.properties.NewActionTarget> actionTargets)
      Set up the list of elements that should be acted upon.
      Parameters:
      actionTargets - list of action targets

    • toString

      public String toString()
      JSON-style toString.
      Overrides:
      toString in class Object
      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 Object
      Parameters:
      objectToCompare - object to compare
      Returns:
      boolean result of comparison

    • hashCode

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