Package org.odpi.openmetadata.repositoryservices.auditlog

Enum Class OMRSAuditingComponent

java.lang.Object
java.lang.Enum<OMRSAuditingComponent>
org.odpi.openmetadata.repositoryservices.auditlog.OMRSAuditingComponent
All Implemented Interfaces:
Serializable, Comparable<OMRSAuditingComponent>, Constable, org.odpi.openmetadata.frameworks.auditlog.ComponentDescription
public enum OMRSAuditingComponent extends Enum<OMRSAuditingComponent> implements org.odpi.openmetadata.frameworks.auditlog.ComponentDescription
OMRSAuditingComponent provides identifying and background information about the components writing log records to the OMRS Audit log. This is to help a consumer understand the OMRS Audit Log records.

  • Enum Constant Details

  • Method Details

    • values

      public static OMRSAuditingComponent[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static OMRSAuditingComponent valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getComponentId

      public int getComponentId()
      Return the numerical code for this component.
      Specified by:
      getComponentId in interface org.odpi.openmetadata.frameworks.auditlog.ComponentDescription
      Returns:
      int componentId

    • getComponentDevelopmentStatus

      public org.odpi.openmetadata.frameworks.auditlog.ComponentDevelopmentStatus getComponentDevelopmentStatus()
      Return the development status of the component.
      Specified by:
      getComponentDevelopmentStatus in interface org.odpi.openmetadata.frameworks.auditlog.ComponentDescription
      Returns:
      enum describing the status

    • getComponentName

      public String getComponentName()
      Return the name of the component. This is the name used in the audit log records.
      Specified by:
      getComponentName in interface org.odpi.openmetadata.frameworks.auditlog.ComponentDescription
      Returns:
      String component name

    • getComponentDescription

      public String getComponentDescription()
      Return the short description of the component. This is an English description. Natural language support for these values can be added to UIs using a resource bundle indexed with the component id. This value is provided as a default if the resource bundle is not available.
      Specified by:
      getComponentDescription in interface org.odpi.openmetadata.frameworks.auditlog.ComponentDescription
      Returns:
      String description

    • getComponentWikiURL

      public String getComponentWikiURL()
      URL to the wiki page that describes this component. This provides more information to the log reader on the operation of the component.
      Specified by:
      getComponentWikiURL in interface org.odpi.openmetadata.frameworks.auditlog.ComponentDescription
      Returns:
      String URL

    • toString

      public String toString()
      toString, JSON-style
      Overrides:
      toString in class Enum<OMRSAuditingComponent>
      Returns:
      string description