Package com.ibm.as400.access

Class PrinterFileList

java.lang.Object

com.ibm.as400.access.PrintObjectList<PrinterFile>

com.ibm.as400.access.PrinterFileList

All Implemented Interfaces:

Serializable

public class PrinterFileList
extends PrintObjectList<PrinterFile>
implements Serializable

The PrinterFileList class is used to build a list of objects of type PrinterFile. The list can be filtered by library and printer file name.

See Also:

PrinterFile, Serialized Form

Constructor Summary

Constructors

Constructor	Description
PrinterFileList()	Constructs a PrinterFileList object.
PrinterFileList(AS400 system)	Constructs a PrinterFileList object.

Method Summary

Modifier and Type	Method	Description
String	getPrinterFileFilter()	Returns the printer file list filter.
void	setPrinterFileFilter(String printerFileFilter)	Sets the printer file list filter.

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

addPrintObjectListListener, addPropertyChangeListener, addVetoableChangeListener, close, getObject, getObjects, getObjectsList, 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

PrinterFileList

public PrinterFileList()

Constructs a PrinterFileList 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)

PrinterFileList

public PrinterFileList(AS400 system)

Constructs a PrinterFileList object. It uses the system name specified.

Parameters:

system - The system on which the printer files exists.

Method Detail

getPrinterFileFilter

public String getPrinterFileFilter()

Returns the printer file list filter.

Returns:

The printer file list filter.

setPrinterFileFilter

public void setPrinterFileFilter(String printerFileFilter)
                          throws PropertyVetoException

Sets the printer file list filter.

Parameters:

printerFileFilter - The library and printer files to list. The format of the printerFileFilter string must be in the format of /QSYS.LIB/libname.LIB/printerfilename.FILE, where
libname is the library name that contains the printer files to search. It can be a specific 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.

printerfilename is the name of the printer files 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 printer file name is %ALL%.

Throws:

PropertyVetoException - If the change is vetoed.