public class SpooledFileListItem extends Object
SpooledFileOpenList
.
Some attributes will not be available, depending on the format
that was used to generate this item. The javadoc for each attribute getter indicates which formats will generate valid data for the given attribute. If an attribute getter that is only valid for a format other than what was used to generate this SpooledFileListItem, the data returned by that getter is not valid.
Modifier and Type | Field | Description |
---|---|---|
static String |
ASSIGNED_MULTIPLE |
Constant indicating the spooled file is assigned to multiple printers.
|
static String |
ASSIGNED_NONE |
Constant indicating the spooled file is not assigned to a printer.
|
static String |
ASSIGNED_SPECIFIC |
Constant indicating the spooled file is assigned to a specific printer.
|
static String |
DEVICE_TYPE_DISKETTE |
Constant indicating the spooled file is intended for a diskette device.
|
static String |
DEVICE_TYPE_PRINTER |
Constant indicating the spooled file is intended for a printer device.
|
static String |
SCHEDULE_FILE_END |
Constant indicating the spooled file is schedule file end.
|
static String |
SCHEDULE_IMMEDIATE |
Constant indicating the spooled file is schedule immediate.
|
static String |
SCHEDULE_JOB_END |
Constant indicating the spooled file is schedule job end.
|
static String |
STATUS_CLOSED |
Constant indicating the spooled file has been processed completely by a program, but SCHEDULE(*JOBEND) was specified.
|
static String |
STATUS_DEFERRED |
Constant indicating the spooled file has been deferred from printing.
|
static String |
STATUS_FINISHED |
Constant indicating the spooled file is no longer in the system.
|
static String |
STATUS_HELD |
Constant indicating the spooled file has been held.
|
static String |
STATUS_MESSAGE_WAIT |
Constant indicating the spooled file has a message that needs a reply or needs an action to be taken.
|
static String |
STATUS_OPEN |
Constant indicating the spooled file has not been completely processed and is not ready to be selected by a writer.
|
static String |
STATUS_PENDING |
Constant indicating the spooled file is pending (waiting) to be printed.
|
static String |
STATUS_PRINTING |
Constant indicating the spooled file has been completely sent to the printer, but the print complete status has not been sent back.
|
static String |
STATUS_READY |
Constant indicating the spooled file is available to be written to an output device by a writer.
|
static String |
STATUS_SAVED |
Constant indicating the spooled file has been written and then saved.
|
static String |
STATUS_SENDING |
Constant indicating the spooled file is being sent or has been sent to a remote system.
|
static String |
STATUS_WRITING |
Constant indicating the spooled file currently is being produced by the writer on an output device.
|
Modifier and Type | Method | Description |
---|---|---|
int |
getASP() |
Returns the auxiliary storage pool (ASP) in which the spooled file resides.
|
int |
getCopiesLeftToPrint() |
Returns the remaining number of copies to be printed.
|
Date |
getCreationDate() |
Returns the date and time the spooled file was created.
|
int |
getCurrentPage() |
Returns the page number or record number currently being written.
|
String |
getDateOpened() |
Returns the date the spooled file was created.
|
String |
getDeviceType() |
Returns the type of device for which the spooled file is intended.
|
String |
getFormat() |
Returns the format that was used by SpooledFileOpenList to generate this item.
|
String |
getFormType() |
Returns the type of forms that should be loaded on the printer before this spooled file is printed.
|
byte[] |
getInternalJobIdentifier() |
Returns the internal job identifier for the job that created the spooled file.
|
byte[] |
getInternalSpooledFileIdentifier() |
Returns the internal spooled file identifier for the spooled file.
|
int |
getIPPJobIdentifier() |
Returns the Internet Print Protocol (IPP) job identifier assigned by the system based on the output queue to which the file was added or moved.
|
String |
getJobName() |
Returns the name of the job that created the spooled file.
|
String |
getJobNumber() |
Returns the number of the job that created the spooled file.
|
String |
getJobSystemName() |
Returns the name of the system where the job that created the spooled file ran.
|
String |
getJobUser() |
Returns the user of the job that created the spooled file.
|
String |
getName() |
Returns the name of the spooled file.
|
int |
getNumber() |
Returns the number of the spooled file.
|
String |
getOutputQueue() |
Returns the fully-qualified integrated file system path of the output queue in which the spooled file is located.
|
String |
getOutputQueueLibrary() |
Returns the library of the output queue in which the spooled file is located.
|
String |
getOutputQueueName() |
Returns the name of the output queue in which the spooled file is located.
|
String |
getPrinterAssignment() |
Returns how the spooled file is assigned.
|
String |
getPrinterName() |
Returns the name of the printer the spooled file has been assigned to print on.
|
String |
getPriority() |
Returns the priority of the spooled file.
|
String |
getSchedule() |
Returns the schedule of the spooled file.
|
long |
getSize() |
Returns the spooled file size in bytes.
|
String |
getStatus() |
Returns the status of the spooled file.
|
String |
getTimeOpened() |
Returns the time the spooled file was created.
|
int |
getTotalPages() |
Returns the total number of pages or number of records for this spooled file.
|
String |
getUserData() |
Returns the 10 characters of user-specified data that describe the spooled file.
|
public static final String ASSIGNED_SPECIFIC
getPrinterAssignment()
,
Constant Field Valuespublic static final String ASSIGNED_MULTIPLE
getPrinterAssignment()
,
Constant Field Valuespublic static final String ASSIGNED_NONE
getPrinterAssignment()
,
Constant Field Valuespublic static final String DEVICE_TYPE_DISKETTE
getDeviceType()
,
Constant Field Valuespublic static final String DEVICE_TYPE_PRINTER
getDeviceType()
,
Constant Field Valuespublic static final String SCHEDULE_IMMEDIATE
getSchedule()
,
Constant Field Valuespublic static final String SCHEDULE_FILE_END
getSchedule()
,
Constant Field Valuespublic static final String SCHEDULE_JOB_END
getSchedule()
,
Constant Field Valuespublic static final String STATUS_READY
getStatus()
,
Constant Field Valuespublic static final String STATUS_OPEN
getStatus()
,
Constant Field Valuespublic static final String STATUS_CLOSED
getStatus()
,
Constant Field Valuespublic static final String STATUS_SAVED
getStatus()
,
Constant Field Valuespublic static final String STATUS_WRITING
getStatus()
,
Constant Field Valuespublic static final String STATUS_HELD
getStatus()
,
Constant Field Valuespublic static final String STATUS_MESSAGE_WAIT
getStatus()
,
Constant Field Valuespublic static final String STATUS_PENDING
getStatus()
,
Constant Field Valuespublic static final String STATUS_PRINTING
getStatus()
,
Constant Field Valuespublic static final String STATUS_FINISHED
getStatus()
,
Constant Field Valuespublic static final String STATUS_SENDING
getStatus()
,
Constant Field Valuespublic static final String STATUS_DEFERRED
getStatus()
,
Constant Field Valuespublic int getASP()
Available in format: FORMAT_0300
, FORMAT_0400
public int getCopiesLeftToPrint()
Available in format: FORMAT_0100
, FORMAT_0200
, FORMAT_0300
getDeviceType()
public Date getCreationDate()
Available in format: FORMAT_0100
(i5/OS V5R2M0 and higher), FORMAT_0200
, FORMAT_0300
, FORMAT_0400
getDateOpened()
,
getTimeOpened()
public int getCurrentPage()
Available in format: FORMAT_0100
, FORMAT_0200
public String getDateOpened()
Available in format: FORMAT_0100
(i5/OS V5R2M0 and higher), FORMAT_0200
, FORMAT_0300
, FORMAT_0400
getCreationDate()
public String getDeviceType()
Available in format: FORMAT_0100
, FORMAT_0200
public String getFormat()
getFormat()
public String getFormType()
Available in format: FORMAT_0100
, FORMAT_0200
, FORMAT_0300
, FORMAT_0400
getDeviceType()
public byte[] getInternalJobIdentifier()
Available in format: FORMAT_0100
, FORMAT_0200
Job.setInternalJobIdentifier(byte[])
public byte[] getInternalSpooledFileIdentifier()
Available in format: FORMAT_0100
, FORMAT_0200
public int getIPPJobIdentifier()
Available in format: FORMAT_0300
, FORMAT_0400
,
public String getJobName()
Available in format: FORMAT_0100
, FORMAT_0200
, FORMAT_0300
, FORMAT_0400
getJobNumber()
,
getJobUser()
public String getJobNumber()
Available in format: FORMAT_0100
, FORMAT_0200
, FORMAT_0300
, FORMAT_0400
getJobName()
,
getJobUser()
public String getJobSystemName()
Available in format: FORMAT_0100
(i5/OS V5R2M0 and higher), FORMAT_0200
(i5/OS V5R2M0 and higher), FORMAT_0300
, FORMAT_0400
public String getJobUser()
Available in format: FORMAT_0100
, FORMAT_0200
, FORMAT_0300
, FORMAT_0400
getJobName()
,
getJobNumber()
public String getName()
Available in format: FORMAT_0100
, FORMAT_0200
, FORMAT_0300
, FORMAT_0400
public int getNumber()
Available in format: FORMAT_0100
, FORMAT_0200
, FORMAT_0300
, FORMAT_0400
public String getOutputQueue()
Available in format: FORMAT_0100
, FORMAT_0200
, FORMAT_0300
, FORMAT_0400
getOutputQueueName()
,
getOutputQueueLibrary()
public String getOutputQueueLibrary()
Available in format: FORMAT_0100
, FORMAT_0200
, FORMAT_0300
, FORMAT_0400
getOutputQueue()
public String getOutputQueueName()
Available in format: FORMAT_0100
, FORMAT_0200
, FORMAT_0300
, FORMAT_0400
getOutputQueue()
public String getPrinterAssignment()
ASSIGNED_SPECIFIC
- The printer name will be valid.
ASSIGNED_MULTIPLE
- The printer name will be blank.
ASSIGNED_NONE
- The printer name will be blank.
Available in format: FORMAT_0200
getPrinterName()
,
getDeviceType()
public String getPrinterName()
Available in format: FORMAT_0200
getPrinterAssignment()
,
getDeviceType()
public String getPriority()
Available in format: FORMAT_0100
, FORMAT_0200
, FORMAT_0300
, FORMAT_0400
public String getSchedule()
Available in format: FORMAT_0300
, FORMAT_0400
public long getSize()
Available in format: FORMAT_0300
, FORMAT_0400
public String getStatus()
STATUS_READY
STATUS_OPEN
STATUS_CLOSED
STATUS_SAVED
STATUS_WRITING
STATUS_HELD
STATUS_MESSAGE_WAIT
STATUS_PENDING
STATUS_PRINTING
STATUS_FINISHED
STATUS_SENDING
STATUS_DEFERRED
Available in format: FORMAT_0100
, FORMAT_0200
, FORMAT_0300
, FORMAT_0400
public String getTimeOpened()
Available in format: FORMAT_0100
(i5/OS V5R2M0 and higher), FORMAT_0200
, FORMAT_0300
, FORMAT_0400
getCreationDate()
public int getTotalPages()
Available in format: FORMAT_0100
, FORMAT_0200
, FORMAT_0300
, FORMAT_0400
public String getUserData()
Available in format: FORMAT_0100
, FORMAT_0200
, FORMAT_0300
, FORMAT_0400
Copyright © 2024. All rights reserved.