com.ibm.as400.access
Class OutputQueueList

java.lang.Object
  com.ibm.as400.access.PrintObjectList
      com.ibm.as400.access.OutputQueueList

All Implemented Interfaces:

Serializable

public class OutputQueueList

extends PrintObjectList

implements Serializable

The OutputQueueList class is used to build a list of server objects of type OutputQueue. The list can be filtered by library and queue name.

See Also:

OutputQueue, Serialized Form

Constructor Summary

OutputQueueList()
Constructs an OutputQueueList object.

OutputQueueList(AS400 system)
Constructs an OutputQueueList object.

Method Summary

String	getQueueFilter() Returns the output queue list filter.
void	setQueueFilter(String queueFilter) Sets the output queue list filter.

Methods inherited from class com.ibm.as400.access.PrintObjectList

addPrintObjectListListener, addPropertyChangeListener, addVetoableChangeListener, close, getObject, getObjects, getSystem, isCompleted, openAsynchronously, openSynchronously, removePrintObjectListListener, removePropertyChangeListener, removeVetoableChangeListener, resetAttributesToRetrieve, resetFilter, setAttributesToRetrieve, setCache, setSystem, size, waitForItem, waitForListToComplete

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OutputQueueList

public OutputQueueList()

Constructs an OutputQueueList object. The system 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:

PrintObjectList.setSystem(com.ibm.as400.access.AS400)

OutputQueueList

public OutputQueueList(AS400 system)

Constructs an OutputQueueList object. It uses the specified system name.

Parameters:

system - The server on which the output queues exists.

Method Detail

getQueueFilter

public String getQueueFilter()

Returns the output queue list filter.

Returns:

The output queue list filter.

setQueueFilter

public void setQueueFilter(String queueFilter)
                    throws PropertyVetoException

Sets the output queue list filter.

Parameters:

queueFilter - The library and output queues to list. The format of the queueFilter string must be in the format of /QSYS.LIB/libname.LIB/queuename.OUTQ, where
libname is the library name that contains the queues to search. It can be a specific name, a generic name, or one of these special values:

• %ALL% - All libraries are searched.
• %ALLUSR% - All user-defined libraries, plus libraries containing user data and having names starting with the letter Q.
• %CURLIB% - The server job's current library.
• %LIBL% - The server job's library list.
• %USRLIBL% - The user portion of the server job's library list.

queuename is the name of the output queues to list. It can be a specific name, a generic name, or the special value %ALL%. The default for the library is %LIBL% and for the queue name is %ALL%.

Throws:

PropertyVetoException - If the change is vetoed.