com.ibm.as400.access.list

Class SpooledFileListItem

  • java.lang.Object
    • com.ibm.as400.access.list.SpooledFileListItem


  • public class SpooledFileListItem
    extends java.lang.Object
    Contains spooled file information that was generated by 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.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String ASSIGNED_MULTIPLE
      Constant indicating the spooled file is assigned to multiple printers.
      static java.lang.String ASSIGNED_NONE
      Constant indicating the spooled file is not assigned to a printer.
      static java.lang.String ASSIGNED_SPECIFIC
      Constant indicating the spooled file is assigned to a specific printer.
      static java.lang.String DEVICE_TYPE_DISKETTE
      Constant indicating the spooled file is intended for a diskette device.
      static java.lang.String DEVICE_TYPE_PRINTER
      Constant indicating the spooled file is intended for a printer device.
      static java.lang.String SCHEDULE_FILE_END
      Constant indicating the spooled file is schedule file end.
      static java.lang.String SCHEDULE_IMMEDIATE
      Constant indicating the spooled file is schedule immediate.
      static java.lang.String SCHEDULE_JOB_END
      Constant indicating the spooled file is schedule job end.
      static java.lang.String STATUS_CLOSED
      Constant indicating the spooled file has been processed completely by a program, but SCHEDULE(*JOBEND) was specified.
      static java.lang.String STATUS_DEFERRED
      Constant indicating the spooled file has been deferred from printing.
      static java.lang.String STATUS_FINISHED
      Constant indicating the spooled file is no longer in the system.
      static java.lang.String STATUS_HELD
      Constant indicating the spooled file has been held.
      static java.lang.String STATUS_MESSAGE_WAIT
      Constant indicating the spooled file has a message that needs a reply or needs an action to be taken.
      static java.lang.String STATUS_OPEN
      Constant indicating the spooled file has not been completely processed and is not ready to be selected by a writer.
      static java.lang.String STATUS_PENDING
      Constant indicating the spooled file is pending (waiting) to be printed.
      static java.lang.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 java.lang.String STATUS_READY
      Constant indicating the spooled file is available to be written to an output device by a writer.
      static java.lang.String STATUS_SAVED
      Constant indicating the spooled file has been written and then saved.
      static java.lang.String STATUS_SENDING
      Constant indicating the spooled file is being sent or has been sent to a remote system.
      static java.lang.String STATUS_WRITING
      Constant indicating the spooled file currently is being produced by the writer on an output device.
    • Method Summary

      Methods 
      Modifier and Type Method and 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.
      java.util.Date getCreationDate()
      Returns the date and time the spooled file was created.
      int getCurrentPage()
      Returns the page number or record number currently being written.
      java.lang.String getDateOpened()
      Returns the date the spooled file was created.
      java.lang.String getDeviceType()
      Returns the type of device for which the spooled file is intended.
      java.lang.String getFormat()
      Returns the format that was used by SpooledFileOpenList to generate this item.
      java.lang.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.
      java.lang.String getJobName()
      Returns the name of the job that created the spooled file.
      java.lang.String getJobNumber()
      Returns the number of the job that created the spooled file.
      java.lang.String getJobSystemName()
      Returns the name of the system where the job that created the spooled file ran.
      java.lang.String getJobUser()
      Returns the user of the job that created the spooled file.
      java.lang.String getName()
      Returns the name of the spooled file.
      int getNumber()
      Returns the number of the spooled file.
      java.lang.String getOutputQueue()
      Returns the fully-qualified integrated file system path of the output queue in which the spooled file is located.
      java.lang.String getOutputQueueLibrary()
      Returns the library of the output queue in which the spooled file is located.
      java.lang.String getOutputQueueName()
      Returns the name of the output queue in which the spooled file is located.
      java.lang.String getPrinterAssignment()
      Returns how the spooled file is assigned.
      java.lang.String getPrinterName()
      Returns the name of the printer the spooled file has been assigned to print on.
      java.lang.String getPriority()
      Returns the priority of the spooled file.
      java.lang.String getSchedule()
      Returns the schedule of the spooled file.
      long getSize()
      Returns the spooled file size in bytes.
      java.lang.String getStatus()
      Returns the status of the spooled file.
      java.lang.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.
      java.lang.String getUserData()
      Returns the 10 characters of user-specified data that describe the spooled file.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • DEVICE_TYPE_DISKETTE

        public static final java.lang.String DEVICE_TYPE_DISKETTE
        Constant indicating the spooled file is intended for a diskette device.
        See Also:
        getDeviceType(), Constant Field Values
      • DEVICE_TYPE_PRINTER

        public static final java.lang.String DEVICE_TYPE_PRINTER
        Constant indicating the spooled file is intended for a printer device.
        See Also:
        getDeviceType(), Constant Field Values
      • SCHEDULE_IMMEDIATE

        public static final java.lang.String SCHEDULE_IMMEDIATE
        Constant indicating the spooled file is schedule immediate. A spooling writer can process the spooled file immediately.
        See Also:
        getSchedule(), Constant Field Values
      • SCHEDULE_FILE_END

        public static final java.lang.String SCHEDULE_FILE_END
        Constant indicating the spooled file is schedule file end. A spooling writer cannot process the spooled file until it has been closed.
        See Also:
        getSchedule(), Constant Field Values
      • SCHEDULE_JOB_END

        public static final java.lang.String SCHEDULE_JOB_END
        Constant indicating the spooled file is schedule job end. A spooling writer cannot process the spooled file until the job of the spooled file has ended.
        See Also:
        getSchedule(), Constant Field Values
      • STATUS_READY

        public static final java.lang.String STATUS_READY
        Constant indicating the spooled file is available to be written to an output device by a writer.
        See Also:
        getStatus(), Constant Field Values
      • STATUS_OPEN

        public static final java.lang.String STATUS_OPEN
        Constant indicating the spooled file has not been completely processed and is not ready to be selected by a writer.
        See Also:
        getStatus(), Constant Field Values
      • STATUS_CLOSED

        public static final java.lang.String STATUS_CLOSED
        Constant indicating the spooled file has been processed completely by a program, but SCHEDULE(*JOBEND) was specified. The job that produced the spooled file has not finished.
        See Also:
        getStatus(), Constant Field Values
      • STATUS_SAVED

        public static final java.lang.String STATUS_SAVED
        Constant indicating the spooled file has been written and then saved. This spooled file remains saved until it is released.
        See Also:
        getStatus(), Constant Field Values
      • STATUS_WRITING

        public static final java.lang.String STATUS_WRITING
        Constant indicating the spooled file currently is being produced by the writer on an output device.
        See Also:
        getStatus(), Constant Field Values
      • STATUS_MESSAGE_WAIT

        public static final java.lang.String STATUS_MESSAGE_WAIT
        Constant indicating the spooled file has a message that needs a reply or needs an action to be taken.
        See Also:
        getStatus(), Constant Field Values
      • STATUS_PENDING

        public static final java.lang.String STATUS_PENDING
        Constant indicating the spooled file is pending (waiting) to be printed.
        See Also:
        getStatus(), Constant Field Values
      • STATUS_PRINTING

        public static final java.lang.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.
        See Also:
        getStatus(), Constant Field Values
      • STATUS_FINISHED

        public static final java.lang.String STATUS_FINISHED
        Constant indicating the spooled file is no longer in the system. A spooled file with this status is only returned in the list of spooled files if the qualified job name was specified.
        See Also:
        getStatus(), Constant Field Values
      • STATUS_SENDING

        public static final java.lang.String STATUS_SENDING
        Constant indicating the spooled file is being sent or has been sent to a remote system.
        See Also:
        getStatus(), Constant Field Values
      • STATUS_DEFERRED

        public static final java.lang.String STATUS_DEFERRED
        Constant indicating the spooled file has been deferred from printing.
        See Also:
        getStatus(), Constant Field Values
    >
    • Method Detail

      • getASP

        public int getASP()
        Returns the auxiliary storage pool (ASP) in which the spooled file resides. Possible values are:
        • 1 - The system auxiliary storage pool (*SYSTEM).
        • 2-255 - The number of the auxiliary storage pool.

        Available in format: FORMAT_0300

        Returns:
        The auxiliary storage pool.
      • getCopiesLeftToPrint

        public int getCopiesLeftToPrint()
        Returns the remaining number of copies to be printed. This attribute applies to printer device type spooled files only.

        Available in format: FORMAT_0100, FORMAT_0200, FORMAT_0300

        Returns:
        The number of copies left.
        See Also:
        getDeviceType()
      • getCurrentPage

        public int getCurrentPage()
        Returns the page number or record number currently being written. The page number may be lower or higher than the page number actually being printed because of buffering done by the system. For example, if the spooled file is routed to a diskette unit or the writer is currently printing job separators or file separators for the spooled file, the page number returned may be zero.

        Available in format: FORMAT_0100, FORMAT_0200

        Returns:
        The current page number.
      • getDateOpened

        public java.lang.String getDateOpened()
        Returns the date the spooled file was created.

        Available in format: FORMAT_0100 (i5/OS V5R2M0 and higher), FORMAT_0200, FORMAT_0300

        Returns:
        The date in the format CYYMMDD.
        See Also:
        getCreationDate()
      • getFormat

        public java.lang.String getFormat()
        Returns the format that was used by SpooledFileOpenList to generate this item.
        Returns:
        The format.
        See Also:
        getFormat()
      • getFormType

        public java.lang.String getFormType()
        Returns the type of forms that should be loaded on the printer before this spooled file is printed. This attribute applies to printer device type spooled files only.

        Available in format: FORMAT_0100, FORMAT_0200, FORMAT_0300

        Returns:
        The form type.
        See Also:
        getDeviceType()
      • getInternalSpooledFileIdentifier

        public byte[] getInternalSpooledFileIdentifier()
        Returns the internal spooled file identifier for the spooled file. This is the input value that other programs use to improve the performance of locating the spooled file on the system. Only the spooled file APIs use this identifier, not any other interface on the system.

        Available in format: FORMAT_0100, FORMAT_0200

        Returns:
        The 16-byte internal spooled file ID.
      • getIPPJobIdentifier

        public 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. This value ranges from 1 to 2,147,483,647 and is not guaranteed to be unique for a given output queue. This value will be 0 when retrieved from systems running i5/OS V5R2M0 and earlier.

        Available in format: FORMAT_0300,

        Returns:
        The IPP job identifier.
      • getJobSystemName

        public java.lang.String getJobSystemName()
        Returns the name of the system where the job that created the spooled file ran.

        Available in format: FORMAT_0100 (i5/OS V5R2M0 and higher), FORMAT_0200 (i5/OS V5R2M0 and higher), FORMAT_0300

        Returns:
        The system name.
      • getName

        public java.lang.String getName()
        Returns the name of the spooled file.

        Available in format: FORMAT_0100, FORMAT_0200, FORMAT_0300

        Returns:
        The spooled file name.
      • getNumber

        public int getNumber()
        Returns the number of the spooled file.

        Available in format: FORMAT_0100, FORMAT_0200, FORMAT_0300

        Returns:
        The spooled file number.
      • getOutputQueueLibrary

        public java.lang.String getOutputQueueLibrary()
        Returns the library of the output queue in which the spooled file is located.

        Available in format: FORMAT_0100, FORMAT_0200, FORMAT_0300

        Returns:
        The library.
        See Also:
        getOutputQueue()
      • getOutputQueueName

        public java.lang.String getOutputQueueName()
        Returns the name of the output queue in which the spooled file is located.

        Available in format: FORMAT_0100, FORMAT_0200, FORMAT_0300

        Returns:
        The output queue name.
        See Also:
        getOutputQueue()
      • getPrinterAssignment

        public java.lang.String getPrinterAssignment()
        Returns how the spooled file is assigned. This attribute applies to printer device type spooled files only. Possible values are:

        Available in format: FORMAT_0200

        Returns:
        The printer assignment.
        See Also:
        getPrinterName(), getDeviceType()
      • getPrinterName

        public java.lang.String getPrinterName()
        Returns the name of the printer the spooled file has been assigned to print on. This attribute applies to printer device type spooled files only, and is only valid when the printer assignment is ASSIGNED_SPECIFIC.

        Available in format: FORMAT_0200

        Returns:
        The printer name.
        See Also:
        getPrinterAssignment(), getDeviceType()
      • getPriority

        public java.lang.String getPriority()
        Returns the priority of the spooled file. The priority ranges from 1 (highest) to 9 (lowest).

        Available in format: FORMAT_0100, FORMAT_0200, FORMAT_0300

        Returns:
        The priority.
      • getSize

        public long getSize()
        Returns the spooled file size in bytes. The size of the spooled file is the data stream size, plus the spooled file's attributes, plus the overhead storage used to store the spooled file's data stream.

        Available in format: FORMAT_0300

        Returns:
        The size.
      • getTimeOpened

        public java.lang.String getTimeOpened()
        Returns the time the spooled file was created.

        Available in format: FORMAT_0100 (i5/OS V5R2M0 and higher), FORMAT_0200, FORMAT_0300

        Returns:
        The time in the format HHMMSS.
        See Also:
        getCreationDate()
      • getTotalPages

        public int getTotalPages()
        Returns the total number of pages or number of records for this spooled file.

        Available in format: FORMAT_0100, FORMAT_0200, FORMAT_0300

        Returns:
        The number of pages.
      • getUserData

        public java.lang.String getUserData()
        Returns the 10 characters of user-specified data that describe the spooled file.

        Available in format: FORMAT_0100, FORMAT_0200, FORMAT_0300

        Returns:
        The user data.