Package com.redwood.scheduler.api.model

Interface ObjectSearchCondition

    • Method Detail

      • getType

        ObjectSearchConditionType getType()
        Get the value for Type. (The type of 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:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getLabel

        String getLabel()
        Get the value for Label. (The character label for the condition (e.g. A, B, C)) 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.

      • getOperator

        ObjectSearchOperatorType getOperator()
        Get the value for Operator. (The operator for 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:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getSearchFor

        String getSearchFor()
        Get the value for SearchFor. (The string to search for)
        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.

      • isNameSearch

        boolean isNameSearch()
        Get the value for NameSearch. (Search documentation for Names that match)
        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.

      • isCommentSearch

        boolean isCommentSearch()
        Get the value for CommentSearch. (Search documentation for Comments that match)
        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.

      • isDescSearch

        boolean isDescSearch()
        Get the value for DescSearch. (Search documentation for Descriptions that match)
        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.

      • getParameterName

        String getParameterName()
        Get the value for ParameterName. (The name of to parameter to search for)
        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.

      • getParameterValue

        String getParameterValue()
        Get the value for ParameterValue. (The value of to parameter)
        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.

      • isJobSearch

        boolean isJobSearch()
        Get the value for JobSearch. (Search job parameters for matches)
        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.

      • isJobDefinitionSearch

        boolean isJobDefinitionSearch()
        Get the value for JobDefinitionSearch. (Search job definition parameters for matches)
        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.

      • isJobChainDefinitionSearch

        boolean isJobChainDefinitionSearch()
        Get the value for JobChainDefinitionSearch. (Search job chain definition parameters for matches)
        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.

      • isLibrarySearch

        boolean isLibrarySearch()
        Get the value for LibrarySearch. (Search Library source for matches)
        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.

      • isTriggerSearch

        boolean isTriggerSearch()
        Get the value for TriggerSearch. (Search Trigger source for matches)
        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.

      • isActionSearch

        boolean isActionSearch()
        Get the value for ActionSearch. (Search Action source for matches)
        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.

      • isFileEventSourceSearch

        boolean isFileEventSourceSearch()
        Get the value for FileEventSourceSearch. (Search file event source path for matches)
        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.

      • isExtensionPointSearch

        boolean isExtensionPointSearch()
        Get the value for ExtensionPointSearch. (Search Extension Point source for matches)
        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.

      • isFileEventMoveDirectorySearch

        boolean isFileEventMoveDirectorySearch()
        Get the value for FileEventMoveDirectorySearch. (Search file event move directory path for matches)
        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.

      • getObjectDefinition

        Long getObjectDefinition()
        Get the value for ObjectDefinition. (The ObjectDefinition to search for a specific field)
        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.

      • getObjectFieldDefinition

        Long getObjectFieldDefinition()
        Get the value for ObjectFieldDefinition. (The ObjectFieldDefinition to search for a specific field)
        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.

      • getStartDate

        DateTimeZone getStartDate()
        Get the value for StartDate. (The start date for related searches)
        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.

      • getEndDate

        DateTimeZone getEndDate()
        Get the value for EndDate. (The end date for related searches)
        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.

      • getSearchNumber

        BigDecimal getSearchNumber()
        Get the value for SearchNumber. (The number to search for, for related searches)
        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.

      • isSearchBoolean

        boolean isSearchBoolean()
        Get the value for SearchBoolean. (The boolean value to search for, for related searches)
        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.

      • getRelatedObjectFieldDefinition

        Long getRelatedObjectFieldDefinition()
        Get the value for RelatedObjectFieldDefinition. (The ObjectFieldDefinition for the Object associated with the ObjectFieldDefinition)
        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.

      • getNumberOperator

        NumberComparisonType getNumberOperator()
        Get the value for NumberOperator. (The operator for number based comparison conditions) 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.

      • getDateOperator

        DateComparisonType getDateOperator()
        Get the value for DateOperator. (The operator for date based comparison conditions) 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.

      • getUsername

        String getUsername()
        Get the value for Username. (The name of the user for Last Modified searches)
        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​(ObjectSearchConditionType newType)
        Set the value for Type. (The type of the condition) 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.

      • setLabel

        void setLabel​(String newLabel)
        Set the value for Label. (The character label for the condition (e.g. A, B, C)) This value is mandatory.
        Parameters:
        newLabel - the new value for Label. 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.

      • setOperator

        void setOperator​(ObjectSearchOperatorType newOperator)
        Set the value for Operator. (The operator for the condition) This value is mandatory.
        Parameters:
        newOperator - the new value for Operator. 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.

      • setSearchFor

        void setSearchFor​(String newSearchFor)
        Set the value for SearchFor. (The string to search for) This value is optional.
        Parameters:
        newSearchFor - the new value for SearchFor.
        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.

      • setNameSearch

        void setNameSearch​(boolean newNameSearch)
        Set the value for NameSearch. (Search documentation for Names that match)
        Parameters:
        newNameSearch - the new value for NameSearch.
        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.

      • setCommentSearch

        void setCommentSearch​(boolean newCommentSearch)
        Set the value for CommentSearch. (Search documentation for Comments that match)
        Parameters:
        newCommentSearch - the new value for CommentSearch.
        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.

      • setDescSearch

        void setDescSearch​(boolean newDescSearch)
        Set the value for DescSearch. (Search documentation for Descriptions that match)
        Parameters:
        newDescSearch - the new value for DescSearch.
        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.

      • setParameterName

        void setParameterName​(String newParameterName)
        Set the value for ParameterName. (The name of to parameter to search for) This value is optional.
        Parameters:
        newParameterName - the new value for ParameterName.
        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.

      • setParameterValue

        void setParameterValue​(String newParameterValue)
        Set the value for ParameterValue. (The value of to parameter) This value is optional.
        Parameters:
        newParameterValue - the new value for ParameterValue.
        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.

      • setJobSearch

        void setJobSearch​(boolean newJobSearch)
        Set the value for JobSearch. (Search job parameters for matches)
        Parameters:
        newJobSearch - the new value for JobSearch.
        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.

      • setJobDefinitionSearch

        void setJobDefinitionSearch​(boolean newJobDefinitionSearch)
        Set the value for JobDefinitionSearch. (Search job definition parameters for matches)
        Parameters:
        newJobDefinitionSearch - the new value for JobDefinitionSearch.
        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.

      • setJobChainDefinitionSearch

        void setJobChainDefinitionSearch​(boolean newJobChainDefinitionSearch)
        Set the value for JobChainDefinitionSearch. (Search job chain definition parameters for matches)
        Parameters:
        newJobChainDefinitionSearch - the new value for JobChainDefinitionSearch.
        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.

      • setLibrarySearch

        void setLibrarySearch​(boolean newLibrarySearch)
        Set the value for LibrarySearch. (Search Library source for matches)
        Parameters:
        newLibrarySearch - the new value for LibrarySearch.
        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.

      • setTriggerSearch

        void setTriggerSearch​(boolean newTriggerSearch)
        Set the value for TriggerSearch. (Search Trigger source for matches)
        Parameters:
        newTriggerSearch - the new value for TriggerSearch.
        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.

      • setActionSearch

        void setActionSearch​(boolean newActionSearch)
        Set the value for ActionSearch. (Search Action source for matches)
        Parameters:
        newActionSearch - the new value for ActionSearch.
        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.

      • setFileEventSourceSearch

        void setFileEventSourceSearch​(boolean newFileEventSourceSearch)
        Set the value for FileEventSourceSearch. (Search file event source path for matches)
        Parameters:
        newFileEventSourceSearch - the new value for FileEventSourceSearch.
        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.

      • setExtensionPointSearch

        void setExtensionPointSearch​(boolean newExtensionPointSearch)
        Set the value for ExtensionPointSearch. (Search Extension Point source for matches)
        Parameters:
        newExtensionPointSearch - the new value for ExtensionPointSearch.
        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.

      • setFileEventMoveDirectorySearch

        void setFileEventMoveDirectorySearch​(boolean newFileEventMoveDirectorySearch)
        Set the value for FileEventMoveDirectorySearch. (Search file event move directory path for matches)
        Parameters:
        newFileEventMoveDirectorySearch - the new value for FileEventMoveDirectorySearch.
        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.

      • setObjectDefinition

        void setObjectDefinition​(Long newObjectDefinition)
        Set the value for ObjectDefinition. (The ObjectDefinition to search for a specific field) This value is optional.
        Parameters:
        newObjectDefinition - the new value for ObjectDefinition.
        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.

      • setObjectFieldDefinition

        void setObjectFieldDefinition​(Long newObjectFieldDefinition)
        Set the value for ObjectFieldDefinition. (The ObjectFieldDefinition to search for a specific field) This value is optional.
        Parameters:
        newObjectFieldDefinition - the new value for ObjectFieldDefinition.
        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.

      • setStartDate

        void setStartDate​(DateTimeZone newStartDate)
        Set the value for StartDate. (The start date for related searches) This value is optional.
        Parameters:
        newStartDate - the new value for StartDate.
        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.

      • setEndDate

        void setEndDate​(DateTimeZone newEndDate)
        Set the value for EndDate. (The end date for related searches) This value is optional.
        Parameters:
        newEndDate - the new value for EndDate.
        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.

      • setSearchNumber

        void setSearchNumber​(BigDecimal newSearchNumber)
        Set the value for SearchNumber. (The number to search for, for related searches) This value is optional.
        Parameters:
        newSearchNumber - the new value for SearchNumber.
        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.

      • setSearchBoolean

        void setSearchBoolean​(boolean newSearchBoolean)
        Set the value for SearchBoolean. (The boolean value to search for, for related searches)
        Parameters:
        newSearchBoolean - the new value for SearchBoolean.
        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.

      • setRelatedObjectFieldDefinition

        void setRelatedObjectFieldDefinition​(Long newRelatedObjectFieldDefinition)
        Set the value for RelatedObjectFieldDefinition. (The ObjectFieldDefinition for the Object associated with the ObjectFieldDefinition) This value is optional.
        Parameters:
        newRelatedObjectFieldDefinition - the new value for RelatedObjectFieldDefinition.
        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.

      • setNumberOperator

        void setNumberOperator​(NumberComparisonType newNumberOperator)
        Set the value for NumberOperator. (The operator for number based comparison conditions) This value is mandatory.
        Parameters:
        newNumberOperator - the new value for NumberOperator. 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.

      • setDateOperator

        void setDateOperator​(DateComparisonType newDateOperator)
        Set the value for DateOperator. (The operator for date based comparison conditions) This value is mandatory.
        Parameters:
        newDateOperator - the new value for DateOperator. 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.

      • setUsername

        void setUsername​(String newUsername)
        Set the value for Username. (The name of the user for Last Modified searches) This value is optional.
        Parameters:
        newUsername - the new value for Username.
        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.

      • getSpecificFieldOperator

        SchedulerEnumeration getSpecificFieldOperator()
        Get the Operator for the specific field type
        Returns:
        The enumeration type of the specific field

      • getSpecificFieldSearchFor

        Object getSpecificFieldSearchFor()
        Get the object value to search for. This is a utility method that invokes the call to the appropriate getSearchFor(), getSearchBoolean(), getSearchNumber() depending on the field type
        Returns:
        The enumeration type of the specific field

      • getObjectSearch

        ObjectSearch getObjectSearch()
        Get the ObjectSearch.
        Returns:
        ObjectSearch
        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.