Interface SAPOutputDevice

    • Method Detail

      • getDeviceType

        String getDeviceType()
        Get the value for DeviceType. (Device type name)
        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.
      • getStatusMessage

        String getStatusMessage()
        Get the value for StatusMessage. (Status message (or copy of location))
        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.
      • getAccessMethod

        String getAccessMethod()
        Get the value for AccessMethod. (Host spool system access method)
        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.
      • getHostPrinter

        String getHostPrinter()
        Get the value for HostPrinter. (Long name of printers for host spooler)
        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.
      • isLocked

        boolean isLocked()
        Get the value for Locked. (Output device not released)
        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.
      • setDeviceType

        void setDeviceType​(String newDeviceType)
        Set the value for DeviceType. (Device type name) This value is optional.
        Parameters:
        newDeviceType - the new value for DeviceType.
        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.
      • setStatusMessage

        void setStatusMessage​(String newStatusMessage)
        Set the value for StatusMessage. (Status message (or copy of location)) This value is optional.
        Parameters:
        newStatusMessage - the new value for StatusMessage.
        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.
      • setAccessMethod

        void setAccessMethod​(String newAccessMethod)
        Set the value for AccessMethod. (Host spool system access method) This value is optional.
        Parameters:
        newAccessMethod - the new value for AccessMethod.
        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.
      • setHostPrinter

        void setHostPrinter​(String newHostPrinter)
        Set the value for HostPrinter. (Long name of printers for host spooler) This value is optional.
        Parameters:
        newHostPrinter - the new value for HostPrinter.
        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.
      • setLocked

        void setLocked​(boolean newLocked)
        Set the value for Locked. (Output device not released)
        Parameters:
        newLocked - the new value for Locked.
        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.
      • getSAPSystem

        SAPSystem getSAPSystem()
        Get the SAPSystem.
        Returns:
        SAPSystem
        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.
      • getSAPOutputFormatByName

        SAPOutputFormat getSAPOutputFormatByName​(String name)
        Get the SAPOutputFormat by NameSAPOutputDevice.
        Parameters:
        name -
        Returns:
        the SAPOutputFormat, or null if it could not be found