Package org.jlab.jaws.entity

Class AlarmRegistration.Builder

  • All Implemented Interfaces:
    org.apache.avro.data.RecordBuilder<AlarmRegistration>
    Enclosing class:
    AlarmRegistration
    public static class AlarmRegistration.Builder
extends org.apache.avro.specific.SpecificRecordBuilderBase<AlarmRegistration>
implements org.apache.avro.data.RecordBuilder<AlarmRegistration>
    RecordBuilder for AlarmRegistration instances.

    • Method Detail

      • getClass$

        public String getClass$()
        Gets 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
        Returns:
        The value.

      • setClass$

        public AlarmRegistration.Builder 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 of 'class$'.
        Returns:
        This builder.

      • hasClass$

        public boolean hasClass$()
        Checks whether the 'class$' field has been set. The alarm class; provides inheritable shared field values, fields are only overridden if null, the producer field is required and cannot be overridden
        Returns:
        True if the 'class$' field has been set, false otherwise.

      • clearClass$

        public AlarmRegistration.Builder clearClass$()
        Clears 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
        Returns:
        This builder.

      • getProducer

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

      • setProducer

        public AlarmRegistration.Builder 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 of 'producer'.
        Returns:
        This builder.

      • hasProducer

        public boolean hasProducer()
        Checks whether the 'producer' field has been set. Indicates how this alarm is produced, useful for producers to monitor when new alarms are added/removed
        Returns:
        True if the 'producer' field has been set, false otherwise.

      • clearProducer

        public AlarmRegistration.Builder clearProducer()
        Clears the value of the 'producer' field. Indicates how this alarm is produced, useful for producers to monitor when new alarms are added/removed
        Returns:
        This builder.

      • getLocation

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

      • setLocation

        public AlarmRegistration.Builder setLocation​(AlarmLocation value)
        Sets the value of the 'location' field. The alarm location
        Parameters:
        value - The value of 'location'.
        Returns:
        This builder.

      • hasLocation

        public boolean hasLocation()
        Checks whether the 'location' field has been set. The alarm location
        Returns:
        True if the 'location' field has been set, false otherwise.

      • clearLocation

        public AlarmRegistration.Builder clearLocation()
        Clears the value of the 'location' field. The alarm location
        Returns:
        This builder.

      • getCategory

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

      • setCategory

        public AlarmRegistration.Builder setCategory​(AlarmCategory value)
        Sets the value of the 'category' field. The alarm category
        Parameters:
        value - The value of 'category'.
        Returns:
        This builder.

      • hasCategory

        public boolean hasCategory()
        Checks whether the 'category' field has been set. The alarm category
        Returns:
        True if the 'category' field has been set, false otherwise.

      • clearCategory

        public AlarmRegistration.Builder clearCategory()
        Clears the value of the 'category' field. The alarm category
        Returns:
        This builder.

      • getPriority

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

      • setPriority

        public AlarmRegistration.Builder setPriority​(AlarmPriority value)
        Sets the value of the 'priority' field. The alarm priority
        Parameters:
        value - The value of 'priority'.
        Returns:
        This builder.

      • hasPriority

        public boolean hasPriority()
        Checks whether the 'priority' field has been set. The alarm priority
        Returns:
        True if the 'priority' field has been set, false otherwise.

      • clearPriority

        public AlarmRegistration.Builder clearPriority()
        Clears the value of the 'priority' field. The alarm priority
        Returns:
        This builder.

      • getRationale

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

      • setRationale

        public AlarmRegistration.Builder setRationale​(String value)
        Sets the value of the 'rationale' field. Markdown formatted text describing the reason this alarm is necessary
        Parameters:
        value - The value of 'rationale'.
        Returns:
        This builder.

      • hasRationale

        public boolean hasRationale()
        Checks whether the 'rationale' field has been set. Markdown formatted text describing the reason this alarm is necessary
        Returns:
        True if the 'rationale' field has been set, false otherwise.

      • clearRationale

        public AlarmRegistration.Builder clearRationale()
        Clears the value of the 'rationale' field. Markdown formatted text describing the reason this alarm is necessary
        Returns:
        This builder.

      • getCorrectiveaction

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

      • setCorrectiveaction

        public AlarmRegistration.Builder 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 of 'correctiveaction'.
        Returns:
        This builder.

      • hasCorrectiveaction

        public boolean hasCorrectiveaction()
        Checks whether the 'correctiveaction' field has been set. Markdown formatted text describing the corrective action to take when the alarm becomes active
        Returns:
        True if the 'correctiveaction' field has been set, false otherwise.

      • clearCorrectiveaction

        public AlarmRegistration.Builder clearCorrectiveaction()
        Clears the value of the 'correctiveaction' field. Markdown formatted text describing the corrective action to take when the alarm becomes active
        Returns:
        This builder.

      • getPointofcontactusername

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

      • setPointofcontactusername

        public AlarmRegistration.Builder 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 of 'pointofcontactusername'.
        Returns:
        This builder.

      • hasPointofcontactusername

        public boolean hasPointofcontactusername()
        Checks whether the 'pointofcontactusername' field has been set. Username (identifier) of point of contact. Full contact info should be obtained from user database (LDAP for example)
        Returns:
        True if the 'pointofcontactusername' field has been set, false otherwise.

      • clearPointofcontactusername

        public AlarmRegistration.Builder clearPointofcontactusername()
        Clears the value of the 'pointofcontactusername' field. Username (identifier) of point of contact. Full contact info should be obtained from user database (LDAP for example)
        Returns:
        This builder.

      • getLatching

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

      • setLatching

        public AlarmRegistration.Builder 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 of 'latching'.
        Returns:
        This builder.

      • hasLatching

        public boolean hasLatching()
        Checks whether the 'latching' field has been set. Indicates whether this alarm latches when activated and can only be cleared after an explicit acknowledgement
        Returns:
        True if the 'latching' field has been set, false otherwise.

      • clearLatching

        public AlarmRegistration.Builder clearLatching()
        Clears the value of the 'latching' field. Indicates whether this alarm latches when activated and can only be cleared after an explicit acknowledgement
        Returns:
        This builder.

      • getFilterable

        public Boolean getFilterable()
        Gets 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.
        Returns:
        The value.

      • setFilterable

        public AlarmRegistration.Builder 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 of 'filterable'.
        Returns:
        This builder.

      • hasFilterable

        public boolean hasFilterable()
        Checks whether the 'filterable' field has been set. 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.
        Returns:
        True if the 'filterable' field has been set, false otherwise.

      • clearFilterable

        public AlarmRegistration.Builder clearFilterable()
        Clears 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.
        Returns:
        This builder.

      • getOndelayseconds

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

      • setOndelayseconds

        public AlarmRegistration.Builder setOndelayseconds​(Long value)
        Sets the value of the 'ondelayseconds' field. The number of seconds of on-delay
        Parameters:
        value - The value of 'ondelayseconds'.
        Returns:
        This builder.

      • hasOndelayseconds

        public boolean hasOndelayseconds()
        Checks whether the 'ondelayseconds' field has been set. The number of seconds of on-delay
        Returns:
        True if the 'ondelayseconds' field has been set, false otherwise.

      • clearOndelayseconds

        public AlarmRegistration.Builder clearOndelayseconds()
        Clears the value of the 'ondelayseconds' field. The number of seconds of on-delay
        Returns:
        This builder.

      • getOffdelayseconds

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

      • setOffdelayseconds

        public AlarmRegistration.Builder setOffdelayseconds​(Long value)
        Sets the value of the 'offdelayseconds' field. The number of seconds of off-delay
        Parameters:
        value - The value of 'offdelayseconds'.
        Returns:
        This builder.

      • hasOffdelayseconds

        public boolean hasOffdelayseconds()
        Checks whether the 'offdelayseconds' field has been set. The number of seconds of off-delay
        Returns:
        True if the 'offdelayseconds' field has been set, false otherwise.

      • clearOffdelayseconds

        public AlarmRegistration.Builder clearOffdelayseconds()
        Clears the value of the 'offdelayseconds' field. The number of seconds of off-delay
        Returns:
        This builder.

      • getMaskedby

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

      • setMaskedby

        public AlarmRegistration.Builder 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 of 'maskedby'.
        Returns:
        This builder.

      • hasMaskedby

        public boolean hasMaskedby()
        Checks whether the 'maskedby' field has been set. The name of the parent alarm, which if active, masks this alarm (flood suppression via logical hierarchy)
        Returns:
        True if the 'maskedby' field has been set, false otherwise.

      • clearMaskedby

        public AlarmRegistration.Builder clearMaskedby()
        Clears the value of the 'maskedby' field. The name of the parent alarm, which if active, masks this alarm (flood suppression via logical hierarchy)
        Returns:
        This builder.

      • getScreenpath

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

      • setScreenpath

        public AlarmRegistration.Builder setScreenpath​(String value)
        Sets the value of the 'screenpath' field. The path the alarm screen display
        Parameters:
        value - The value of 'screenpath'.
        Returns:
        This builder.

      • hasScreenpath

        public boolean hasScreenpath()
        Checks whether the 'screenpath' field has been set. The path the alarm screen display
        Returns:
        True if the 'screenpath' field has been set, false otherwise.

      • clearScreenpath

        public AlarmRegistration.Builder clearScreenpath()
        Clears the value of the 'screenpath' field. The path the alarm screen display
        Returns:
        This builder.