Interface Script

    • Method Detail

      • getRunAsUser

        String getRunAsUser()
        Get the value for RunAsUser. (A RedwoodExpression that specifies which user to run the script as.)
        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.
      • getRemoteRunAsUser

        String getRemoteRunAsUser()
        Get the value for RemoteRunAsUser. (A RedwoodExpression that specifies which remote user to run the script as, for job definition types that have a remote user.)
        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.
      • setRunAsUser

        void setRunAsUser​(String newRunAsUser)
        Set the value for RunAsUser. (A RedwoodExpression that specifies which user to run the script as.) This value is optional.
        Parameters:
        newRunAsUser - the new value for RunAsUser.
        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.
      • setRemoteRunAsUser

        void setRemoteRunAsUser​(String newRemoteRunAsUser)
        Set the value for RemoteRunAsUser. (A RedwoodExpression that specifies which remote user to run the script as, for job definition types that have a remote user.) This value is optional.
        Parameters:
        newRemoteRunAsUser - the new value for RemoteRunAsUser.
        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.
      • 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.
      • setLibrary

        void setLibrary​(Library newLibrary)
        Set the value for Library. This value is mandatory.
        Parameters:
        newLibrary - is the object to set Library to. The library that the script depends upon. If this is null, then the object cannot be persisted.