Package org.jlab.jaws.entity

Class AlarmRegistration

  • All Implemented Interfaces:
    Externalizable, Serializable, Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.GenericRecord, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
    public class AlarmRegistration
extends org.apache.avro.specific.SpecificRecordBase
implements org.apache.avro.specific.SpecificRecord
    Master alarm database record
    See Also:
    Serialized Form

    • Field Detail

      • SCHEMA$

        public static final org.apache.avro.Schema SCHEMA$

    • Constructor Detail

      • AlarmRegistration

        public AlarmRegistration()
        Default constructor. Note that this does not initialize fields to their default values from the schema. If that is desired then one should use newBuilder().

      • AlarmRegistration

        public AlarmRegistration​(String class$,
                         Object producer,
                         AlarmLocation location,
                         AlarmCategory category,
                         AlarmPriority priority,
                         String rationale,
                         String correctiveaction,
                         String pointofcontactusername,
                         Boolean latching,
                         Boolean filterable,
                         Long ondelayseconds,
                         Long offdelayseconds,
                         String maskedby,
                         String screenpath)
        All-args constructor.
        Parameters:
        class$ - The alarm class; provides inheritable shared field values, fields are only overridden if null, the producer field is required and cannot be overridden
        producer - Indicates how this alarm is produced, useful for producers to monitor when new alarms are added/removed
        location - The alarm location
        category - The alarm category
        priority - The alarm priority
        rationale - Markdown formatted text describing the reason this alarm is necessary
        correctiveaction - Markdown formatted text describing the corrective action to take when the alarm becomes active
        pointofcontactusername - Username (identifier) of point of contact. Full contact info should be obtained from user database (LDAP for example)
        latching - Indicates whether this alarm latches when activated and can only be cleared after an explicit acknowledgement
        filterable - Indicates whether this alarm can be filtered out of view (typically done when a portion of the machine is turned off). Some alarms must always be monitored, regardless of program.
        ondelayseconds - The number of seconds of on-delay
        offdelayseconds - The number of seconds of off-delay
        maskedby - The name of the parent alarm, which if active, masks this alarm (flood suppression via logical hierarchy)
        screenpath - The path the alarm screen display

    • Method Detail

      • getClassSchema

        public static org.apache.avro.Schema getClassSchema()

      • getEncoder

        public static org.apache.avro.message.BinaryMessageEncoder<AlarmRegistration> getEncoder()
        Return the BinaryMessageEncoder instance used by this class.
        Returns:
        the message encoder used by this class

      • getDecoder

        public static org.apache.avro.message.BinaryMessageDecoder<AlarmRegistration> getDecoder()
        Return the BinaryMessageDecoder instance used by this class.
        Returns:
        the message decoder used by this class

      • createDecoder

        public static org.apache.avro.message.BinaryMessageDecoder<AlarmRegistration> createDecoder​(org.apache.avro.message.SchemaStore resolver)
        Create a new BinaryMessageDecoder instance for this class that uses the specified SchemaStore.
        Parameters:
        resolver - a SchemaStore used to find schemas by fingerprint
        Returns:
        a BinaryMessageDecoder instance for this class backed by the given SchemaStore

      • toByteBuffer

        public ByteBuffer toByteBuffer()
                        throws IOException
        Serializes this AlarmRegistration to a ByteBuffer.
        Returns:
        a buffer holding the serialized data for this instance
        Throws:
        IOException - if this instance could not be serialized

      • fromByteBuffer

        public static AlarmRegistration fromByteBuffer​(ByteBuffer b)
                                        throws IOException
        Deserializes a AlarmRegistration from a ByteBuffer.
        Parameters:
        b - a byte buffer holding serialized data for an instance of this class
        Returns:
        a AlarmRegistration instance decoded from the given buffer
        Throws:
        IOException - if the given bytes could not be deserialized into an instance of this class

      • getSpecificData

        public org.apache.avro.specific.SpecificData getSpecificData()
        Overrides:
        getSpecificData in class org.apache.avro.specific.SpecificRecordBase

      • getSchema

        public org.apache.avro.Schema getSchema()
        Specified by:
        getSchema in interface org.apache.avro.generic.GenericContainer
        Specified by:
        getSchema in class org.apache.avro.specific.SpecificRecordBase

      • get

        public Object get​(int field$)
        Specified by:
        get in interface org.apache.avro.generic.IndexedRecord
        Specified by:
        get in class org.apache.avro.specific.SpecificRecordBase

      • put

        public void put​(int field$,
                Object value$)
        Specified by:
        put in interface org.apache.avro.generic.IndexedRecord
        Specified by:
        put in class org.apache.avro.specific.SpecificRecordBase

      • getClass$

        public String getClass$()
        Gets the value of the 'class$' field.
        Returns:
        The alarm class; provides inheritable shared field values, fields are only overridden if null, the producer field is required and cannot be overridden

      • setClass$

        public void setClass$​(String value)
        Sets the value of the 'class$' field. The alarm class; provides inheritable shared field values, fields are only overridden if null, the producer field is required and cannot be overridden
        Parameters:
        value - the value to set.

      • getProducer

        public Object getProducer()
        Gets the value of the 'producer' field.
        Returns:
        Indicates how this alarm is produced, useful for producers to monitor when new alarms are added/removed

      • setProducer

        public void setProducer​(Object value)
        Sets the value of the 'producer' field. Indicates how this alarm is produced, useful for producers to monitor when new alarms are added/removed
        Parameters:
        value - the value to set.

      • getLocation

        public AlarmLocation getLocation()
        Gets the value of the 'location' field.
        Returns:
        The alarm location

      • setLocation

        public void setLocation​(AlarmLocation value)
        Sets the value of the 'location' field. The alarm location
        Parameters:
        value - the value to set.

      • getCategory

        public AlarmCategory getCategory()
        Gets the value of the 'category' field.
        Returns:
        The alarm category

      • setCategory

        public void setCategory​(AlarmCategory value)
        Sets the value of the 'category' field. The alarm category
        Parameters:
        value - the value to set.

      • getPriority

        public AlarmPriority getPriority()
        Gets the value of the 'priority' field.
        Returns:
        The alarm priority

      • setPriority

        public void setPriority​(AlarmPriority value)
        Sets the value of the 'priority' field. The alarm priority
        Parameters:
        value - the value to set.

      • getRationale

        public String getRationale()
        Gets the value of the 'rationale' field.
        Returns:
        Markdown formatted text describing the reason this alarm is necessary

      • setRationale

        public void setRationale​(String value)
        Sets the value of the 'rationale' field. Markdown formatted text describing the reason this alarm is necessary
        Parameters:
        value - the value to set.

      • getCorrectiveaction

        public String getCorrectiveaction()
        Gets the value of the 'correctiveaction' field.
        Returns:
        Markdown formatted text describing the corrective action to take when the alarm becomes active

      • setCorrectiveaction

        public void setCorrectiveaction​(String value)
        Sets the value of the 'correctiveaction' field. Markdown formatted text describing the corrective action to take when the alarm becomes active
        Parameters:
        value - the value to set.

      • getPointofcontactusername

        public String getPointofcontactusername()
        Gets the value of the 'pointofcontactusername' field.
        Returns:
        Username (identifier) of point of contact. Full contact info should be obtained from user database (LDAP for example)

      • setPointofcontactusername

        public void setPointofcontactusername​(String value)
        Sets the value of the 'pointofcontactusername' field. Username (identifier) of point of contact. Full contact info should be obtained from user database (LDAP for example)
        Parameters:
        value - the value to set.

      • getLatching

        public Boolean getLatching()
        Gets the value of the 'latching' field.
        Returns:
        Indicates whether this alarm latches when activated and can only be cleared after an explicit acknowledgement

      • setLatching

        public void setLatching​(Boolean value)
        Sets the value of the 'latching' field. Indicates whether this alarm latches when activated and can only be cleared after an explicit acknowledgement
        Parameters:
        value - the value to set.

      • getFilterable

        public Boolean getFilterable()
        Gets the value of the 'filterable' field.
        Returns:
        Indicates whether this alarm can be filtered out of view (typically done when a portion of the machine is turned off). Some alarms must always be monitored, regardless of program.

      • setFilterable

        public void setFilterable​(Boolean value)
        Sets the value of the 'filterable' field. Indicates whether this alarm can be filtered out of view (typically done when a portion of the machine is turned off). Some alarms must always be monitored, regardless of program.
        Parameters:
        value - the value to set.

      • getOndelayseconds

        public Long getOndelayseconds()
        Gets the value of the 'ondelayseconds' field.
        Returns:
        The number of seconds of on-delay

      • setOndelayseconds

        public void setOndelayseconds​(Long value)
        Sets the value of the 'ondelayseconds' field. The number of seconds of on-delay
        Parameters:
        value - the value to set.

      • getOffdelayseconds

        public Long getOffdelayseconds()
        Gets the value of the 'offdelayseconds' field.
        Returns:
        The number of seconds of off-delay

      • setOffdelayseconds

        public void setOffdelayseconds​(Long value)
        Sets the value of the 'offdelayseconds' field. The number of seconds of off-delay
        Parameters:
        value - the value to set.

      • getMaskedby

        public String getMaskedby()
        Gets the value of the 'maskedby' field.
        Returns:
        The name of the parent alarm, which if active, masks this alarm (flood suppression via logical hierarchy)

      • setMaskedby

        public void setMaskedby​(String value)
        Sets the value of the 'maskedby' field. The name of the parent alarm, which if active, masks this alarm (flood suppression via logical hierarchy)
        Parameters:
        value - the value to set.

      • getScreenpath

        public String getScreenpath()
        Gets the value of the 'screenpath' field.
        Returns:
        The path the alarm screen display

      • setScreenpath

        public void setScreenpath​(String value)
        Sets the value of the 'screenpath' field. The path the alarm screen display
        Parameters:
        value - the value to set.

      • newBuilder

        public static AlarmRegistration.Builder newBuilder()
        Creates a new AlarmRegistration RecordBuilder.
        Returns:
        A new AlarmRegistration RecordBuilder

      • newBuilder

        public static AlarmRegistration.Builder newBuilder​(AlarmRegistration.Builder other)
        Creates a new AlarmRegistration RecordBuilder by copying an existing Builder.
        Parameters:
        other - The existing builder to copy.
        Returns:
        A new AlarmRegistration RecordBuilder

      • newBuilder

        public static AlarmRegistration.Builder newBuilder​(AlarmRegistration other)
        Creates a new AlarmRegistration RecordBuilder by copying an existing AlarmRegistration instance.
        Parameters:
        other - The existing instance to copy.
        Returns:
        A new AlarmRegistration RecordBuilder