Package org.odpi.openmetadata.repositoryservices.connectors.stores.auditlogstore

Class OMRSAuditLogReportingComponent

java.lang.Object
org.odpi.openmetadata.repositoryservices.connectors.stores.auditlogstore.OMRSAuditLogReportingComponent
All Implemented Interfaces:
Serializable, org.odpi.openmetadata.frameworks.auditlog.ComponentDescription
public class OMRSAuditLogReportingComponent extends Object implements Serializable, org.odpi.openmetadata.frameworks.auditlog.ComponentDescription
OMRSAuditLogReportingComponent describes the component issuing the audit log record.
See Also:

  • Constructor Details

    • OMRSAuditLogReportingComponent

      public OMRSAuditLogReportingComponent(int componentId, org.odpi.openmetadata.frameworks.auditlog.ComponentDevelopmentStatus componentDevelopmentStatus, String componentName, String componentDescription, String componentWikiURL)
      Construct the description of the reporting component.
      Parameters:
      componentId - numerical identifier for the component.
      componentDevelopmentStatus - status of the component's implementation
      componentName - display name for the component.
      componentDescription - description of the component.
      componentWikiURL - link to more information.

    • OMRSAuditLogReportingComponent

      public OMRSAuditLogReportingComponent(org.odpi.openmetadata.frameworks.auditlog.ComponentDescription template)
      Construct the description of the reporting component.
      Parameters:
      template - object to copy.

  • Method Details

    • 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()
      Standard toString method.
      Overrides:
      toString in class Object
      Returns:
      JSON style description of variables.

    • equals

      public boolean equals(Object objectToCompare)
      Validate that an object is equal depending on their stored values.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - object
      Returns:
      boolean result

    • hashCode

      public int hashCode()
      Return a hash code based on the values of this object.
      Overrides:
      hashCode in class Object
      Returns:
      in hash code