Package org.odpi.openmetadata.accessservices.governanceengine.properties

Class GovernanceActionTypeProperties

java.lang.Object
org.odpi.openmetadata.accessservices.governanceengine.properties.ReferenceableProperties
org.odpi.openmetadata.accessservices.governanceengine.properties.GovernanceActionTypeProperties
public class GovernanceActionTypeProperties extends ReferenceableProperties
GovernanceActionTypeProperties provides a structure for carrying the properties for a governance action type.

  • Constructor Details

    • GovernanceActionTypeProperties

      public GovernanceActionTypeProperties()
      Default constructor

    • GovernanceActionTypeProperties

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

  • Method Details

    • 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

    • getProducedGuards

      public Map<String,String> getProducedGuards()
      Return the list of guards provided by the previous governance service.
      Returns:
      map of guards to description

    • setProducedGuards

      public void setProducedGuards(Map<String,String> producedGuards)
      Set up the list of guards provided by the previous governance service.
      Parameters:
      producedGuards - map of guards to description

    • 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

    • getRequestType

      public String getRequestType()
      Return the request type associated with this governance action.
      Returns:
      string name

    • setRequestType

      public void setRequestType(String requestType)
      Set up the request type associated with this governance action, used to identify ths governance service to run.
      Parameters:
      requestType - string name

    • 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

    • getIgnoreMultipleTriggers

      public boolean getIgnoreMultipleTriggers()
      Return whether this action type can be triggered more than once in a single step of the governance action process.
      Returns:
      boolean flag

    • setIgnoreMultipleTriggers

      public void setIgnoreMultipleTriggers(boolean ignoreMultipleTriggers)
      Set up whether this action type can be triggered more than once in a single step of the governance action process.
      Parameters:
      ignoreMultipleTriggers - boolean flag

    • getWaitTime

      public int getWaitTime()
      Return the minimum number of minutes to wait before starting the next governance action.
      Returns:
      int (minutes)

    • setWaitTime

      public void setWaitTime(int waitTime)
      Set up the minimum number of minutes to wait before starting the next governance action.
      Parameters:
      waitTime - int (minutes)

    • toString

      public String toString()
      JSON-style toString.
      Overrides:
      toString in class ReferenceableProperties
      Returns:
      list of properties and their values.

    • equals

      public boolean equals(Object objectToCompare)
      Equals method that returns true if containing properties are the same.
      Overrides:
      equals in class ReferenceableProperties
      Parameters:
      objectToCompare - object to compare
      Returns:
      boolean result of comparison

    • hashCode

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