Package com.redwood.scheduler.api.model

Interface JobDefinitionType

    • Method Detail

      • getArrayParameterSupport

        ArrayParameterSupport getArrayParameterSupport()
        Get the value for ArrayParameterSupport. (Indicates the support of array parameters for this JDT.) 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.

      • getSupportedCompletionStrategyCodes

        String getSupportedCompletionStrategyCodes()
        Get the value for SupportedCompletionStrategyCodes. ( String of codes for the CompletionStrategyTypes that are supported by this JobDefinitionType. (other than Default which is always supported) Internal, use getSupportedCompletionStrategies() to get an set of proper enum values for this. )
        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.

      • getValidity

        Validity getValidity()
        Get the value for Validity. (Is this definition valid? That is, can this definition currently be used?) 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.

      • setArrayParameterSupport

        void setArrayParameterSupport​(ArrayParameterSupport newArrayParameterSupport)
        Set the value for ArrayParameterSupport. (Indicates the support of array parameters for this JDT.) This value is mandatory.
        Parameters:
        newArrayParameterSupport - the new value for ArrayParameterSupport. 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.

      • setSupportedCompletionStrategyCodes

        void setSupportedCompletionStrategyCodes​(String newSupportedCompletionStrategyCodes)
        Set the value for SupportedCompletionStrategyCodes. ( String of codes for the CompletionStrategyTypes that are supported by this JobDefinitionType. (other than Default which is always supported) Internal, use getSupportedCompletionStrategies() to get an set of proper enum values for this. ) This value is optional.
        Parameters:
        newSupportedCompletionStrategyCodes - the new value for SupportedCompletionStrategyCodes.
        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.

      • isCompletionStrategySupported

        @Deprecated
boolean isCompletionStrategySupported()
        Deprecated.
        This operation is deprecated, use isCompletionStrategySupported(CompletionStrategyType) instead.

        Deprecated, use getSupportedCompletionStrategies() instead. Indicates whether this JobDefinitionType supports a completion strategy other than Default.

        Returns:
        Returns true if this JobDefinitionType supports a completion strategy other than Default, false otherwise.

      • checkLicense

        void checkLicense()
           throws com.redwood.scheduler.api.exception.LicenseException
        Check to see if the job definition type is licensed, and can be used to create job definitions or run jobs of this job definition type.
        Throws:
        com.redwood.scheduler.api.exception.LicenseException - License violation.

      • canCreateJobDefinitionOfType

        boolean canCreateJobDefinitionOfType()
        Check to see if a user can create a JobDefinition for this type (includes checking RMJ privileges).
        Returns:
        Returns true if the user can create this JobDefinition for this type, false otherwise.

      • isCustom

        boolean isCustom()
        Returns true if this JobDefinitionType represents a custom type. Custom types start with Redwood_ or Robo_ and are application signed 'locked'.
        Returns:
        Returns true if this JobDefinitionType represents a custom type. Custom types start with Redwood_ or Robo_ and are application signed 'locked'.

      • getLibrary

        Library getLibrary()
        Get the Library.
        Returns:
        Library
        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.

      • getHandlerService

        Service getHandlerService()
        Get the HandlerService.
        Returns:
        HandlerService
        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.

      • setLibrary

        void setLibrary​(Library newLibrary)
        Set the value for Library. This value is optional.
        Parameters:
        newLibrary - is the object to set Library to. The library associated with this JobDefinitionType.

      • setHandlerService

        void setHandlerService​(Service newHandlerService)
        Set the value for HandlerService. This value is mandatory.
        Parameters:
        newHandlerService - is the object to set HandlerService to. The job definition types provided by this service. If this is null, then the object cannot be persisted.

      • getJobDefinitionTypeActionByType

        JobDefinitionTypeAction getJobDefinitionTypeActionByType​(JobDefinitionTypeActionType type)
        Get the JobDefinitionTypeAction by JobDefinitionTypeActionType.
        Parameters:
        type -
        Returns:
        the JobDefinitionTypeAction, or null if it could not be found

      • getProcessServerJobDefinitionTypeByProcessServer

        ProcessServerJobDefinitionType getProcessServerJobDefinitionTypeByProcessServer​(ProcessServer processServer)
        Get the ProcessServerJobDefinitionType by Association.
        Parameters:
        processServer -
        Returns:
        the ProcessServerJobDefinitionType, or null if it could not be found

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

      • checkCanModifyJobsOfTypePrivilege

        RequiredPermission checkCanModifyJobsOfTypePrivilege()
        Check whether or not the canModifyJobsOfType 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.