com.ibm.as400.access

Class OutputQueue

  • All Implemented Interfaces:
    java.io.Serializable


    public class OutputQueue
    extends PrintObject
    implements java.io.Serializable
    The OutputQueue class represents an output queue. An instance of this class can be used to manipulate an individual output queue (hold, release, clear, and so on). See Output Queue Attributes for valid attributes.
    See Also:
    Serialized Form
    • Constructor Detail

      • OutputQueue

        public OutputQueue()
        Constructs an OutputQueue object. The system and the integrated file system name of the output queue must be set later. This constructor is provided for visual application builders that support JavaBeans. It is not intended for use by application programmers.
        See Also:
        PrintObject.setSystem(com.ibm.as400.access.AS400), setPath(java.lang.String)
      • OutputQueue

        public OutputQueue(AS400 system,
                   java.lang.String queueName)
        Constructs an OutputQueue object. It uses the specified system and output queue name that identifies it on that system.
        Parameters:
        system - The system on which this output queue exists.
        queueName - The integrated file system name of the output queue. The format of the queue string must be in the format of /QSYS.LIB/libname.LIB/queuename.OUTQ.
    >
    • Method Detail

      • clear

        public void clear(PrintParameterList clearOptions)
                   throws AS400Exception,
                          AS400SecurityException,
                          ErrorCompletingRequestException,
                          java.io.IOException,
                          java.lang.InterruptedException,
                          RequestNotSupportedException
        Clears the output queue on the system.
        Parameters:
        clearOptions - A PrintParameterList object that may have any of the following attributes set:
        • ATTR_JOBUSER - Clear output queue by a user id. May be a specific userid, "*ALL" or "*CURRENT". "*CURRENT" is the default.
        • ATTR_FORMTYPE - Clear output queue by a form type. May be a specific form type, "*ALL" or "*STD". "*ALL" is the default.
        • ATTR_USERDATA - Clear output queue by user data. May be a specific user data or "*ALL". "*ALL" is the default.
        clearOptions may be null.
        Throws:
        AS400Exception - If the system returns an error message.
        AS400SecurityException - If a security or authority error occurs.
        ErrorCompletingRequestException - If an error occurs before the request is completed.
        java.io.IOException - If an error occurs while communicating with the system.
        java.lang.InterruptedException - If this thread is interrupted.
        RequestNotSupportedException - If the requested function is not supported because the system operating system is not at the correct level.
      • getName

        public java.lang.String getName()
        Returns the name of the output queue.
        Returns:
        The name of the output queue.
      • getPath

        public java.lang.String getPath()
        Returns the integrated file system pathname of the output queue.
        Returns:
        The integrated file system pathname of the output queue.
      • setPath

        public void setPath(java.lang.String path)
                     throws java.beans.PropertyVetoException
        Sets the integrated file system pathname of the output queue.
        Parameters:
        path - The integrated file system pathname of the output queue. The format of the queue string must be in the format of /QSYS.LIB/libname.LIB/queuename.OUTQ.
        Throws:
        java.beans.PropertyVetoException - If the change is vetoed.