Package org.odpi.openmetadata.frameworks.openmetadata.properties.assets.processes.actions

Class ActionTargetProperties

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.RelationshipBeanProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.assets.processes.actions.ActionTargetProperties
public class ActionTargetProperties extends RelationshipBeanProperties
ActionTargetProperties identifies the properties of an ActionTarget relationship.

  • Constructor Details

    • ActionTargetProperties

      public ActionTargetProperties()
      Typical Constructor

    • ActionTargetProperties

      public ActionTargetProperties(ActionTargetProperties 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

    • getActionTargetName

      public String getActionTargetName()
      Return the name assigned to this action target. This name helps to guide the actor in its processing of this action target.
      Returns:
      string name

    • setActionTargetName

      public void setActionTargetName(String actionTargetName)
      Set up the name assigned to this action target. This name helps to guide the actor in its processing of this action target.
      Parameters:
      actionTargetName - string name

    • getActivityStatus

      public ActivityStatus getActivityStatus()
      Return the current status of the action target. The default value is the status is derived from the action. However, if the actor has to process many target elements, then these values can be used to show progress.
      Returns:
      status enum

    • setActivityStatus

      public void setActivityStatus(ActivityStatus activityStatus)
      Set up current status of the action target. The default value is the status is derived from the action. However, if the actor has to process many target elements, then these values can be used to show progress.
      Parameters:
      activityStatus - enum

    • getStartTime

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

    • setStartTime

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

    • getCompletionTime

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

    • setCompletionTime

      public void setCompletionTime(Date completionTime)
      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:
      completionTime - 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

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class RelationshipBeanProperties
      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 RelationshipBeanProperties
      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 RelationshipBeanProperties
      Returns:
      int hash code