Package com.redwood.scheduler.api.model

Interface QueryCondition

    • Method Detail

      • getType

        QueryConditionType getType()
        Get the value for Type. (QueryConditiontype for this QueryCondition. The QueryConditionType determines the actual where clause.) 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.

      • getTypeValue

        String getTypeValue()
        Get the value for TypeValue. (Some queryConditionTypes can need additional information. This information is stored in this field. See the QueryConditionType enumeration for more information about which type needs what information)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getConditionText

        String getConditionText()
        Get the value for ConditionText. (Human readable text for the user that describes the condition.) 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.

      • getDisplayOrder

        Long getDisplayOrder()
        Get the value for DisplayOrder. (Order in which the sentence should be shown in the sentence list. If the order is -1, it is not shown.) 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.

      • isValue1Mandatory

        boolean isValue1Mandatory()
        Get the value for Value1Mandatory. (True if value1 on the QueryConditionValue is mandatory.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • isValue2Mandatory

        boolean isValue2Mandatory()
        Get the value for Value2Mandatory. (True if value2 on the QueryConditionValue is mandatory.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setType

        void setType​(QueryConditionType newType)
        Set the value for Type. (QueryConditiontype for this QueryCondition. The QueryConditionType determines the actual where clause.) This value is mandatory.
        Parameters:
        newType - the new value for Type. 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.

      • setTypeValue

        void setTypeValue​(String newTypeValue)
        Set the value for TypeValue. (Some queryConditionTypes can need additional information. This information is stored in this field. See the QueryConditionType enumeration for more information about which type needs what information) This value is optional.
        Parameters:
        newTypeValue - the new value for TypeValue.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setConditionText

        void setConditionText​(String newConditionText)
        Set the value for ConditionText. (Human readable text for the user that describes the condition.) This value is mandatory.
        Parameters:
        newConditionText - the new value for ConditionText. 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.

      • setDisplayOrder

        void setDisplayOrder​(Long newDisplayOrder)
        Set the value for DisplayOrder. (Order in which the sentence should be shown in the sentence list. If the order is -1, it is not shown.) This value is mandatory.
        Parameters:
        newDisplayOrder - the new value for DisplayOrder. 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.

      • setObjectDefinition

        void setObjectDefinition​(ObjectDefinition newObjectDefinition)
        Set the value for ObjectDefinition. This value is mandatory.
        Parameters:
        newObjectDefinition - is the object to set ObjectDefinition to. If this is null, then the object cannot be persisted.

      • setObjectFieldDefinition

        void setObjectFieldDefinition​(ObjectFieldDefinition newObjectFieldDefinition)
        Set the value for ObjectFieldDefinition. This value is optional.
        Parameters:
        newObjectFieldDefinition - is the object to set ObjectFieldDefinition to.

      • getQueryConditionValueByQueryFilterInclude

        QueryConditionValue getQueryConditionValueByQueryFilterInclude​(QueryFilter queryFilter,
                                                               QueryConditionValueInclude include)
        Get the QueryConditionValue by QueryCondVal.
        Parameters:
        queryFilter -
        include -
        Returns:
        the QueryConditionValue, or null if it could not be found