Package org.odpi.openmetadata.frameworks.governanceaction.properties

Class ActionTargetElement

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.NewActionTarget
org.odpi.openmetadata.frameworks.governanceaction.properties.ActionTargetElement
public class ActionTargetElement extends org.odpi.openmetadata.frameworks.openmetadata.properties.NewActionTarget
ActionTargetElement describes an element that a governance action service should process.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ActionTargetElement()
    Typical Constructor
    ActionTargetElement(ActionTargetElement template)
    Copy/clone Constructor the resulting object will return true if tested with this.equals(template) as long as the template object is not null;

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Compare the values of the supplied object with those stored in the current object.
    String
    getActionTargetRelationshipGUID()
    Return the unique identifier of the ActionTarget relationship.
    Date
    getCompletionDate()
    Return the date/time when the governance action service stopped processing this target element.
    String
    getCompletionMessage()
    Return the optional message from the running governance service supplied on its completion.
    Date
    getStartDate()
    Return the date/time when the governance action service started processing this target element.
    org.odpi.openmetadata.frameworks.openmetadata.enums.EngineActionStatus
    getStatus()
    Return the current status of the action target.
    org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataElement
    getTargetElement()
    Return details of the target element that the governance action service is to process.
    int
    hashCode()
    Create a hash code for this element type.
    void
    setActionTargetRelationshipGUID(String actionTargetRelationshipGUID)
    Set up the unique identifier of the ActionTarget relationship.
    void
    setCompletionDate(Date completionDate)
    Set up the date/time when the governance action service stopped processing this target element.
    void
    setCompletionMessage(String completionMessage)
    Set up optional message from the running governance service supplied on its completion.
    void
    setStartDate(Date startDate)
    Set up the date/time when the governance action service started processing this target element.
    void
    setStatus(org.odpi.openmetadata.frameworks.openmetadata.enums.EngineActionStatus status)
    Set up current status of the action target.
    void
    setTargetElement(org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataElement targetElement)
    Set up details of the target element that the governance action service is to process.
    String
    toString()
    Standard toString method.

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.NewActionTarget

    getActionTargetGUID, getActionTargetName, setActionTargetGUID, setActionTargetName

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ActionTargetElement

      public ActionTargetElement()
      Typical Constructor

    • ActionTargetElement

      public ActionTargetElement(ActionTargetElement template)
      Copy/clone Constructor the resulting object will return true if tested with this.equals(template) as long as the template object is not null;
      Parameters:
      template - object being copied

  • Method Details

    • getActionTargetRelationshipGUID

      public String getActionTargetRelationshipGUID()
      Return the unique identifier of the ActionTarget relationship.
      Returns:
      guid

    • setActionTargetRelationshipGUID

      public void setActionTargetRelationshipGUID(String actionTargetRelationshipGUID)
      Set up the unique identifier of the ActionTarget relationship.
      Parameters:
      actionTargetRelationshipGUID - guid

    • getStatus

      public org.odpi.openmetadata.frameworks.openmetadata.enums.EngineActionStatus getStatus()
      Return the current status of the action target. The default value is the status is derived from the engine action. However, if it has to process many target elements, then these values can be used to show progress.
      Returns:
      status enum

    • setStatus

      public void setStatus(org.odpi.openmetadata.frameworks.openmetadata.enums.EngineActionStatus status)
      Set up current status of the action target. The default value is the status is derived from the governance action service. However, if it has to process many target elements, then these values can be used to show progress.
      Parameters:
      status - enum

    • getStartDate

      public Date getStartDate()
      Return the date/time when the governance action service started processing this target element. By default, this value is derived from the startDate for the governance action service. However, if it has to process many target elements, then these values can be used to show progress.
      Returns:
      date object

    • setStartDate

      public void setStartDate(Date startDate)
      Set up the date/time when the governance action service started processing this target element. By default, this value is derived from the startDate for the governance action service. However, if it has to process many target elements, then these values can be used to show progress.
      Parameters:
      startDate - date object

    • getCompletionDate

      public Date getCompletionDate()
      Return the date/time when the governance action service stopped processing this target element. By default, this value is derived from the completionDate for the governance action service. However, if it has to process many target elements, then these values can be used to show progress.
      Returns:
      date object

    • setCompletionDate

      public void setCompletionDate(Date completionDate)
      Set up the date/time when the governance action service stopped processing this target element. By default, this value is derived from the completionDate for the governance action service. However, if it has to process many target elements, then these values can be used to show progress.
      Parameters:
      completionDate - date object

    • getCompletionMessage

      public String getCompletionMessage()
      Return the optional message from the running governance service supplied on its completion.
      Returns:
      string message

    • setCompletionMessage

      public void setCompletionMessage(String completionMessage)
      Set up optional message from the running governance service supplied on its completion.
      Parameters:
      completionMessage - string message

    • getTargetElement

      public org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataElement getTargetElement()
      Return details of the target element that the governance action service is to process.
      Returns:
      metadata element properties

    • setTargetElement

      public void setTargetElement(org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataElement targetElement)
      Set up details of the target element that the governance action service is to process.
      Parameters:
      targetElement - metadata element properties

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class org.odpi.openmetadata.frameworks.openmetadata.properties.NewActionTarget
      Returns:
      print out of variables in a JSON-style

    • equals

      public boolean equals(Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      Overrides:
      equals in class org.odpi.openmetadata.frameworks.openmetadata.properties.NewActionTarget
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Create a hash code for this element type.
      Overrides:
      hashCode in class org.odpi.openmetadata.frameworks.openmetadata.properties.NewActionTarget
      Returns:
      int hash code