All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.as400.access.SpooledFileList
java.lang.Object
|
+----com.ibm.as400.access.PrintObjectList
|
+----com.ibm.as400.access.SpooledFileList
- public class SpooledFileList
- extends PrintObjectList
- implements Serializable
The SpooledFileList class is used to build a list of AS/400 spooled file objects of type
SpooledFile. The list can be filtered by formtype, output queue, user,
or user data.
- See Also:
- SpooledFile
-
SpooledFileList()
- Constructs a SpooledFileList object.
-
SpooledFileList(AS400)
- Constructs a SpooledFileList object.
-
getFormTypeFilter()
- Returns the formtype list filter.
-
getQueueFilter()
- Returns the output queue filter.
-
getUserDataFilter()
- Returns the user data list filter.
-
getUserFilter()
- Returns the user ID list filter.
-
setFormTypeFilter(String)
- Sets the formtype list filter.
-
setQueueFilter(String)
- Sets the output queue filter.
-
setUserDataFilter(String)
- Sets the user data list filter.
-
setUserFilter(String)
- Sets the user ID list filter.
SpooledFileList
public SpooledFileList()
- Constructs a SpooledFileList object. The AS/400 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:
- setSystem
SpooledFileList
public SpooledFileList(AS400 system)
- Constructs a SpooledFileList object. It uses the system
name specified.
The default list filter will list all spooled files for the
current user on the specified system.
- Parameters:
- system - The AS/400 on which the spooled files exist.
getFormTypeFilter
public String getFormTypeFilter()
- Returns the formtype list filter.
getQueueFilter
public String getQueueFilter()
- Returns the output queue filter.
getUserFilter
public String getUserFilter()
- Returns the user ID list filter.
getUserDataFilter
public String getUserDataFilter()
- Returns the user data list filter.
setFormTypeFilter
public void setFormTypeFilter(String formTypeFilter) throws PropertyVetoException
- Sets the formtype list filter.
- Parameters:
- formTypeFilter - The form type the spooled file must to be included
in the list. It cannot be greater than 10 characters.
The value can be any specific value or any of these special values:
- *ALL - Spooled files with any form type will be included in the list.
- *STD - Spooled files with the form type *STD will be included in the list.
The default is *ALL.
- Throws: PropertyVetoException
- If the change is vetoed.
setQueueFilter
public void setQueueFilter(String queueFilter) throws PropertyVetoException
- Sets the output queue filter.
- Parameters:
- queueFilter - The library and output queues on which to list spooled
files. 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 or one of these special values:
- %CURLIB% - The server job's current library
- %LIBL% - The server job's library list
- %ALL% - All libraries are searched. This value is only valid
if the queuename is %ALL%.
queuename is the name of an output queues to search.
It can be a specific name or the special value %ALL%.
If it is %ALL%, then the libname must be %ALL%.
- Throws: PropertyVetoException
- If the change is vetoed.
setUserFilter
public void setUserFilter(String userFilter) throws PropertyVetoException
- Sets the user ID list filter.
- Parameters:
- userFilter - The user or users for which to list spooled files.
The value cannot be greater than 10 characters.
The value can be any specific user ID or any of these special values:
- *ALL - Spooled files created by all users will be included in the list.
- *CURRENT - Spooled files created by the current user only will be in the list.
The default is *CURRENT.
- Throws: PropertyVetoException
- If the change is vetoed.
setUserDataFilter
public void setUserDataFilter(String userDataFilter) throws PropertyVetoException
- Sets the user data list filter.
- Parameters:
- userDataFilter - The user data the spooled file must
have for it to be included in the list. The value can be
any specific value or the special value *ALL. The value cannot be
greater than 10 characters.
The default is *ALL.
- Throws: PropertyVetoException
- If the change is vetoed.
All Packages Class Hierarchy This Package Previous Next Index