Interface JobFileSearch

    • Method Detail

      • getProcessingOrder

        Long getProcessingOrder()
        Get the value for ProcessingOrder. (The order in which the searches should be processed) 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.
      • isStop

        boolean isStop()
        Get the value for Stop. (Stop and do not process anymore searches if the search succeeds)
        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.
      • isJobNote

        boolean isJobNote()
        Get the value for JobNote. (Add a job note if a match is found)
        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.
      • getFilename

        String getFilename()
        Get the value for Filename. (The name of the file to search ) 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.
      • getSearchPattern

        String getSearchPattern()
        Get the value for SearchPattern. (The pattern to match (? and * are glob wildcards if WildCard is set)) 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.
      • getBeginLine

        Long getBeginLine()
        Get the value for BeginLine. (See the JobFile search Operation beginLine 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.
      • getEndLine

        Long getEndLine()
        Get the value for EndLine. (See the JobFile.search Operation endLine 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.
      • isEntireLine

        boolean isEntireLine()
        Get the value for EntireLine. (See enumeration SearchFile.EntireLine for the meaning of this option)
        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.
      • isWildCard

        boolean isWildCard()
        Get the value for WildCard. (See enumeration SearchFile.WildCard for the meaning of this option)
        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.
      • isIgnoreCase

        boolean isIgnoreCase()
        Get the value for IgnoreCase. (See enumeration SearchFile.IgnoreCase for the meaning of this option)
        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.
      • isReverse

        boolean isReverse()
        Get the value for Reverse. (See enumeration SearchFile.Reverse for the meaning of this option)
        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.
      • getNewJobStatus

        JobStatus getNewJobStatus()
        Get the value for NewJobStatus. (The Job Status to set on the job if the search term is found. Empty means do not change)
        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.
      • getReturnCode

        Long getReturnCode()
        Get the value for ReturnCode. (Set job return code: number (empty for do not change) )
        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.
      • getOutParamExpr

        String getOutParamExpr()
        Get the value for OutParamExpr. (REL expression to set the out parameter value to)
        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.
      • setProcessingOrder

        void setProcessingOrder​(Long newProcessingOrder)
        Set the value for ProcessingOrder. (The order in which the searches should be processed) This value is mandatory.
        Parameters:
        newProcessingOrder - the new value for ProcessingOrder. 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.
      • setStop

        void setStop​(boolean newStop)
        Set the value for Stop. (Stop and do not process anymore searches if the search succeeds)
        Parameters:
        newStop - the new value for Stop.
        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.
      • setJobNote

        void setJobNote​(boolean newJobNote)
        Set the value for JobNote. (Add a job note if a match is found)
        Parameters:
        newJobNote - the new value for JobNote.
        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.
      • setFilename

        void setFilename​(String newFilename)
        Set the value for Filename. (The name of the file to search ) This value is mandatory.
        Parameters:
        newFilename - the new value for Filename. 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.
      • setSearchPattern

        void setSearchPattern​(String newSearchPattern)
        Set the value for SearchPattern. (The pattern to match (? and * are glob wildcards if WildCard is set)) This value is mandatory.
        Parameters:
        newSearchPattern - the new value for SearchPattern. 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.
      • setBeginLine

        void setBeginLine​(Long newBeginLine)
        Set the value for BeginLine. (See the JobFile search Operation beginLine parameter) This value is optional.
        Parameters:
        newBeginLine - the new value for BeginLine.
        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.
      • setEndLine

        void setEndLine​(Long newEndLine)
        Set the value for EndLine. (See the JobFile.search Operation endLine parameter) This value is optional.
        Parameters:
        newEndLine - the new value for EndLine.
        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.
      • setEntireLine

        void setEntireLine​(boolean newEntireLine)
        Set the value for EntireLine. (See enumeration SearchFile.EntireLine for the meaning of this option)
        Parameters:
        newEntireLine - the new value for EntireLine.
        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.
      • setWildCard

        void setWildCard​(boolean newWildCard)
        Set the value for WildCard. (See enumeration SearchFile.WildCard for the meaning of this option)
        Parameters:
        newWildCard - the new value for WildCard.
        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.
      • setIgnoreCase

        void setIgnoreCase​(boolean newIgnoreCase)
        Set the value for IgnoreCase. (See enumeration SearchFile.IgnoreCase for the meaning of this option)
        Parameters:
        newIgnoreCase - the new value for IgnoreCase.
        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.
      • setReverse

        void setReverse​(boolean newReverse)
        Set the value for Reverse. (See enumeration SearchFile.Reverse for the meaning of this option)
        Parameters:
        newReverse - the new value for Reverse.
        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.
      • setNewJobStatus

        void setNewJobStatus​(JobStatus newNewJobStatus)
        Set the value for NewJobStatus. (The Job Status to set on the job if the search term is found. Empty means do not change) This value is optional.
        Parameters:
        newNewJobStatus - the new value for NewJobStatus.
        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.
      • setReturnCode

        void setReturnCode​(Long newReturnCode)
        Set the value for ReturnCode. (Set job return code: number (empty for do not change) ) This value is optional.
        Parameters:
        newReturnCode - the new value for ReturnCode.
        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.
      • setOutParamExpr

        void setOutParamExpr​(String newOutParamExpr)
        Set the value for OutParamExpr. (REL expression to set the out parameter value to) This value is optional.
        Parameters:
        newOutParamExpr - the new value for OutParamExpr.
        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.
      • getJobDefinition

        JobDefinition getJobDefinition()
        Get the JobDefinition.
        Returns:
        JobDefinition
        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.
      • getOutputJobDefinitionParameter

        JobDefinitionParameter getOutputJobDefinitionParameter()
        Get the OutputJobDefinitionParameter.
        Returns:
        OutputJobDefinitionParameter
        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.
      • setOutputJobDefinitionParameter

        void setOutputJobDefinitionParameter​(JobDefinitionParameter newOutputJobDefinitionParameter)
        Set the value for OutputJobDefinitionParameter. This value is optional.
        Parameters:
        newOutputJobDefinitionParameter - is the object to set OutputJobDefinitionParameter to. The JobDefinitionParameter to set the output value on after the JobFileSearch.OutParamExpr has been evaluated