Enum OMRSAuditingComponent

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<OMRSAuditingComponent>, ComponentDescription

    public enum OMRSAuditingComponent
    extends java.lang.Enum<OMRSAuditingComponent>
    implements 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.
    • Method Detail

      • values

        public static OMRSAuditingComponent[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (OMRSAuditingComponent c : OMRSAuditingComponent.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static OMRSAuditingComponent valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • 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()
        toString, JSON-style
        Overrides:
        toString in class java.lang.Enum<OMRSAuditingComponent>
        Returns:
        string description