Class ActionTargetElement

  • All Implemented Interfaces:
    java.io.Serializable

    public class ActionTargetElement
    extends java.lang.Object
    implements java.io.Serializable
    ActionTargetElement describes an element that a governance action service should process.
    See Also:
    Serialized Form
    • 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

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      java.lang.String getActionTargetGUID()
      Return the unique identifier for this action target.
      java.lang.String getActionTargetName()
      Return the name assigned to this action target.
      java.util.Date getCompletionDate()
      Return the date/time when the governance action service stopped processing this target element.
      java.util.Date getStartDate()
      Return the date/time when the governance action service started processing this target element.
      GovernanceActionStatus getStatus()
      Return the current status of the action target.
      ElementStub 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 setActionTargetGUID​(java.lang.String actionTargetGUID)
      Set up the unique identifier for this action target.
      void setActionTargetName​(java.lang.String actionTargetName)
      Set up the name assigned to this action target.
      void setCompletionDate​(java.util.Date completionDate)
      Set up the date/time when the governance action service stopped processing this target element.
      void setStartDate​(java.util.Date startDate)
      Set up the date/time when the governance action service started processing this target element.
      void setStatus​(GovernanceActionStatus status)
      Set up current status of the action target.
      void setTargetElement​(ElementStub targetElement)
      Set up details of the target element that the governance action service is to process.
      java.lang.String toString()
      Standard toString method.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • 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 Detail

      • getActionTargetName

        public java.lang.String getActionTargetName()
        Return the name assigned to this action target. This name helps to guide the governance service in its processing of this action target.
        Returns:
        string name
      • setActionTargetName

        public void setActionTargetName​(java.lang.String actionTargetName)
        Set up the name assigned to this action target. This name helps to guide the governance service in its processing of this action target.
        Parameters:
        actionTargetName - string name
      • getActionTargetGUID

        public java.lang.String getActionTargetGUID()
        Return the unique identifier for this action target.
        Returns:
        string identifier
      • setActionTargetGUID

        public void setActionTargetGUID​(java.lang.String actionTargetGUID)
        Set up the unique identifier for this action target.
        Parameters:
        actionTargetGUID - string identifier
      • getStatus

        public GovernanceActionStatus getStatus()
        Return the 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.
        Returns:
        status enum
      • setStatus

        public void setStatus​(GovernanceActionStatus 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 java.util.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​(java.util.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 java.util.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​(java.util.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
      • getTargetElement

        public ElementStub getTargetElement()
        Return details of the target element that the governance action service is to process.
        Returns:
        metadata element properties
      • setTargetElement

        public void setTargetElement​(ElementStub targetElement)
        Set up details of the target element that the governance action service is to process.
        Parameters:
        targetElement - metadata element properties
      • toString

        public java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class java.lang.Object
        Returns:
        print out of variables in a JSON-style
      • equals

        public boolean equals​(java.lang.Object objectToCompare)
        Compare the values of the supplied object with those stored in the current object.
        Overrides:
        equals in class java.lang.Object
        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 java.lang.Object
        Returns:
        int hash code