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

Class EngineActionElement

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
org.odpi.openmetadata.frameworks.governanceaction.properties.EngineActionElement
public class EngineActionElement extends ReferenceableProperties
EngineActionElement contains the properties and header for a EngineAction entity retrieved from the metadata repository that represents the execution of a call to a governance engine. This may be triggered by directly creating the engine action, or using a governance action type as a template or as a step in a governance action process.

  • Constructor Details

    • EngineActionElement

      public EngineActionElement()
      Default constructor

    • EngineActionElement

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

  • Method Details

    • getElementHeader

      public ElementHeader getElementHeader()
      Return the element header associated with the properties.
      Returns:
      element header object

    • setElementHeader

      public void setElementHeader(ElementHeader elementHeader)
      Set up the element header associated with the properties.
      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 engine action.
      Returns:
      string name

    • setDisplayName

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

    • getDescription

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

    • setDescription

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

    • getMandatoryGuards

      public List<String> getMandatoryGuards()
      Return the list of guards that must be received before this engine 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 engine 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 engine action.
      Returns:
      string guid

    • setGovernanceEngineGUID

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

    • getGovernanceEngineName

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

    • setGovernanceEngineName

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

    • getGovernanceActionTypeGUID

      public String getGovernanceActionTypeGUID()
      Return the unique identifier for the governance action type that acted as a template for this engine 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 engine 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 engine 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 engine action (if appropriate).
      Parameters:
      governanceActionTypeName - 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

    • getProcessStepGUID

      public String getProcessStepGUID()
      Return the unique identifier for the governance action process step that acted as a template for this engine action (if appropriate).
      Returns:
      guid

    • setProcessStepGUID

      public void setProcessStepGUID(String processStepGUID)
      Set up the unique identifier for the governance action process step that acted as a template for this engine action (if appropriate).
      Parameters:
      processStepGUID - guid

    • getProcessStepName

      public String getProcessStepName()
      Return the unique name for the governance action process step that acted as a template for this engine action (if appropriate).
      Returns:
      name

    • setProcessStepName

      public void setProcessStepName(String processStepName)
      Set up the unique name for the governance action process step that acted as a template for this engine action (if appropriate).
      Parameters:
      processStepName - name

    • getActionStatus

      public EngineActionStatus getActionStatus()
      Return the current status of the engine action.
      Returns:
      status enum

    • setActionStatus

      public void setActionStatus(EngineActionStatus actionStatus)
      Set up the current status of the engine 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 engine 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 engine action.
      Parameters:
      processingEngineUserId - string userId

    • getRequestSourceElements

      public List<RequestSourceElement> getRequestSourceElements()
      Return the list of elements that triggered this request.
      Returns:
      list of elements

    • setRequestSourceElements

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

    • getActionTargetElements

      public List<ActionTargetElement> getActionTargetElements()
      Return the list of elements that the engine action will work on.
      Returns:
      list of elements

    • setActionTargetElements

      public void setActionTargetElements(List<ActionTargetElement> actionTargetElements)
      Set up the list of elements that the engine action will work on.
      Parameters:
      actionTargetElements - list of elements

    • getRequestedTime

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

    • setRequestedTime

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

    • getRequestedStartTime

      public Date getRequestedStartTime()
      Return the time that the engine action should start.
      Returns:
      date/time

    • setRequestedStartTime

      public void setRequestedStartTime(Date requestedStartTime)
      Set up the time that the engine action should start.
      Parameters:
      requestedStartTime - date/time

    • getStartTime

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

    • setStartTime

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

    • getRequesterUserId

      public String getRequesterUserId()
      Return the requesting user
      Returns:
      string

    • setRequesterUserId

      public void setRequesterUserId(String requesterUserId)
      Set up the requesting user.
      Parameters:
      requesterUserId - string

    • 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<RelatedEngineActionElement> getPreviousActions()
      Return the list of engine actions that preceded this engine action.
      Returns:
      list of element stubs

    • setPreviousActions

      public void setPreviousActions(List<RelatedEngineActionElement> previousActions)
      Set up the list of engine actions that preceded this engine action.
      Parameters:
      previousActions - list of element stubs

    • getFollowOnActions

      public List<RelatedEngineActionElement> getFollowOnActions()
      Return the list of engine actions that will run after this engine action has completed.
      Returns:
      list of element stubs

    • setFollowOnActions

      public void setFollowOnActions(List<RelatedEngineActionElement> followOnActions)
      Set up the list of engine actions that will run after this engine 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