Package com.redwood.scheduler.api.model

Interface QueryConditionValue

  • All Superinterfaces:
    Association, Readable, SchedulerEntity, SchedulerEntityComp
    public interface QueryConditionValue
extends Association, Readable
    Values provided by the user for the given QueryFilter / QueryCondition combination. When a QueryCondition is selected for a QueryFilter, a QueryConditionValue is created, with the appropriate values for the input fields the QueryCondition require.

    • Method Detail

      • getInclude

        QueryConditionValueInclude getInclude()
        Get the value for Include. (Does this condition show (true) or hide (false) the objects that match the QueryConditions.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getValue1

        String getValue1()
        Get the value for Value1. (Value for the first field (if required by QueryCondition), or the default value if prompt1 is true.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getValue2

        String getValue2()
        Get the value for Value2. (Value for the second field (if required by QueryCondition), or the default value if prompt2 is true.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setInclude

        void setInclude​(QueryConditionValueInclude newInclude)
        Set the value for Include. (Does this condition show (true) or hide (false) the objects that match the QueryConditions.) This value is mandatory.
        Parameters:
        newInclude - the new value for Include. If this is null, then the object cannot be persisted.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setValue1

        void setValue1​(String newValue1)
        Set the value for Value1. (Value for the first field (if required by QueryCondition), or the default value if prompt1 is true.) This value is optional.
        Parameters:
        newValue1 - the new value for Value1.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setValue2

        void setValue2​(String newValue2)
        Set the value for Value2. (Value for the second field (if required by QueryCondition), or the default value if prompt2 is true.) This value is optional.
        Parameters:
        newValue2 - the new value for Value2.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.