Interface MonitorValue

    • Method Detail

      • getCreationTime

        DateTimeZone getCreationTime()
        Get the value for CreationTime. (Timestamp that notes when the monitor was created.)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getLastModificationTime

        DateTimeZone getLastModificationTime()
        Get the value for LastModificationTime. (Timestamp that notes when the object was updated.)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getType

        ParameterType getType()
        Get the value for Type. (What is the format of the value) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getValueDate

        DateTimeZone getValueDate()
        Get the value for ValueDate. (The actual date monitor value)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getValueNumber

        BigDecimal getValueNumber()
        Get the value for ValueNumber. (The actual numeric monitor value)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • getValueString

        String getValueString()
        Get the value for ValueString. (The actual string monitor value)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • setType

        void setType​(ParameterType newType)
        Set the value for Type. (What is the format of the value) This value is mandatory.
        Parameters:
        newType - the new value for Type. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.
      • updateValue

        void updateValue​(Object value)
        Used to update the value that is stored.
        Parameters:
        value - The new value for the monitor
      • getMonitorCheck

        MonitorCheck getMonitorCheck()
        Get the MonitorCheck.
        Returns:
        MonitorCheck
        Throws:
        com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.
      • getObjectFieldDefinition

        ObjectFieldDefinition getObjectFieldDefinition()
        Get the ObjectFieldDefinition.
        Returns:
        ObjectFieldDefinition
        Throws:
        com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.
      • getLastModifierSubject

        Subject getLastModifierSubject()
        Get the LastModifierSubject.
        Returns:
        LastModifierSubject
        Throws:
        com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.
      • setObjectFieldDefinition

        void setObjectFieldDefinition​(ObjectFieldDefinition newObjectFieldDefinition)
        Set the value for ObjectFieldDefinition. This value is optional.
        Parameters:
        newObjectFieldDefinition - is the object to set ObjectFieldDefinition to. The object field of this monitor definition.