Package org.odpi.openmetadata.frameworks.auditlog

Interface ComponentDescription

All Known Implementing Classes:
AuditLogReportingComponent, OMRSAuditingComponent, OMRSAuditLogReportingComponent
public interface ComponentDescription
ComponentDescription is an interface implemented by an enum that describes the components using the audit log

  • Method Details

    • getComponentId

      int getComponentId()
      Return the numerical code for this component.
      Returns:
      int componentId

    • getComponentDevelopmentStatus

      ComponentDevelopmentStatus getComponentDevelopmentStatus()
      Return the development status of the component.
      Returns:
      enum describing the status

    • getComponentName

      String getComponentName()
      Return the name of the component. This is the name used in the audit log records.
      Returns:
      String component name

    • getComponentDescription

      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.
      Returns:
      String description

    • getComponentWikiURL

      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.
      Returns:
      String URL