Interface WaitEvent

    • Method Detail

      • isClearsEvent

        boolean isClearsEvent()
        Get the value for ClearsEvent. (Is the event cleared by this wait event?)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getClearComment

        String getClearComment()
        Get the value for ClearComment. (Comment to set as clearComment on the event if this WaitEvent clears the event.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setClearsEvent

        void setClearsEvent​(boolean newClearsEvent)
        Set the value for ClearsEvent. (Is the event cleared by this wait event?)
        Parameters:
        newClearsEvent - the new value for ClearsEvent.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setClearComment

        void setClearComment​(String newClearComment)
        Set the value for ClearComment. (Comment to set as clearComment on the event if this WaitEvent clears the event.) This value is optional.
        Parameters:
        newClearComment - the new value for ClearComment.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.