Enum OMRSEventCategory

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

    public enum OMRSEventCategory
    extends java.lang.Enum<OMRSEventCategory>
    implements java.io.Serializable
    OMRSEventCategory defines the different categories of events that pass through the OMRS Topic.
    • UNKNOWN: this is either an uninitialized event, or the incoming event is not supported by the local server.
    • REGISTRY: this is an event used by the cohort registries to manage the membership of the cohort.
    • TYPEDEF: this is an event used by the metadata repository connectors to synchronize the metadata types (stored in TypeDefs) across the metadata repository cohort.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Return the default description of the event category.
      java.lang.String getName()
      Return the name of the event category.
      int getOrdinal()
      Return the code number for the event category.
      java.lang.String toString()
      toString() JSON-style
      static OMRSEventCategory valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static OMRSEventCategory[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Method Detail

      • values

        public static OMRSEventCategory[] 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 (OMRSEventCategory c : OMRSEventCategory.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static OMRSEventCategory 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
      • getOrdinal

        public int getOrdinal()
        Return the code number for the event category.
        Returns:
        int code number
      • getName

        public java.lang.String getName()
        Return the name of the event category.
        Returns:
        String name
      • getDescription

        public java.lang.String getDescription()
        Return the default description of the event category. This description is in English and is a default value for the situation when the natural language resource bundle for Event Category is not available.
        Returns:
        String default description
      • toString

        public java.lang.String toString()
        toString() JSON-style
        Overrides:
        toString in class java.lang.Enum<OMRSEventCategory>
        Returns:
        string description