Package com.ibm.as400.access

Class AFPResourceList

java.lang.Object

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

com.ibm.as400.access.AFPResourceList

All Implemented Interfaces:

Serializable

public class AFPResourceList
extends PrintObjectList<AFPResource>
implements Serializable

The AFPResourceList class is used to build a list of IBM i AFP resource objects of type AFPResource. The list can be filtered by library and resource name, by resource type and by spooled file (list only resources used by a particular spooled file). In addition, font resources may be filtered by pel density. To list and use AFP resources, your system operating system must be at V3R7 or later.

See Also:

AFPResource, Serialized Form

Constructor Summary

Constructors

Constructor	Description
AFPResourceList()	Constructs an AFPResourceList.
AFPResourceList(AS400 system)	Constructs an AFPResourceList.

Method Summary

Modifier and Type	Method	Description
String	getResourceFilter()	Returns the library, name, and resource type being used as a resource list filter.
SpooledFile	getSpooledFileFilter()	Returns the spooled file object being used as a resource list filter.
void	setResourceFilter(String resourceFilter)	Sets resource list filter by library, name, and resource type.
void	setSpooledFileFilter(SpooledFile spooledFileFilter)	Sets resource list filter by spooled file.

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

AFPResourceList

public AFPResourceList()

Constructs an AFPResourceList. The system must be set later. This constructor is provide 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)

AFPResourceList

public AFPResourceList(AS400 system)

Constructs an AFPResourceList. The default filtering criteria will list all resources in the system library list. Use the various setXxxxFilter methods to override the defaults.

Parameters:

system - The system on which the AFP resources exist.

Method Detail

getResourceFilter

public String getResourceFilter()

Returns the library, name, and resource type being used as a resource list filter.

Returns:

The library, name, and resource type being used as a resource list filter.

getSpooledFileFilter

public SpooledFile getSpooledFileFilter()

Returns the spooled file object being used as a resource list filter.

Returns:

The spooled file object being used as a resource list filter.

setResourceFilter

public void setResourceFilter(String resourceFilter)
                       throws PropertyVetoException

Sets resource list filter by library, name, and resource type.

Parameters:

resourceFilter - The resources to list. The format of the resourceFilter string must be in the format of "/QSYS.LIB/libname.LIB/resource.type", where
libname is the library name that contains the resources to search. Resources listed will be restricted to those found in these libraries. The library name 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.

resource is the name of the resource(s) to list. It can be a specific name, a generic name, or the special value %ALL%.
type is the type of resource to list. It can be any of these special values:

• %ALL% - All resources are listed.
• FNTRSC - Only font resources are listed.
• FORMDF - Only form definitions are listed.
• OVL - Only overlays are listed.
• PAGEDFN - Only page definitions are listed.
• PAGESEG - Only page segments are listed.

The default for the library is %LIBL%; for resource, it is %ALL%; and for type, it is %ALL%.

Throws:

PropertyVetoException - If the change is vetoed.

setSpooledFileFilter

public void setSpooledFileFilter(SpooledFile spooledFileFilter)
                          throws PropertyVetoException

Sets resource list filter by spooled file. Only resources used by the spooled file are listed.

Parameters:

spooledFileFilter - The spooled file for which the resources will be listed.

Throws:

PropertyVetoException - If the change is vetoed.