Package com.redwood.scheduler.api.model

Interface JobParameter

  • All Superinterfaces:
    Association, Readable, SchedulerEntity, SchedulerEntityComp
    public interface JobParameter
extends Association, Readable
    Parameter for a job. Input and output parameters are used to pass data to and from a job. Note that when the value of an INOUT parameter is set, the out-value is also set to the same value. The value of an IN or INOUT parameter can be changed at any stage up until its job enters the Executing state.

    • Method Detail

      • getInValueDate

        DateTimeZone getInValueDate()
        Get the value for InValueDate. (The date value)
        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.

      • getInValueNumber

        BigDecimal getInValueNumber()
        Get the value for InValueNumber. (The numeric value)
        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.

      • getInValueString

        String getInValueString()
        Get the value for InValueString. (The character value)
        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.

      • getInValue

        Object getInValue()
        Get the value for InValue. ( Effective value of this parameter; the type of the object corresponds to the type in the parameter definition. )
        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.

      • getOutValueDate

        DateTimeZone getOutValueDate()
        Get the value for OutValueDate. (The date output value)
        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.

      • getOutValueNumber

        BigDecimal getOutValueNumber()
        Get the value for OutValueNumber. (The numeric output value)
        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.

      • getOutValueString

        String getOutValueString()
        Get the value for OutValueString. (The character output value)
        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.

      • getOutValue

        Object getOutValue()
        Get the value for OutValue. ( Effective out-value of this parameter; the type of the object corresponds to the type in the parameter definition. )
        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.

      • getCurrentValueDate

        DateTimeZone getCurrentValueDate()
        Get the value for CurrentValueDate. (The OutValueDate if it is set, otherwise the InValueDate)
        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.

      • getCurrentValueNumber

        BigDecimal getCurrentValueNumber()
        Get the value for CurrentValueNumber. (The OutValueNumber if it is set, otherwise the InValueNumber)
        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.

      • getCurrentValueString

        String getCurrentValueString()
        Get the value for CurrentValueString. (The OutValueString if it is set, otherwise the InValueString)
        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.

      • getCurrentValue

        Object getCurrentValue()
        Get the value for CurrentValue. ( Return the OutValue for Out and InOut parameters, otherwise it returns the InValue )
        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.

      • setInValueDate

        void setInValueDate​(DateTimeZone newInValueDate)
        Set the value for InValueDate. (The date value) This value is optional.
        Parameters:
        newInValueDate - the new value for InValueDate.
        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.

      • setInValueNumber

        void setInValueNumber​(BigDecimal newInValueNumber)
        Set the value for InValueNumber. (The numeric value) This value is optional.
        Parameters:
        newInValueNumber - the new value for InValueNumber.
        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.

      • setInValueString

        void setInValueString​(String newInValueString)
        Set the value for InValueString. (The character value) This value is optional.
        Parameters:
        newInValueString - the new value for InValueString.
        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.

      • setInValue

        void setInValue​(Object newInValue)
        Set the value for InValue. ( Effective value of this parameter; the type of the object corresponds to the type in the parameter definition. ) This value is optional.
        Parameters:
        newInValue - the new value for InValue.
        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.

      • setOutValueDate

        void setOutValueDate​(DateTimeZone newOutValueDate)
        Set the value for OutValueDate. (The date output value) This value is optional.
        Parameters:
        newOutValueDate - the new value for OutValueDate.
        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.

      • setOutValueNumber

        void setOutValueNumber​(BigDecimal newOutValueNumber)
        Set the value for OutValueNumber. (The numeric output value) This value is optional.
        Parameters:
        newOutValueNumber - the new value for OutValueNumber.
        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.

      • setOutValueString

        void setOutValueString​(String newOutValueString)
        Set the value for OutValueString. (The character output value) This value is optional.
        Parameters:
        newOutValueString - the new value for OutValueString.
        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.

      • setOutValue

        void setOutValue​(Object newOutValue)
        Set the value for OutValue. ( Effective out-value of this parameter; the type of the object corresponds to the type in the parameter definition. ) This value is optional.
        Parameters:
        newOutValue - the new value for OutValue.
        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.

      • setValueToDefaultExpression

        void setValueToDefaultExpression​(SchedulerSession session)
                          throws com.redwood.scheduler.api.exception.ParameterDefaultValueUnavailableException
        Set the parameter value to the default expression of the corresponding job definition parameter. This retrieves the default expression from the JobDefinitionParameter and sets it as the value of this parameter. Parameters without default expression are set to null.
        Parameters:
        session - Session to use when evaluating the default expression. Mandatory.
        Throws:
        com.redwood.scheduler.api.exception.ParameterDefaultValueUnavailableException - An error was encountered while evaluating a default parameter value.

      • setInValueByEvaluatingREL

        void setInValueByEvaluatingREL​(SchedulerSession session,
                               String expression)
                        throws com.redwood.scheduler.api.exception.SchedulerAPIException
        Set the parameter value to the evaluation of the passed in REL expression.
        Parameters:
        session - Session to use when evaluating the expression. Mandatory.
        expression - REL expression, must start with '='. Mandatory.
        Throws:
        com.redwood.scheduler.api.exception.SchedulerAPIException - Baseclass for checked exceptions thrown by the API.

      • getInValueNumberArray

        BigDecimal[] getInValueNumberArray()
        Get the parameter IN value of the corresponding job definition parameter as number array.
        Returns:
        The value as number array.

      • setInValueNumberArray

        void setInValueNumberArray​(BigDecimal[] value)
        Set the parameter IN value of the corresponding job definition parameter as Number array.
        Parameters:
        value - The value, cannot be null.

      • getInValueStringArray

        String[] getInValueStringArray()
        Get the parameter IN value of the corresponding job definition parameter as String array.
        Returns:
        The value as String array.

      • setInValueStringArray

        void setInValueStringArray​(String[] value)
        Set the parameter IN value of the corresponding job definition parameter as String array.
        Parameters:
        value - The value, cannot be null.

      • getInValueDateTimeZoneArray

        DateTimeZone[] getInValueDateTimeZoneArray()
        Get the parameter IN value of the corresponding job definition parameter as DateTimeZone array.
        Returns:
        The value as number array.

      • setInValueDateTimeZoneArray

        void setInValueDateTimeZoneArray​(DateTimeZone[] value)
        Set the parameter IN value of the corresponding job definition parameter as DateTimeZone array.
        Parameters:
        value - The value, cannot be null.

      • getOutValueNumberArray

        BigDecimal[] getOutValueNumberArray()
        Get the parameter OUT value of the corresponding job definition parameter as number array.
        Returns:
        The value as number array.

      • setOutValueNumberArray

        void setOutValueNumberArray​(BigDecimal[] value)
        Set the parameter OUT value of the corresponding job definition parameter as Number array.
        Parameters:
        value - The value, cannot be null.

      • getOutValueStringArray

        String[] getOutValueStringArray()
        Get the parameter OUT value of the corresponding job definition parameter as String array.
        Returns:
        The value as String array.

      • setOutValueStringArray

        void setOutValueStringArray​(String[] value)
        Set the parameter OUT value of the corresponding job definition parameter as String array.
        Parameters:
        value - The value, cannot be null.

      • getOutValueDateTimeZoneArray

        DateTimeZone[] getOutValueDateTimeZoneArray()
        Get the parameter OUT value of the corresponding job definition parameter as DateTimeZone array.
        Returns:
        The value as number array.

      • setOutValueDateTimeZoneArray

        void setOutValueDateTimeZoneArray​(DateTimeZone[] value)
        Set the parameter OUT value of the corresponding job definition parameter as DateTimeZone array.
        Parameters:
        value - The value, cannot be null.

      • setInValueTableParameter

        void setInValueTableParameter​(Table table)
        This will set the type of the TableParameter to Table, and set the business key correctly to reference table.
        Parameters:
        table - The table parameter to use as the source for the RTXReader

      • setInValueTableParameter

        void setInValueTableParameter​(JobFile jobFile)
        This will set the type of the TableParameter to File, and set the business key correctly to reference jobFile.
        Parameters:
        jobFile - The table parameter to use as the source for the RTXReader

      • setOutValueTableParameter

        void setOutValueTableParameter​(Table table)
        This will set the type of the TableParameter to Table, and set the business key correctly to reference table.
        Parameters:
        table - The table parameter to use as the source for the RTXReader

      • setOutValueTableParameter

        void setOutValueTableParameter​(JobFile jobFile)
        This will set the type of the TableParameter to Table, and set the business key correctly to reference jobFile.
        Parameters:
        jobFile - The table parameter to use as the source for the RTXReader

      • getInValueTableParameter

        TableParameter getInValueTableParameter()
        Get an instantiated TableParameter value.
        Returns:
        An instantiated TableParameter value according to the specification set on the parameter

      • getOutValueTableParameter

        TableParameter getOutValueTableParameter()
        Get an instantiated TableParameter value.
        Returns:
        An instantiated TableParameter value according to the specification set on the parameter

      • setInValueFileParameter

        void setInValueFileParameter​(Document document)
        This will set the type of the FileParameter to Document, and set the business key correctly to reference document.
        Parameters:
        document - The document parameter to use as the source

      • setInValueFileParameter

        void setInValueFileParameter​(JobFile jobFile)
        This will set a JobFile in a new instance of the interface FileParameter.
        Parameters:
        jobFile - The JobFile to be set in the FileParameter.

      • setInValueFileParameter

        void setInValueFileParameter​(String fullParameterValue)
        Set the In value of the parameter in full form
        Parameters:
        fullParameterValue - in the format <type>:<source>, where depending on the type of the FileParameter, the source can be a reference to:

      • setOutValueFileParameter

        void setOutValueFileParameter​(Document document)
        This will set the type of the FileParameter to Document, and set the business key correctly to reference document.
        Parameters:
        document - The document parameter to use as the source

      • setOutValueFileParameter

        void setOutValueFileParameter​(JobFile jobFile)
        This will set a JobFile in a new instance of the interface FileParameter.
        Parameters:
        jobFile - The JobFile to be set in the FileParameter.

      • setOutValueFileParameter

        void setOutValueFileParameter​(String fullParameterValue)
        Set the Out value of the parameter in full form
        Parameters:
        fullParameterValue - in the format <type>:<source>, where depending on the type of the FileParameter, the source can be a reference to:

      • getInValueFileParameter

        FileParameter getInValueFileParameter()
        Gets the value of a FileParameter.
        Returns:
        Returns the value of a JobParameter type File as a FileParameter object if, and only if, the fileParameter object has a JobFile attached to it, otherwise is returned null.

      • getOutValueFileParameter

        FileParameter getOutValueFileParameter()
        Gets the value of a FileParameter.
        Returns:
        Returns the value of a JobParameter type File as a FileParameter object if, and only if, the fileParameter object has a JobFile attached to it, otherwise is returned null.

      • getJobDefinitionParameter

        JobDefinitionParameter getJobDefinitionParameter()
        Get the JobDefinitionParameter.
        Returns:
        JobDefinitionParameter
        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.

      • getJob

        Job getJob()
        Get the Job.
        Returns:
        Job
        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.