Package org.odpi.openmetadata.accessservices.governanceengine.metadataelements

Class GovernanceActionElement

java.lang.Object
org.odpi.openmetadata.accessservices.governanceengine.properties.ReferenceableProperties
org.odpi.openmetadata.accessservices.governanceengine.metadataelements.GovernanceActionElement
All Implemented Interfaces:
MetadataElement
public class GovernanceActionElement extends ReferenceableProperties implements MetadataElement
GovernanceActionTypeElement contains the properties and header for a GovernanceAction entity retrieved from the metadata repository that represents a governance action type (plus relevant relationships and properties).

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Return comparison result based on the content of the properties.
    org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionStatus
    getActionStatus()
    Return the current status of the governance action.
    List<org.odpi.openmetadata.frameworks.governanceaction.properties.ActionTargetElement>
    getActionTargetElements()
    Return the list of elements that the governance action will work on.
    List<String>
    getCompletionGuards()
    Return the list of completion guards supplied by the governance service.
    String
    getCompletionMessage()
    Return the optional message from the running governance service supplied on its completion.
    Date
    getCompletionTime()
    Return the date/time that the governance service completed (or null if not yet completed).
    String
    getDescription()
    Return the description of the governance action.
    String
    getDisplayName()
    Return the display name for the governance action.
    int
    getDomainIdentifier()
    Return the identifier of the governance domain that this action belongs to (0=ALL/ANY).
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader
    getElementHeader()
    Return the element header associated with the properties.
    List<org.odpi.openmetadata.frameworks.governanceaction.properties.RelatedEngineActionElement>
    getFollowOnActions()
    Return the list of governance actions that will run after this governance action has completed.
    String
    getGovernanceActionTypeGUID()
    Return the unique identifier for the governance action type that acted as a template for this governance action (if appropriate).
    String
    getGovernanceActionTypeName()
    Return the unique name for the governance action type that acted as a template for this governance action (if appropriate).
    String
    getGovernanceEngineGUID()
    Return the unique identifier of governance engine that is processing the governance action.
    String
    getGovernanceEngineName()
    Return the unique name of governance engine that is processing the governance action.
    List<String>
    getMandatoryGuards()
    Return the list of guards that must be received before this governance action can proceed.
    List<org.odpi.openmetadata.frameworks.governanceaction.properties.RelatedEngineActionElement>
    getPreviousActions()
    Return the list of governance actions that preceded this governance action.
    String
    getProcessingEngineUserId()
    Return the userId of the governance engine that is responsible for running the governance service for this governance action.
    String
    getProcessName()
    Return the name of the governance action process - or similar request source.
    List<String>
    getReceivedGuards()
    Return the list of guards provided by the previous governance service(s).
    Date
    getRequestedTime()
    Return the time that the governance action was created.
    Map<String,String>
    getRequestParameters()
    Return the parameters to pass onto the governance service.
    List<org.odpi.openmetadata.frameworks.governanceaction.properties.RequestSourceElement>
    getRequestSourceElements()
    Return the list of elements that triggered this request.
    String
    getRequestType()
    Return the governance request type used to call the governance service via this governance engine.
    Date
    getStartTime()
    Return the time that this governance action should start (null means as soon as possible).
    int
    hashCode()
    Return hash code for this object
    void
    setActionStatus(org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionStatus actionStatus)
    Set up the current status of the governance action.
    void
    setActionTargetElements(List<org.odpi.openmetadata.frameworks.governanceaction.properties.ActionTargetElement> actionTargetElements)
    Set up the list of elements that the governance action will work on.
    void
    setCompletionGuards(List<String> completionGuards)
    Set up the list of completion guards supplied by the governance service.
    void
    setCompletionMessage(String completionMessage)
    Set up optional message from the running governance service supplied on its completion.
    void
    setCompletionTime(Date completionTime)
    Set up the date/time that the governance service completed (or null if not yet completed).
    void
    setDescription(String description)
    Set up the description of the governance action.
    void
    setDisplayName(String displayName)
    Set up the display name for the governance action.
    void
    setDomainIdentifier(int domainIdentifier)
    Set up the identifier of the governance domain that this action belongs to (0=ALL/ANY).
    void
    setElementHeader(org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader elementHeader)
    Set up the element header associated with the properties.
    void
    setFollowOnActions(List<org.odpi.openmetadata.frameworks.governanceaction.properties.RelatedEngineActionElement> followOnActions)
    Set up the list of governance actions that will run after this governance action has completed.
    void
    setGovernanceActionTypeGUID(String governanceActionTypeGUID)
    Set up the unique identifier for the governance action type that acted as a template for this governance action (if appropriate).
    void
    setGovernanceActionTypeName(String governanceActionTypeName)
    Set up the unique name for the governance action type that acted as a template for this governance action (if appropriate).
    void
    setGovernanceEngineGUID(String governanceEngineGUID)
    Set up the unique identifier of governance engine that is processing the governance action.
    void
    setGovernanceEngineName(String governanceEngineName)
    Set up the unique name of governance engine that is processing the governance action.
    void
    setMandatoryGuards(List<String> mandatoryGuards)
    Set up the list of guards that must be received before this governance action can proceed.
    void
    setPreviousActions(List<org.odpi.openmetadata.frameworks.governanceaction.properties.RelatedEngineActionElement> previousActions)
    Set up the list of governance actions that preceded this governance action.
    void
    setProcessingEngineUserId(String processingEngineUserId)
    Set up the userId of the governance engine that is responsible for running the governance service for this governance action.
    void
    setProcessName(String processName)
    Set up the name of the governance action process - or similar request source.
    void
    setReceivedGuards(List<String> receivedGuards)
    Set up the list of guards provided by the previous governance service(s).
    void
    setRequestedTime(Date requestedTime)
    Set up the time that the governance action was created.
    void
    setRequestParameters(Map<String,String> requestParameters)
    Set up the parameters to pass onto the governance service.
    void
    setRequestSourceElements(List<org.odpi.openmetadata.frameworks.governanceaction.properties.RequestSourceElement> requestSourceElements)
    Set up the list of elements that triggered this request.
    void
    setRequestType(String requestType)
    Set up the governance request type used to call the governance service via this governance engine.
    void
    setStartTime(Date startTime)
    Set up the time that this governance action should start (null means as soon as possible).
    String
    toString()
    JSON-style toString

    Methods inherited from class org.odpi.openmetadata.accessservices.governanceengine.properties.ReferenceableProperties

    getAdditionalProperties, getQualifiedName, setAdditionalProperties, setQualifiedName

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • GovernanceActionElement

      public GovernanceActionElement()
      Default constructor

    • GovernanceActionElement

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

  • Method Details

    • getElementHeader

      public org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader getElementHeader()
      Return the element header associated with the properties.
      Specified by:
      getElementHeader in interface MetadataElement
      Returns:
      element header object

    • setElementHeader

      public void setElementHeader(org.odpi.openmetadata.frameworks.openmetadata.metadataelements.ElementHeader elementHeader)
      Set up the element header associated with the properties.
      Specified by:
      setElementHeader in interface MetadataElement
      Parameters:
      elementHeader - element header object

    • getDomainIdentifier

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

    • setDomainIdentifier

      public void setDomainIdentifier(int domainIdentifier)
      Set up the identifier of the governance domain that this action belongs to (0=ALL/ANY).
      Parameters:
      domainIdentifier - int

    • getDisplayName

      public String getDisplayName()
      Return the display name for the governance action.
      Returns:
      string name

    • setDisplayName

      public void setDisplayName(String displayName)
      Set up the display name for the governance action.
      Parameters:
      displayName - string name

    • getDescription

      public String getDescription()
      Return the description of the governance action.
      Returns:
      string text

    • setDescription

      public void setDescription(String description)
      Set up the description of the governance action.
      Parameters:
      description - string text

    • getMandatoryGuards

      public List<String> getMandatoryGuards()
      Return the list of guards that must be received before this governance action can proceed.
      Returns:
      list of guards

    • setMandatoryGuards

      public void setMandatoryGuards(List<String> mandatoryGuards)
      Set up the list of guards that must be received before this governance action can proceed.
      Parameters:
      mandatoryGuards - list of guards

    • getReceivedGuards

      public List<String> getReceivedGuards()
      Return the list of guards provided by the previous governance service(s).
      Returns:
      list of guards

    • setReceivedGuards

      public void setReceivedGuards(List<String> receivedGuards)
      Set up the list of guards provided by the previous governance service(s).
      Parameters:
      receivedGuards - list of guards

    • getGovernanceEngineGUID

      public String getGovernanceEngineGUID()
      Return the unique identifier of governance engine that is processing the governance action.
      Returns:
      string guid

    • setGovernanceEngineGUID

      public void setGovernanceEngineGUID(String governanceEngineGUID)
      Set up the unique identifier of governance engine that is processing the governance action.
      Parameters:
      governanceEngineGUID - string guid

    • getGovernanceEngineName

      public String getGovernanceEngineName()
      Return the unique name of governance engine that is processing the governance action.
      Returns:
      string name

    • setGovernanceEngineName

      public void setGovernanceEngineName(String governanceEngineName)
      Set up the unique name of governance engine that is processing the governance action.
      Parameters:
      governanceEngineName - string name

    • getProcessName

      public String getProcessName()
      Return the name of the governance action process - or similar request source.
      Returns:
      name

    • setProcessName

      public void setProcessName(String processName)
      Set up the name of the governance action process - or similar request source.
      Parameters:
      processName - name

    • getGovernanceActionTypeGUID

      public String getGovernanceActionTypeGUID()
      Return the unique identifier for the governance action type that acted as a template for this governance action (if appropriate).
      Returns:
      guid

    • setGovernanceActionTypeGUID

      public void setGovernanceActionTypeGUID(String governanceActionTypeGUID)
      Set up the unique identifier for the governance action type that acted as a template for this governance action (if appropriate).
      Parameters:
      governanceActionTypeGUID - guid

    • getGovernanceActionTypeName

      public String getGovernanceActionTypeName()
      Return the unique name for the governance action type that acted as a template for this governance action (if appropriate).
      Returns:
      name

    • setGovernanceActionTypeName

      public void setGovernanceActionTypeName(String governanceActionTypeName)
      Set up the unique name for the governance action type that acted as a template for this governance action (if appropriate).
      Parameters:
      governanceActionTypeName - name

    • getActionStatus

      public org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionStatus getActionStatus()
      Return the current status of the governance action.
      Returns:
      status enum

    • setActionStatus

      public void setActionStatus(org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionStatus actionStatus)
      Set up the current status of the governance action.
      Parameters:
      actionStatus - status enum

    • getProcessingEngineUserId

      public String getProcessingEngineUserId()
      Return the userId of the governance engine that is responsible for running the governance service for this governance action.
      Returns:
      string userId

    • setProcessingEngineUserId

      public void setProcessingEngineUserId(String processingEngineUserId)
      Set up the userId of the governance engine that is responsible for running the governance service for this governance action.
      Parameters:
      processingEngineUserId - string userId

    • getRequestSourceElements

      public List<org.odpi.openmetadata.frameworks.governanceaction.properties.RequestSourceElement> getRequestSourceElements()
      Return the list of elements that triggered this request.
      Returns:
      list of elements

    • setRequestSourceElements

      public void setRequestSourceElements(List<org.odpi.openmetadata.frameworks.governanceaction.properties.RequestSourceElement> requestSourceElements)
      Set up the list of elements that triggered this request.
      Parameters:
      requestSourceElements - list of elements

    • getActionTargetElements

      public List<org.odpi.openmetadata.frameworks.governanceaction.properties.ActionTargetElement> getActionTargetElements()
      Return the list of elements that the governance action will work on.
      Returns:
      list of elements

    • setActionTargetElements

      public void setActionTargetElements(List<org.odpi.openmetadata.frameworks.governanceaction.properties.ActionTargetElement> actionTargetElements)
      Set up the list of elements that the governance action will work on.
      Parameters:
      actionTargetElements - list of elements

    • getRequestedTime

      public Date getRequestedTime()
      Return the time that the governance action was created.
      Returns:
      date/time

    • setRequestedTime

      public void setRequestedTime(Date requestedTime)
      Set up the time that the governance action was created.
      Parameters:
      requestedTime - date/time

    • getStartTime

      public Date getStartTime()
      Return the time that this governance action should start (null means as soon as possible).
      Returns:
      date object

    • setStartTime

      public void setStartTime(Date startTime)
      Set up the time that this governance action should start (null means as soon as possible).
      Parameters:
      startTime - date object

    • getRequestType

      public String getRequestType()
      Return the governance request type used to call the governance service via this governance engine.
      Returns:
      name of the request type

    • setRequestType

      public void setRequestType(String requestType)
      Set up the governance request type used to call the governance service via this governance engine.
      Parameters:
      requestType - name of the request type passed to the governance service

    • getRequestParameters

      public Map<String,String> getRequestParameters()
      Return the parameters to pass onto the governance service.
      Returns:
      map of properties

    • setRequestParameters

      public void setRequestParameters(Map<String,String> requestParameters)
      Set up the parameters to pass onto the governance service.
      Parameters:
      requestParameters - map of properties

    • getCompletionTime

      public Date getCompletionTime()
      Return the date/time that the governance service completed (or null if not yet completed).
      Returns:
      date object

    • setCompletionTime

      public void setCompletionTime(Date completionTime)
      Set up the date/time that the governance service completed (or null if not yet completed).
      Parameters:
      completionTime - date object

    • getCompletionGuards

      public List<String> getCompletionGuards()
      Return the list of completion guards supplied by the governance service.
      Returns:
      list of guards

    • setCompletionGuards

      public void setCompletionGuards(List<String> completionGuards)
      Set up the list of completion guards supplied by the governance service.
      Parameters:
      completionGuards - list of guards

    • 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

    • getPreviousActions

      public List<org.odpi.openmetadata.frameworks.governanceaction.properties.RelatedEngineActionElement> getPreviousActions()
      Return the list of governance actions that preceded this governance action.
      Returns:
      list of element stubs

    • setPreviousActions

      public void setPreviousActions(List<org.odpi.openmetadata.frameworks.governanceaction.properties.RelatedEngineActionElement> previousActions)
      Set up the list of governance actions that preceded this governance action.
      Parameters:
      previousActions - list of element stubs

    • getFollowOnActions

      public List<org.odpi.openmetadata.frameworks.governanceaction.properties.RelatedEngineActionElement> getFollowOnActions()
      Return the list of governance actions that will run after this governance action has completed.
      Returns:
      list of element stubs

    • setFollowOnActions

      public void setFollowOnActions(List<org.odpi.openmetadata.frameworks.governanceaction.properties.RelatedEngineActionElement> followOnActions)
      Set up the list of governance actions that will run after this governance action has completed.
      Parameters:
      followOnActions - list of element stubs

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class ReferenceableProperties
      Returns:
      return string containing the property names and values

    • equals

      public boolean equals(Object objectToCompare)
      Return comparison result based on the content of the properties.
      Overrides:
      equals in class ReferenceableProperties
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

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