Package com.redwood.scheduler.api.model

Interface QueryFilter

    • Method Detail

      • isAndExpressions

        boolean isAndExpressions()
        Get the value for AndExpressions. ( Should all the QueryExpressions this QueryFilter has be concatenated with And (true) or Or (false). Use IncludeCombiner/ExcludeCombiner to set the operator for either the include or exclude expression. )
        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.

      • getIncludeCombiner

        QueryConditionValueCombiner getIncludeCombiner()
        Get the value for IncludeCombiner. (Combine operator for the include expressions of this QueryFilter.) 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.

      • getExcludeCombiner

        QueryConditionValueCombiner getExcludeCombiner()
        Get the value for ExcludeCombiner. (Combine operator for the exclude expressions of this QueryFilter. When the value is omitted 'And' will be used.)
        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.

      • getDisplayOrder

        Long getDisplayOrder()
        Get the value for DisplayOrder. (Order in which the filters should be shown in the filterlist. 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:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • isMonitorOnDashboard

        boolean isMonitorOnDashboard()
        Get the value for MonitorOnDashboard. (Should the query filter be monitored on the dashboard? This is a calculated field, stored in an object tag, and may be deleted in the future.)
        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.

      • setAndExpressions

        void setAndExpressions​(boolean newAndExpressions)
        Set the value for AndExpressions. ( Should all the QueryExpressions this QueryFilter has be concatenated with And (true) or Or (false). Use IncludeCombiner/ExcludeCombiner to set the operator for either the include or exclude expression. )
        Parameters:
        newAndExpressions - the new value for AndExpressions.
        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.

      • setIncludeCombiner

        void setIncludeCombiner​(QueryConditionValueCombiner newIncludeCombiner)
        Set the value for IncludeCombiner. (Combine operator for the include expressions of this QueryFilter.) This value is mandatory.
        Parameters:
        newIncludeCombiner - the new value for IncludeCombiner. 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.

      • setExcludeCombiner

        void setExcludeCombiner​(QueryConditionValueCombiner newExcludeCombiner)
        Set the value for ExcludeCombiner. (Combine operator for the exclude expressions of this QueryFilter. When the value is omitted 'And' will be used.) This value is optional.
        Parameters:
        newExcludeCombiner - the new value for ExcludeCombiner.
        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.

      • setDisplayOrder

        void setDisplayOrder​(Long newDisplayOrder)
        Set the value for DisplayOrder. (Order in which the filters should be shown in the filterlist. 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:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setMonitorOnDashboard

        void setMonitorOnDashboard​(boolean newMonitorOnDashboard)
        Set the value for MonitorOnDashboard. (Should the query filter be monitored on the dashboard? This is a calculated field, stored in an object tag, and may be deleted in the future.)
        Parameters:
        newMonitorOnDashboard - the new value for MonitorOnDashboard.
        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.

      • createObjectTag

        ObjectTag createObjectTag​(ObjectTagDefinition objectTagDefinition)
        Create a new ObjectTag for this PartitionableObject based on given ObjectTagDefinition.
        Parameters:
        objectTagDefinition - The ObjectTagDefinition the ObjectTag is based on.
        Returns:
        Return the newly created ObjectTag

      • getObjectTags

        RWIterable<ObjectTag> getObjectTags()
        Returns an RWIterable with the ObjectTags for this object.
        Specified by:
        getObjectTags in interface QueryFilterComp
        Returns:
        RWIterable with ObjectTag instances when present, an empty RWIterable otherwise.

      • getObjectTagByObjectTagDefinition

        ObjectTag getObjectTagByObjectTagDefinition​(ObjectTagDefinition objectTagDefinition)
        Get the ObjectTag for given ObjectTagDefinition that is associated with this QueryFilter. Will return the ObjectTag when present, null otherwise.
        Parameters:
        objectTagDefinition - The ObjectTagDefinition.
        Returns:
        The ObjectTag associated to the QueryFilter if found, null otherwise.

      • getParentApplication

        Application getParentApplication()
        Get the ParentApplication.
        Returns:
        ParentApplication
        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.

      • getObjectDefinition

        ObjectDefinition getObjectDefinition()
        Get the ObjectDefinition.
        Returns:
        ObjectDefinition
        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.

      • getOwnerSubject

        Subject getOwnerSubject()
        Get the OwnerSubject.
        Specified by:
        getOwnerSubject in interface HasOwner
        Returns:
        OwnerSubject
        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.

      • setParentApplication

        void setParentApplication​(Application newParentApplication)
        Set the value for ParentApplication. This value is optional.
        Parameters:
        newParentApplication - is the object to set ParentApplication to. An application can be used group QueryFilter objects.

      • 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.

      • setOwnerSubject

        void setOwnerSubject​(Subject newOwnerSubject)
        Set the value for OwnerSubject. This value is optional.
        Parameters:
        newOwnerSubject - is the object to set OwnerSubject to. Who Created this Filter

      • getQueryConditionValueByQueryConditionInclude

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

      • checkCreatePrivilege

        RequiredPermission checkCreatePrivilege()
        Check whether or not the create action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkViewPrivilege

        RequiredPermission checkViewPrivilege()
        Check whether or not the view action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkEditPrivilege

        RequiredPermission checkEditPrivilege()
        Check whether or not the edit action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkDeletePrivilege

        RequiredPermission checkDeletePrivilege()
        Check whether or not the delete action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.