SpooledFileList

java.lang.Object
- com.ibm.as400.access.PrintObjectList
- - com.ibm.as400.access.SpooledFileList

All Implemented Interfaces:

Serializable
```
public class SpooledFileList
extends PrintObjectList
implements Serializable
```
Builds a list of objects of type SpooledFile. The list can be filtered by formtype, output queue, user, ending date, ending time, or user data.

See Also:
SpooledFile, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SpooledFileList()
Constructs a SpooledFileList object.

SpooledFileList(AS400 system)
Constructs a SpooledFileList object.

Constructors
Constructor and Description
`SpooledFileList()` Constructs a SpooledFileList object.
`SpooledFileList(AS400 system)` Constructs a SpooledFileList object.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getEndDateFilter()` Returns the create end date filter.
`String`	`getEndTimeFilter()` Returns the create end time filter.
`String`	`getFormTypeFilter()` Returns the formtype list filter.
`String`	`getJobSystemFilter()` Returns the create job system filter.
`String`	`getQueueFilter()` Returns the output queue filter.
`String`	`getStartDateFilter()` Returns the create start date filter.
`String`	`getStartTimeFilter()` Returns the create start time filter.
`String`	`getUserDataFilter()` Returns the user data list filter.
`String`	`getUserFilter()` Returns the user ID list filter.
`void`	`setEndDateFilter(String endDateFilter)` Sets the end date filter.
`void`	`setEndTimeFilter(String endTimeFilter)` Sets the end time filter.
`void`	`setFormTypeFilter(String formTypeFilter)` Sets the formtype list filter.
`void`	`setJobSystemFilter(String jobSystemFilter)` Sets the create job system filter.
`void`	`setQueueFilter(String queueFilter)` Sets the output queue filter.
`void`	`setStartDateFilter(String startDateFilter)` Sets the create start date filter.
`void`	`setStartTimeFilter(String startTimeFilter)` Sets the create start time filter.
`void`	`setUserDataFilter(String userDataFilter)` Sets the user data list filter.
`void`	`setUserFilter(String userFilter)` Sets the user ID 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
  - SpooledFileList
```
public SpooledFileList()
```
    Constructs a SpooledFileList 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)
  - 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 system on which the spooled files exist.
- Method Detail
  - 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.
  - getJobSystemFilter
```
public String getJobSystemFilter()
```
    Returns the create job system filter.
  - getEndDateFilter
```
public String getEndDateFilter()
```
    Returns the create end date filter.
  - getEndTimeFilter
```
public String getEndTimeFilter()
```
    Returns the create end time filter.
  - getStartDateFilter
```
public String getStartDateFilter()
```
    Returns the create start date filter.
  - getStartTimeFilter
```
public String getStartTimeFilter()
```
    Returns the create start time 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.
  - setJobSystemFilter
```
public void setJobSystemFilter(String jobSystemFilter)
                        throws PropertyVetoException
```
    Sets the create job system filter. The name of the system where the job, specified in the qualified job name parameter, was run. This parameter can be used in conjunction with the user name, qualified output queue name, form type, user-specified data, auxiliary storage pool, starting spooled file create date, starting spooled file create time, ending spooled file create date, or ending spooled file create time parameters to return a partial list of all the spooled files. The list of spooled files returned is sorted by status, output priority, date, and time. The following special values are supported for this parameter:
    
    Parameters:
    jobSystemFilter -
    *ALL The returned list is not to be filtered based on job system name. *CURRENT Only spooled files created on the current system are to be returned. Only spooled files created on the system specified are to be returned.
  The system referenced by system must be at V5R2 or later to support this filter.
  Throws:
  
  PropertyVetoException - If the change is vetoed.
- setEndDateFilter
```
public void setEndDateFilter(String endDateFilter)
                      throws PropertyVetoException
```
  Sets the end date filter. The date the spooled file was created on the system. If the Starting spooled file create date field is set to *ALL, then this field must be set to blanks. If a date has been specified for the Starting spooled file create date field, then this field must be set to a valid date. The date must be in the CYYMMDD format or the following special value:
  Parameters:
  endDateFilter -
  date All spooled files with a create date and time equal to or later than the starting spooled file create date are to be returned.
  - *LAST - All spooled files with a create date and time equal to or later than the starting spooled file create date are to be returned.
  The system referenced by system must be at V5R2 or later to support this filter.
  Throws:
  
  PropertyVetoException - If the change is vetoed.
- setEndTimeFilter
```
public void setEndTimeFilter(String endTimeFilter)
                      throws PropertyVetoException
```
  Sets the end time filter. The time the spooled file was created on the system. This field must be set to blanks when special value *ALL is used for field Starting spooled file create date or when special value *LAST is used for field Ending spooled file create date. This field must have a value set if a date is specified for field Ending spooled file create date. The time must be in the HHMMSS format.
  
  Parameters:
  endTimeFilter -
  time All spooled files with a create date and time equal to or later than the starting spooled file create date are to be returned.
  The system referenced by system must be at V5R2 or later to support this filter.
  
  Throws:
  
  PropertyVetoException - If the change is vetoed.
- setStartDateFilter
```
public void setStartDateFilter(String startDateFilter)
                        throws PropertyVetoException
```
  Sets the create start date filter. The date the spooled file was created on the system. This parameter can be used in conjunction with the user name, qualified output queue name, form type, user-specified data, auxiliary storage pool, job system name, starting spooled file create time, ending spooled file create date, or ending spooled file create time parameters to return a partial list of all the spooled files. The list of spooled files returned is sorted by status, output priority, date, and time. The date must be in the CYYMMDD format or one of the following special values:
  
  Parameters:
  startDateFilter -
  date All spooled files with a create date and time equal to or later than the starting spooled file create date are to be returned. *ALL The returned list is not to be filtered based on spooled file create date and spooled file create time. *FIRST All spooled files starting with the earliest create date and time and less than or equal to the ending spooled file create date and time are to be returned.
  The system referenced by system must be at V5R2 or later to support this filter.
  
  Throws:
  
  PropertyVetoException - If the change is vetoed.
- setStartTimeFilter
```
public void setStartTimeFilter(String startTimeFilter)
                        throws PropertyVetoException
```
  Sets the create start time filter. This parameter can be used in conjunction with the user name, qualified output queue name, form type, user-specified data, auxiliary storage pool, job system name, starting spooled file create date, ending spooled file create date, or ending spooled file create time parameters to return a partial list of all the spooled files. The list of spooled files returned is sorted by status, output priority, date, and time. This parameter must be set to blanks when special value *ALL or *FIRST is used for parameter Starting spooled file create date. This parameter must have a value set if a date is specified for parameter Starting spooled file create date. The time must be in the HHMMSS format. The time format HHMMSS is defined as follows:
  
  Parameters:
  startTimeFilter -
  time All spooled files with a create date and time equal to or
  The system referenced by system must be at V5R2 or later to support this filter.
  
  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.

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

Methods inherited from class java.lang.Object

SpooledFileList

SpooledFileList

getFormTypeFilter

getQueueFilter

getUserFilter

getUserDataFilter

getJobSystemFilter

getEndDateFilter

getEndTimeFilter

getStartDateFilter

getStartTimeFilter

setFormTypeFilter

setQueueFilter

setJobSystemFilter