Package org.jeyzer.mx.event

Interface JzrEventCode

  • public interface JzrEventCode

    The Jeyzer event code interface gives access to the applicative event information.
    The event code is identified by a unique abbreviation (ex: MAK-101), which is usually a support documentation pointer.
    The name and description (optional, considering event could be documented externally) describe the event.
    The ticket is optional and should refer to a ticket in an issue tracking product such as JIRA.
    The type is optional and could be used to group codes (ex: MAK).
    The event code is associated to a level and sub level indicating its importance.

    It is recommended to implement enumerations of codes that will inherit this interface.

    • Method Detail

      • getAbbreviation

        java.lang.String getAbbreviation()
        Get the event code abbreviation. Mandatory. Usually the enum.name()
        Returns:
        the event code abbreviation

      • getName

        java.lang.String getName()
        Get the event code name. Mandatory
        Returns:
        the event code name

      • getDescription

        java.lang.String getDescription()
        Get the event code description. Optional
        Returns:
        the event code description

      • getTicket

        java.lang.String getTicket()
        Get the event code ticket. Optional
        Returns:
        the event code ticket

      • getType

        java.lang.String getType()
        Get the event type. Optional
        Returns:
        the event type

      • getLevel

        JzrEventLevel getLevel()
        Get the applicative event level.
        Returns:
        the applicative event level

      • getSubLevel

        JzrEventSubLevel getSubLevel()
        Get the applicative event sub level.
        Returns:
        the applicative event sub level