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

Class GovernanceActionProcessProperties

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
org.odpi.openmetadata.frameworks.governanceaction.properties.GovernanceActionProcessProperties
public class GovernanceActionProcessProperties extends org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
GovernanceActionProcessProperties defines the properties of a governance action process. A governance action process is a series of steps and decisions. It is implemented as an automated process. Each step in the process calls a governance service running in a engine host.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object objectToCompare)
    Compare the values of the supplied object with those stored in the current object.
    String
    getDescription()
    Returns the stored description property for the process.
    String
    getDisplayName()
    Returns the stored display name property for the process.
    int
    getDomainIdentifier()
    Return the identifier of the governance domain that this action belongs to (0=ALL/ANY).
    String
    getFormula()
    Return the description of the processing performed by this process.
    String
    getFormulaType()
    Return the name of the language that the formula is implemented in.
    Date
    getProcessEndTime()
    Return the date/time that this process ended (instance only).
    Date
    getProcessStartTime()
    Return the date/time that this process started (instance only).
    String
    getVersionIdentifier()
    Set up the version identifier of the process.
    int
    hashCode()
    Return hash code for this object
    void
    setDescription(String description)
    Set up the stored description property for the process.
    void
    setDisplayName(String displayName)
    Set up the stored display name property for the process.
    void
    setDomainIdentifier(int domainIdentifier)
    Set up the identifier of the governance domain that this action belongs to (0=ALL/ANY).
    void
    setFormula(String formula)
    Set up the description of the processing performed by this process.
    void
    setFormulaType(String formulaType)
    Set up the name of the language that the formula is implemented in.
    void
    setProcessEndTime(Date processEndTime)
    Set up the date/time that this process ended (instance only).
    void
    setProcessStartTime(Date processStartTime)
    Set up the the date/time that this process started (instance only).
    void
    setVersionIdentifier(String versionIdentifier)
    Set up the version identifier of the process.
    String
    toString()
    Standard toString method.

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties

    getAdditionalProperties, getQualifiedName, getVendorProperties, setAdditionalProperties, setQualifiedName, setVendorProperties

    Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties

    getEffectiveFrom, getEffectiveTo, getExtendedProperties, getTypeName, setEffectiveFrom, setEffectiveTo, setExtendedProperties, setTypeName

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • GovernanceActionProcessProperties

      public GovernanceActionProcessProperties()
      Default constructor

    • GovernanceActionProcessProperties

      public GovernanceActionProcessProperties(GovernanceActionProcessProperties template)
      Copy/clone Constructor
      Parameters:
      template - 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()
      Returns the stored display name property for the process. If no display name is available then null is returned.
      Returns:
      String name

    • setDisplayName

      public void setDisplayName(String displayName)
      Set up the stored display name property for the process.
      Parameters:
      displayName - String name

    • getDescription

      public String getDescription()
      Returns the stored description property for the process. If no description is provided then null is returned.
      Returns:
      String text

    • setDescription

      public void setDescription(String description)
      Set up the stored description property for the process.
      Parameters:
      description - String text

    • getVersionIdentifier

      public String getVersionIdentifier()
      Set up the version identifier of the process.
      Returns:
      string version name

    • setVersionIdentifier

      public void setVersionIdentifier(String versionIdentifier)
      Set up the version identifier of the process.
      Parameters:
      versionIdentifier - string version name

    • getFormula

      public String getFormula()
      Return the description of the processing performed by this process.
      Returns:
      string description

    • setFormula

      public void setFormula(String formula)
      Set up the description of the processing performed by this process.
      Parameters:
      formula - string description

    • getFormulaType

      public String getFormulaType()
      Return the name of the language that the formula is implemented in.
      Returns:
      string name

    • setFormulaType

      public void setFormulaType(String formulaType)
      Set up the name of the language that the formula is implemented in.
      Parameters:
      formulaType - string name

    • getProcessStartTime

      public Date getProcessStartTime()
      Return the date/time that this process started (instance only).
      Returns:
      date

    • setProcessStartTime

      public void setProcessStartTime(Date processStartTime)
      Set up the the date/time that this process started (instance only).
      Parameters:
      processStartTime - date

    • getProcessEndTime

      public Date getProcessEndTime()
      Return the date/time that this process ended (instance only).
      Returns:
      date

    • setProcessEndTime

      public void setProcessEndTime(Date processEndTime)
      Set up the date/time that this process ended (instance only).
      Parameters:
      processEndTime - date

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
      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 org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
      Returns:
      int hash code