Class OMRSAuditLogReportingComponent

  • All Implemented Interfaces:
    java.io.Serializable, ComponentDescription

    public class OMRSAuditLogReportingComponent
    extends java.lang.Object
    implements java.io.Serializable, ComponentDescription
    OMRSAuditLogReportingComponent describes the component issuing the audit log record.
    See Also:
    Serialized Form
    • Constructor Detail

      • OMRSAuditLogReportingComponent

        public OMRSAuditLogReportingComponent​(int componentId,
                                              ComponentDevelopmentStatus componentDevelopmentStatus,
                                              java.lang.String componentName,
                                              java.lang.String componentDescription,
                                              java.lang.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​(ComponentDescription template)
        Construct the description of the reporting component.
        Parameters:
        template - object to copy.
    • Method Detail

      • getComponentId

        public int getComponentId()
        Return the numerical code for this component.
        Specified by:
        getComponentId in interface ComponentDescription
        Returns:
        int componentId
      • getComponentName

        public java.lang.String getComponentName()
        Return the name of the component. This is the name used in the audit log records.
        Specified by:
        getComponentName in interface ComponentDescription
        Returns:
        String component name
      • getComponentType

        public java.lang.String getComponentType()
        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:
        getComponentType in interface ComponentDescription
        Returns:
        String description
      • getComponentWikiURL

        public java.lang.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 ComponentDescription
        Returns:
        String URL
      • toString

        public java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class java.lang.Object
        Returns:
        JSON style description of variables.
      • equals

        public boolean equals​(java.lang.Object objectToCompare)
        Validate that an object is equal depending on their stored values.
        Overrides:
        equals in class java.lang.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 java.lang.Object
        Returns:
        in hash code