Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.ibm.as400.access
Class ISeriesPrinter

java.lang.Object
  |
  +--com.ibm.as400.access.ISeriesPrinter
All Implemented Interfaces:
java.io.Serializable
public class ISeriesPrinter
extends java.lang.Object
implements java.io.Serializable

Represents a printer attached to an iSeries system. This class provides access to the specified printer's attributes via the QGYRPRTA system API.

To determine a list of printer device descriptions on the iSeries system, use the ConfigurationDescriptionList class.

This class uses the remote command host server to obtain printer information. Use the Printer class to retrieve similer information using the network print host server.

Example: 

 AS400 system = new AS400("mySystem", "myUserID", "myPassword");
 ISeriesPrinter printer = new ISeriesPrinter(system, "myPrinter");
 String type = printer.getPrinterDeviceType();
 if (type == ISeriesPrinter.PRINTER_DEVICE_TYPE_SCS)
 {
   System.out.println(printer.getCopiesLeft());
 }

See Also:
Printer, com.ibm.as400.access.config.ConfigurationDescriptionList, com.ibm.as400.access.config.PrinterDeviceDescription, Serialized Form

Field Summary
static int DEVICE_STATUS_ACTIVE
          Constant representing a value of 60.
static int DEVICE_STATUS_ACTIVE_READER
          Constant representing a value of 63.
static int DEVICE_STATUS_ACTIVE_WRITER
          Constant representing a value of 66.
static int DEVICE_STATUS_AS36_DISABLED
          Constant representing a value of 5.
static int DEVICE_STATUS_AS36_ENABLED
          Constant representing a value of 62.
static int DEVICE_STATUS_CONNECT_PENDING
          Constant representing a value of 40.
static int DEVICE_STATUS_DAMAGED
          Constant representing a value of 111.
static int DEVICE_STATUS_DIAGNOSTIC_MODE
          Constant representing a value of 110.
static int DEVICE_STATUS_FAILED
          Constant representing a value of 100.
static int DEVICE_STATUS_FAILED_READER
          Constant representing a value of 103.
static int DEVICE_STATUS_FAILED_WRITER
          Constant representing a value of 106.
static int DEVICE_STATUS_HELD
          Constant representing a value of 70.
static int DEVICE_STATUS_LOCKED
          Constant representing a value of 112.
static int DEVICE_STATUS_POWERED_OFF
          Constant representing a value of 75.
static int DEVICE_STATUS_RCYCNL
          Constant representing a value of 90.
static int DEVICE_STATUS_RCYPND
          Constant representing a value of 80.
static int DEVICE_STATUS_SIGNON_DISPLAY
          Constant representing a value of 50.
static int DEVICE_STATUS_SYSTEM_REQUEST
          Constant representing a value of 95.
static int DEVICE_STATUS_UNKNOWN
          Constant representing a value of 113.
static int DEVICE_STATUS_VARIED_OFF
          Constant representing a value of 0.
static int DEVICE_STATUS_VARIED_ON
          Constant representing a value of 30.
static int DEVICE_STATUS_VARY_OFF_PENDING
          Constant representing a value of 10.
static int DEVICE_STATUS_VARY_ON_PENDING
          Constant representing a value of 20.
static java.lang.String FORM_ALIGNMENT_FILE
          Constant representing a value of "*FILE".
static java.lang.String FORM_ALIGNMENT_WRITER
          Constant representing a value of "*WTR".
static java.lang.String FORM_TYPE_ALL
          Constant representing a value of "*ALL".
static java.lang.String FORM_TYPE_FORMS
          Constant representing a value of "*FORMS".
static java.lang.String FORM_TYPE_STANDARD
          Constant representing a value of "*STD".
static java.lang.String MESSAGE_OPTION_INFO
          Constant representing a value of "*INFOMSG".
static java.lang.String MESSAGE_OPTION_INQUIRY
          Constant representing a value of "*INQMSG".
static java.lang.String MESSAGE_OPTION_NONE
          Constant representing a value of "*NOMSG".
static java.lang.String MESSAGE_OPTION_STANDARD
          Constant representing a value of "*MSG".
static int OUTPUT_QUEUE_STATUS_HELD
          Constant representing an EBCDIC value of "H".
static int OUTPUT_QUEUE_STATUS_RELEASED
          Constant representing an EBCDIC value of "R".
static int OVERALL_STATUS_BEING_SERVICED
          Constant representing a value of 15.
static int OVERALL_STATUS_CONNECT_PENDING
          Constant representing a value of 12.
static int OVERALL_STATUS_HELD
          Constant representing a value of 5.
static int OVERALL_STATUS_HOLD_PENDING
          Constant representing a value of 7.
static int OVERALL_STATUS_MESSAGE_WAITING
          Constant representing a value of 4.
static int OVERALL_STATUS_NOT_YET_AVAILABLE
          Constant representing a value of 2.
static int OVERALL_STATUS_POWERED_OFF
          Constant representing a value of 13.
static int OVERALL_STATUS_PRINTING
          Constant representing a value of 10.
static int OVERALL_STATUS_STOP_PENDING
          Constant representing a value of 6.
static int OVERALL_STATUS_STOPPED
          Constant representing a value of 3.
static int OVERALL_STATUS_UNAVAILABLE
          Constant representing a value of 1.
static int OVERALL_STATUS_UNKNOWN
          Constant representing a value of 999.
static int OVERALL_STATUS_UNUSABLE
          Constant representing a value of 14.
static int OVERALL_STATUS_WAITING_FOR_PRINTER
          Constant representing a value of 8.
static int OVERALL_STATUS_WAITING_FOR_PRINTER_OUTPUT
          Constant representing a value of 11.
static int OVERALL_STATUS_WAITING_TO_START
          Constant representing a value of 9.
static int PENDING_STATUS_CONTROLLED
          Constant representing an EBCDIC value of "C".
static int PENDING_STATUS_IMMEDIATE
          Constant representing an EBCDIC value of "I".
static int PENDING_STATUS_NONE
          Constant representing an EBCDIC value of "N".
static int PENDING_STATUS_PAGE_END
          Constant representing an EBCDIC value of "P".
static java.lang.String PRINTER_DEVICE_TYPE_IPDS
          Constant representing a value of "*IPDS".
static java.lang.String PRINTER_DEVICE_TYPE_SCS
          Constant representing a value of "*SCS".
static int WRITER_STATUS_ENDED
          Constant representing a value of 2.
static int WRITER_STATUS_HELD
          Constant representing a value of 4.
static int WRITER_STATUS_MESSAGE_WAITING
          Constant representing a value of 5.
static int WRITER_STATUS_ON_JOB_QUEUE
          Constant representing a value of 3.
static int WRITER_STATUS_STARTED
          Constant representing a value of 1.
static java.lang.String WRITER_TIME_ALL_DONE
          Constant representing a value of "*NORDYF".
static java.lang.String WRITER_TIME_CURRENT_DONE
          Constant representing a value of "*FILEEND".
static java.lang.String WRITER_TIME_NONE
          Constant representing a value of "".
static java.lang.String WRITER_TIME_WAIT
          Constant representing a value of "*NO".
static int WRITING_STATUS_FILE_SEPARATORS
          Constant representing an EBCDIC value of "S".
static int WRITING_STATUS_NOT_WRITING
          Constant representing an EBCDIC value of "N".
static int WRITING_STATUS_WRITING
          Constant representing an EBCDIC value of "Y".
 
Constructor Summary
ISeriesPrinter(AS400 system, java.lang.String name)
          Constructs an ISeriesPrinter object with the specified name.
 
Method Summary
 boolean allowsDirectPrinting()
          Returns whether or not the printer writer allows the printer to be allocated to a job that prints directly to the printer.
 boolean equals(java.lang.Object obj)
          Returns whether or not the specified object is equal to this object.
 int getCopiesLeft()
          Returns the number of copies left to be printed.
 java.lang.String getDescription()
          Returns the text description of the printer device.
 int getDeviceStatus()
          Returns the status of the printer device.
 int getEndPendingStatus()
          Returns whether an End Writer (ENDWTR) command has been issued for this writer.
 java.lang.String getFormAlignmentMessageTime()
          Returns the time at which the forms alignment message will be sent.
 java.lang.String getFormType()
          Returns the type of form being used to print the spooled file.
 int getHoldPendingStatus()
          Returns whether a Hold Writer (HLDWTR) command has been issued for this writer.
 java.lang.String getMessageOption()
          Returns the message option for sending a message to the message queue when this form is finished.
 java.lang.String getMessageQueue()
          Returns the fully qualified integrated file system pathname of the message queue associated with this printer.
 java.lang.String getName()
          Returns the name of this printer.
 int getNumberOfSeparators()
          Returns the number of separator pages to be printed.
 java.lang.String getOutputQueue()
          Returns the fully qualified integrated file system pathname of the output queue associated with this printer from which spooled files are selected for printing.
 int getOutputQueueStatus()
          Returns the status of the output queue from which spooled files are being selected for printing.
 int getOverallStatus()
          Returns the overall status of the logical printer.
 int getPageBeingWritten()
          Returns the page number in the spooled file that is currently being processed by the writer.
 java.lang.String getPendingFormType()
          Returns the name of the next form type to be printed.
 java.lang.String getPendingMessageOption()
          Returns the message option for sending a message to the message queue when the next form type is finished.
 int getPendingNumberOfSeparators()
          Returns the next number of separator pages to be printed when the change to the writer takes place.
 java.lang.String getPendingOutputQueue()
          Returns the fully qualified integrated file system pathname of the next output queue.
 int getPendingSeparatorDrawer()
          Returns the drawer from which to take the separator pages if there is a change to the writer.
 java.lang.String getPrinterDeviceType()
          Returns the type of printer being used to print the spooled file.
 int getSeparatorDrawer()
          Returns the drawer from which the job and file separator pages are to be taken.
 java.util.Date getSpooledFileCreationDate()
          Returns the date and time the spooled file was created on the system.
 java.lang.String getSpooledFileJobName()
          Returns the name of the job that created the spooled file currently being processed by the writer.
 java.lang.String getSpooledFileJobNumber()
          Returns the number of the job that created the spooled file currently being processed by the writer.
 java.lang.String getSpooledFileJobSystem()
          Returns the name of the system where the job that created the spooled file ran.
 java.lang.String getSpooledFileJobUser()
          Returns the user of the job that created the spooled file currently being processed by the writer.
 java.lang.String getSpooledFileName()
          Returns the name of the spooled file currently being processed by the writer.
 int getSpooledFileNumber()
          Returns the number of the spooled file currently being processed by the writer.
 java.lang.String getStarterUser()
          Returns the name of the user that started the writer.
 AS400 getSystem()
          Returns the system.
 int getTotalCopies()
          Returns the total number of copies to be printed.
 int getTotalPages()
          Returns the total number of pages in the spooled file.
 java.lang.String getWriterChangeTime()
          Returns the time at which the pending changes to the writer take effect.
 java.lang.String getWriterEndTime()
          Returns when to end the writer if it is to end automatically.
 java.lang.String getWriterJobName()
          Returns the job name of the printer writer.
 java.lang.String getWriterJobNumber()
          Returns the job number of the printer writer.
 java.lang.String getWriterJobUser()
          Returns the name of the system user.
 byte[] getWriterMessageKey()
          Returns the key to the message that the writer is waiting for a reply.
 int getWriterStatus()
          Returns the status of the writer for this printer.
 int getWritingStatus()
          Returns whether the printer writer is in writing status.
 int hashCode()
          Returns the hash code value for the name of this ISeriesPrinter object.
 boolean isBetweenCopies()
          Returns whether the writer is between copies of a multiple copy spooled file.
 boolean isBetweenFiles()
          Returns whether the writer is between spooled files.
 boolean isHeld()
          Returns whether the writer is held.
 boolean isOnJobQueue()
          Returns whether the writer is on a job queue and is not currently running.
 boolean isPublishedInNetworkDirectory()
          Returns whether the printer is published in the network directory.
 boolean isWaitingForData()
          Returns whether the writer has written all the data currently in the spooled file and is waiting for more data.
 boolean isWaitingForDevice()
          Returns whether the writer is waiting to get the device from a job that is printing directly to the printer.
 boolean isWaitingForMessage()
          Returns whether the writer is waiting for a reply to an inquiry message.
 boolean isWriterStarted()
          Returns whether the writer is started for this printer.
 void refresh()
          Refreshes the information about this printer object from the system.
 boolean supportsAFP()
          Returns whether the printer supports Advanced Function Printing.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEVICE_STATUS_VARIED_OFF

public static final int DEVICE_STATUS_VARIED_OFF
Constant representing a value of 0.

See Also:
getDeviceStatus(), Constant Field Values

DEVICE_STATUS_AS36_DISABLED

public static final int DEVICE_STATUS_AS36_DISABLED
Constant representing a value of 5.

See Also:
getDeviceStatus(), Constant Field Values

DEVICE_STATUS_VARY_OFF_PENDING

public static final int DEVICE_STATUS_VARY_OFF_PENDING
Constant representing a value of 10.

See Also:
getDeviceStatus(), Constant Field Values

DEVICE_STATUS_VARY_ON_PENDING

public static final int DEVICE_STATUS_VARY_ON_PENDING
Constant representing a value of 20.

See Also:
getDeviceStatus(), Constant Field Values

DEVICE_STATUS_VARIED_ON

public static final int DEVICE_STATUS_VARIED_ON
Constant representing a value of 30.

See Also:
getDeviceStatus(), Constant Field Values

DEVICE_STATUS_CONNECT_PENDING

public static final int DEVICE_STATUS_CONNECT_PENDING
Constant representing a value of 40.

See Also:
getDeviceStatus(), Constant Field Values

DEVICE_STATUS_SIGNON_DISPLAY

public static final int DEVICE_STATUS_SIGNON_DISPLAY
Constant representing a value of 50.

See Also:
getDeviceStatus(), Constant Field Values

DEVICE_STATUS_ACTIVE

public static final int DEVICE_STATUS_ACTIVE
Constant representing a value of 60.

See Also:
getDeviceStatus(), Constant Field Values

DEVICE_STATUS_AS36_ENABLED

public static final int DEVICE_STATUS_AS36_ENABLED
Constant representing a value of 62.

See Also:
getDeviceStatus(), Constant Field Values

DEVICE_STATUS_ACTIVE_READER

public static final int DEVICE_STATUS_ACTIVE_READER
Constant representing a value of 63.

See Also:
getDeviceStatus(), Constant Field Values

DEVICE_STATUS_ACTIVE_WRITER

public static final int DEVICE_STATUS_ACTIVE_WRITER
Constant representing a value of 66.

See Also:
getDeviceStatus(), Constant Field Values

DEVICE_STATUS_HELD

public static final int DEVICE_STATUS_HELD
Constant representing a value of 70.

See Also:
getDeviceStatus(), Constant Field Values

DEVICE_STATUS_POWERED_OFF

public static final int DEVICE_STATUS_POWERED_OFF
Constant representing a value of 75.

See Also:
getDeviceStatus(), Constant Field Values

DEVICE_STATUS_RCYPND

public static final int DEVICE_STATUS_RCYPND
Constant representing a value of 80.

See Also:
getDeviceStatus(), Constant Field Values

DEVICE_STATUS_RCYCNL

public static final int DEVICE_STATUS_RCYCNL
Constant representing a value of 90.

See Also:
getDeviceStatus(), Constant Field Values

DEVICE_STATUS_SYSTEM_REQUEST

public static final int DEVICE_STATUS_SYSTEM_REQUEST
Constant representing a value of 95.

See Also:
getDeviceStatus(), Constant Field Values

DEVICE_STATUS_FAILED

public static final int DEVICE_STATUS_FAILED
Constant representing a value of 100.

See Also:
getDeviceStatus(), Constant Field Values

DEVICE_STATUS_FAILED_READER

public static final int DEVICE_STATUS_FAILED_READER
Constant representing a value of 103.

See Also:
getDeviceStatus(), Constant Field Values

DEVICE_STATUS_FAILED_WRITER

public static final int DEVICE_STATUS_FAILED_WRITER
Constant representing a value of 106.

See Also:
getDeviceStatus(), Constant Field Values

DEVICE_STATUS_DIAGNOSTIC_MODE

public static final int DEVICE_STATUS_DIAGNOSTIC_MODE
Constant representing a value of 110.

See Also:
getDeviceStatus(), Constant Field Values

DEVICE_STATUS_DAMAGED

public static final int DEVICE_STATUS_DAMAGED
Constant representing a value of 111.

See Also:
getDeviceStatus(), Constant Field Values

DEVICE_STATUS_LOCKED

public static final int DEVICE_STATUS_LOCKED
Constant representing a value of 112.

See Also:
getDeviceStatus(), Constant Field Values

DEVICE_STATUS_UNKNOWN

public static final int DEVICE_STATUS_UNKNOWN
Constant representing a value of 113.

See Also:
getDeviceStatus(), Constant Field Values

FORM_ALIGNMENT_WRITER

public static final java.lang.String FORM_ALIGNMENT_WRITER
Constant representing a value of "*WTR".

See Also:
getFormAlignmentMessageTime(), Constant Field Values

FORM_ALIGNMENT_FILE

public static final java.lang.String FORM_ALIGNMENT_FILE
Constant representing a value of "*FILE".

See Also:
getFormAlignmentMessageTime(), Constant Field Values

FORM_TYPE_ALL

public static final java.lang.String FORM_TYPE_ALL
Constant representing a value of "*ALL".

See Also:
getFormType(), Constant Field Values

FORM_TYPE_FORMS

public static final java.lang.String FORM_TYPE_FORMS
Constant representing a value of "*FORMS".

See Also:
getFormType(), Constant Field Values

FORM_TYPE_STANDARD

public static final java.lang.String FORM_TYPE_STANDARD
Constant representing a value of "*STD".

See Also:
getFormType(), Constant Field Values

MESSAGE_OPTION_NONE

public static final java.lang.String MESSAGE_OPTION_NONE
Constant representing a value of "*NOMSG".

See Also:
getMessageOption(), Constant Field Values

MESSAGE_OPTION_STANDARD

public static final java.lang.String MESSAGE_OPTION_STANDARD
Constant representing a value of "*MSG".

See Also:
getMessageOption(), Constant Field Values

MESSAGE_OPTION_INFO

public static final java.lang.String MESSAGE_OPTION_INFO
Constant representing a value of "*INFOMSG".

See Also:
getMessageOption(), Constant Field Values

MESSAGE_OPTION_INQUIRY

public static final java.lang.String MESSAGE_OPTION_INQUIRY
Constant representing a value of "*INQMSG".

See Also:
getMessageOption(), Constant Field Values

OUTPUT_QUEUE_STATUS_HELD

public static final int OUTPUT_QUEUE_STATUS_HELD
Constant representing an EBCDIC value of "H".

See Also:
getOutputQueueStatus(), Constant Field Values

OUTPUT_QUEUE_STATUS_RELEASED

public static final int OUTPUT_QUEUE_STATUS_RELEASED
Constant representing an EBCDIC value of "R".

See Also:
getOutputQueueStatus(), Constant Field Values

OVERALL_STATUS_UNAVAILABLE

public static final int OVERALL_STATUS_UNAVAILABLE
Constant representing a value of 1.

See Also:
getOverallStatus(), Constant Field Values

OVERALL_STATUS_NOT_YET_AVAILABLE

public static final int OVERALL_STATUS_NOT_YET_AVAILABLE
Constant representing a value of 2.

See Also:
getOverallStatus(), Constant Field Values

OVERALL_STATUS_STOPPED

public static final int OVERALL_STATUS_STOPPED
Constant representing a value of 3.

See Also:
getOverallStatus(), Constant Field Values

OVERALL_STATUS_MESSAGE_WAITING

public static final int OVERALL_STATUS_MESSAGE_WAITING
Constant representing a value of 4.

See Also:
getOverallStatus(), Constant Field Values

OVERALL_STATUS_HELD

public static final int OVERALL_STATUS_HELD
Constant representing a value of 5.

See Also:
getOverallStatus(), Constant Field Values

OVERALL_STATUS_STOP_PENDING

public static final int OVERALL_STATUS_STOP_PENDING
Constant representing a value of 6.

See Also:
getOverallStatus(), Constant Field Values

OVERALL_STATUS_HOLD_PENDING

public static final int OVERALL_STATUS_HOLD_PENDING
Constant representing a value of 7.

See Also:
getOverallStatus(), Constant Field Values

OVERALL_STATUS_WAITING_FOR_PRINTER

public static final int OVERALL_STATUS_WAITING_FOR_PRINTER
Constant representing a value of 8.

See Also:
getOverallStatus(), Constant Field Values

OVERALL_STATUS_WAITING_TO_START

public static final int OVERALL_STATUS_WAITING_TO_START
Constant representing a value of 9.

See Also:
getOverallStatus(), Constant Field Values

OVERALL_STATUS_PRINTING

public static final int OVERALL_STATUS_PRINTING
Constant representing a value of 10.

See Also:
getOverallStatus(), Constant Field Values

OVERALL_STATUS_WAITING_FOR_PRINTER_OUTPUT

public static final int OVERALL_STATUS_WAITING_FOR_PRINTER_OUTPUT
Constant representing a value of 11.

See Also:
getOverallStatus(), Constant Field Values

OVERALL_STATUS_CONNECT_PENDING

public static final int OVERALL_STATUS_CONNECT_PENDING
Constant representing a value of 12.

See Also:
getOverallStatus(), Constant Field Values

OVERALL_STATUS_POWERED_OFF

public static final int OVERALL_STATUS_POWERED_OFF
Constant representing a value of 13.

See Also:
getOverallStatus(), Constant Field Values

OVERALL_STATUS_UNUSABLE

public static final int OVERALL_STATUS_UNUSABLE
Constant representing a value of 14.

See Also:
getOverallStatus(), Constant Field Values

OVERALL_STATUS_BEING_SERVICED

public static final int OVERALL_STATUS_BEING_SERVICED
Constant representing a value of 15.

See Also:
getOverallStatus(), Constant Field Values

OVERALL_STATUS_UNKNOWN

public static final int OVERALL_STATUS_UNKNOWN
Constant representing a value of 999.

See Also:
getOverallStatus(), Constant Field Values

PENDING_STATUS_NONE

public static final int PENDING_STATUS_NONE
Constant representing an EBCDIC value of "N".

See Also:
getEndPendingStatus(), getHoldPendingStatus(), Constant Field Values

PENDING_STATUS_IMMEDIATE

public static final int PENDING_STATUS_IMMEDIATE
Constant representing an EBCDIC value of "I".

See Also:
getEndPendingStatus(), getHoldPendingStatus(), Constant Field Values

PENDING_STATUS_CONTROLLED

public static final int PENDING_STATUS_CONTROLLED
Constant representing an EBCDIC value of "C".

See Also:
getEndPendingStatus(), getHoldPendingStatus(), Constant Field Values

PENDING_STATUS_PAGE_END

public static final int PENDING_STATUS_PAGE_END
Constant representing an EBCDIC value of "P".

See Also:
getEndPendingStatus(), getHoldPendingStatus(), Constant Field Values

PRINTER_DEVICE_TYPE_SCS

public static final java.lang.String PRINTER_DEVICE_TYPE_SCS
Constant representing a value of "*SCS".

See Also:
getPrinterDeviceType(), Constant Field Values

PRINTER_DEVICE_TYPE_IPDS

public static final java.lang.String PRINTER_DEVICE_TYPE_IPDS
Constant representing a value of "*IPDS".

See Also:
getPrinterDeviceType(), Constant Field Values

WRITER_STATUS_STARTED

public static final int WRITER_STATUS_STARTED
Constant representing a value of 1.

See Also:
getWriterStatus(), Constant Field Values

WRITER_STATUS_ENDED

public static final int WRITER_STATUS_ENDED
Constant representing a value of 2.

See Also:
getWriterStatus(), Constant Field Values

WRITER_STATUS_ON_JOB_QUEUE

public static final int WRITER_STATUS_ON_JOB_QUEUE
Constant representing a value of 3.

See Also:
getWriterStatus(), Constant Field Values

WRITER_STATUS_HELD

public static final int WRITER_STATUS_HELD
Constant representing a value of 4.

See Also:
getWriterStatus(), Constant Field Values

WRITER_STATUS_MESSAGE_WAITING

public static final int WRITER_STATUS_MESSAGE_WAITING
Constant representing a value of 5.

See Also:
getWriterStatus(), Constant Field Values

WRITER_TIME_ALL_DONE

public static final java.lang.String WRITER_TIME_ALL_DONE
Constant representing a value of "*NORDYF".

See Also:
getWriterChangeTime(), getWriterEndTime(), Constant Field Values

WRITER_TIME_CURRENT_DONE

public static final java.lang.String WRITER_TIME_CURRENT_DONE
Constant representing a value of "*FILEEND".

See Also:
getWriterChangeTime(), getWriterEndTime(), Constant Field Values

WRITER_TIME_WAIT

public static final java.lang.String WRITER_TIME_WAIT
Constant representing a value of "*NO".

See Also:
getWriterChangeTime(), getWriterEndTime(), Constant Field Values

WRITER_TIME_NONE

public static final java.lang.String WRITER_TIME_NONE
Constant representing a value of "".

See Also:
getWriterChangeTime(), getWriterEndTime(), Constant Field Values

WRITING_STATUS_WRITING

public static final int WRITING_STATUS_WRITING
Constant representing an EBCDIC value of "Y".

See Also:
getWritingStatus(), Constant Field Values

WRITING_STATUS_NOT_WRITING

public static final int WRITING_STATUS_NOT_WRITING
Constant representing an EBCDIC value of "N".

See Also:
getWritingStatus(), Constant Field Values

WRITING_STATUS_FILE_SEPARATORS

public static final int WRITING_STATUS_FILE_SEPARATORS
Constant representing an EBCDIC value of "S".

See Also:
getWritingStatus(), Constant Field Values
Constructor Detail

ISeriesPrinter

public ISeriesPrinter(AS400 system,
                      java.lang.String name)
Constructs an ISeriesPrinter object with the specified name. If a printer with the specified name does not exist on the specified system, an exception will be thrown when refresh() is called, either implicitly or explicitly.

Parameters:
system - The system.
name - The name of the printer.
Method Detail

allowsDirectPrinting

public boolean allowsDirectPrinting()
                             throws AS400SecurityException,
                                    ErrorCompletingRequestException,
                                    java.io.IOException,
                                    java.lang.InterruptedException,
                                    ObjectDoesNotExistException
Returns whether or not the printer writer allows the printer to be allocated to a job that prints directly to the printer.

Returns:
true if direct printing is allowed; false if it is not allowed.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

equals

public boolean equals(java.lang.Object obj)
Returns whether or not the specified object is equal to this object.

Overrides:
equals in class java.lang.Object
Returns:
true if the specified object is an ISeriesPrinter and the following contract is true: 
   obj.getSystem().equals(this.getSystem()) &&
   obj.getName().equals(this.getName())
Otherwise, false is returned.

getCopiesLeft

public int getCopiesLeft()
                  throws AS400SecurityException,
                         ErrorCompletingRequestException,
                         java.io.IOException,
                         java.lang.InterruptedException,
                         ObjectDoesNotExistException
Returns the number of copies left to be printed.

Returns:
The number of copies left, or 0 if no file is printing.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

getDescription

public java.lang.String getDescription()
                                throws AS400SecurityException,
                                       ErrorCompletingRequestException,
                                       java.io.IOException,
                                       java.lang.InterruptedException,
                                       ObjectDoesNotExistException
Returns the text description of the printer device.

Returns:
The text description.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

getDeviceStatus

public int getDeviceStatus()
                    throws AS400SecurityException,
                           ErrorCompletingRequestException,
                           java.io.IOException,
                           java.lang.InterruptedException,
                           ObjectDoesNotExistException
Returns the status of the printer device. Possible values are:

Returns:
The printer device status.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

getEndPendingStatus

public int getEndPendingStatus()
                        throws AS400SecurityException,
                               ErrorCompletingRequestException,
                               java.io.IOException,
                               java.lang.InterruptedException,
                               ObjectDoesNotExistException
Returns whether an End Writer (ENDWTR) command has been issued for this writer. Possible values are:

Returns:
The pending status.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

getFormAlignmentMessageTime

public java.lang.String getFormAlignmentMessageTime()
                                             throws AS400SecurityException,
                                                    ErrorCompletingRequestException,
                                                    java.io.IOException,
                                                    java.lang.InterruptedException,
                                                    ObjectDoesNotExistException
Returns the time at which the forms alignment message will be sent. Possible values are:

Returns:
The form alignment message setting.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

getFormType

public java.lang.String getFormType()
                             throws AS400SecurityException,
                                    ErrorCompletingRequestException,
                                    java.io.IOException,
                                    java.lang.InterruptedException,
                                    ObjectDoesNotExistException
Returns the type of form being used to print the spooled file. Possible values are:

Returns:
The form type.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

getHoldPendingStatus

public int getHoldPendingStatus()
                         throws AS400SecurityException,
                                ErrorCompletingRequestException,
                                java.io.IOException,
                                java.lang.InterruptedException,
                                ObjectDoesNotExistException
Returns whether a Hold Writer (HLDWTR) command has been issued for this writer. Possible values are:

Returns:
The pending status.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

getMessageOption

public java.lang.String getMessageOption()
                                  throws AS400SecurityException,
                                         ErrorCompletingRequestException,
                                         java.io.IOException,
                                         java.lang.InterruptedException,
                                         ObjectDoesNotExistException
Returns the message option for sending a message to the message queue when this form is finished. Possible values are:

Returns:
The message option.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

getMessageQueue

public java.lang.String getMessageQueue()
                                 throws AS400SecurityException,
                                        ErrorCompletingRequestException,
                                        java.io.IOException,
                                        java.lang.InterruptedException,
                                        ObjectDoesNotExistException
Returns the fully qualified integrated file system pathname of the message queue associated with this printer.

Returns:
The message queue path, or "" if there is no associated message queue.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException
See Also:
MessageQueue

getName

public java.lang.String getName()
Returns the name of this printer.

Returns:
The name.
See Also:
ISeriesPrinter(com.ibm.as400.access.AS400, java.lang.String)

getNumberOfSeparators

public int getNumberOfSeparators()
                          throws AS400SecurityException,
                                 ErrorCompletingRequestException,
                                 java.io.IOException,
                                 java.lang.InterruptedException,
                                 ObjectDoesNotExistException
Returns the number of separator pages to be printed.

Returns:
The number of separators, or -1 if the number of separator pages is specified by each file.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

getOutputQueue

public java.lang.String getOutputQueue()
                                throws AS400SecurityException,
                                       ErrorCompletingRequestException,
                                       java.io.IOException,
                                       java.lang.InterruptedException,
                                       ObjectDoesNotExistException
Returns the fully qualified integrated file system pathname of the output queue associated with this printer from which spooled files are selected for printing.

Returns:
The output queue path, or "" if there is no associated output queue.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException
See Also:
OutputQueue

getOutputQueueStatus

public int getOutputQueueStatus()
                         throws AS400SecurityException,
                                ErrorCompletingRequestException,
                                java.io.IOException,
                                java.lang.InterruptedException,
                                ObjectDoesNotExistException
Returns the status of the output queue from which spooled files are being selected for printing. Possible values are:

Returns:
The output queue status.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

getOverallStatus

public int getOverallStatus()
                     throws AS400SecurityException,
                            ErrorCompletingRequestException,
                            java.io.IOException,
                            java.lang.InterruptedException,
                            ObjectDoesNotExistException
Returns the overall status of the logical printer. Possible values are:

Returns:
The overall status.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

getPageBeingWritten

public int getPageBeingWritten()
                        throws AS400SecurityException,
                               ErrorCompletingRequestException,
                               java.io.IOException,
                               java.lang.InterruptedException,
                               ObjectDoesNotExistException
Returns the page number in the spooled file that is currently being processed by the writer. The page number returned may be lower or higher than the actual page number being printed because of buffering done by the system.

Returns:
The page number being written, or 0 if no spooled file is printing.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

getPendingFormType

public java.lang.String getPendingFormType()
                                    throws AS400SecurityException,
                                           ErrorCompletingRequestException,
                                           java.io.IOException,
                                           java.lang.InterruptedException,
                                           ObjectDoesNotExistException
Returns the name of the next form type to be printed. Possible values are:

Returns:
The form type.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException
See Also:
getFormType()

getPendingMessageOption

public java.lang.String getPendingMessageOption()
                                         throws AS400SecurityException,
                                                ErrorCompletingRequestException,
                                                java.io.IOException,
                                                java.lang.InterruptedException,
                                                ObjectDoesNotExistException
Returns the message option for sending a message to the message queue when the next form type is finished. Possible values are:

Returns:
The message option.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException
See Also:
getMessageOption()

getPendingNumberOfSeparators

public int getPendingNumberOfSeparators()
                                 throws AS400SecurityException,
                                        ErrorCompletingRequestException,
                                        java.io.IOException,
                                        java.lang.InterruptedException,
                                        ObjectDoesNotExistException
Returns the next number of separator pages to be printed when the change to the writer takes place.

Returns:
The number of separators, or -1 if the number of separator pages is specified by each file, or -10 if there is no pending change to the writer.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException
See Also:
getNumberOfSeparators()

getPendingOutputQueue

public java.lang.String getPendingOutputQueue()
                                       throws AS400SecurityException,
                                              ErrorCompletingRequestException,
                                              java.io.IOException,
                                              java.lang.InterruptedException,
                                              ObjectDoesNotExistException
Returns the fully qualified integrated file system pathname of the next output queue.

Returns:
The output queue path, or "" if no changes have been made to the writer.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException
See Also:
getOutputQueue(), OutputQueue

getPendingSeparatorDrawer

public int getPendingSeparatorDrawer()
                              throws AS400SecurityException,
                                     ErrorCompletingRequestException,
                                     java.io.IOException,
                                     java.lang.InterruptedException,
                                     ObjectDoesNotExistException
Returns the drawer from which to take the separator pages if there is a change to the writer. Possible values are:

Returns:
The separator drawer.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException
See Also:
getSeparatorDrawer(), com.ibm.as400.access.config.PrinterDeviceDescription

getPrinterDeviceType

public java.lang.String getPrinterDeviceType()
                                      throws AS400SecurityException,
                                             ErrorCompletingRequestException,
                                             java.io.IOException,
                                             java.lang.InterruptedException,
                                             ObjectDoesNotExistException
Returns the type of printer being used to print the spooled file. Possible values are:

Returns:
The printer device type.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

getSeparatorDrawer

public int getSeparatorDrawer()
                       throws AS400SecurityException,
                              ErrorCompletingRequestException,
                              java.io.IOException,
                              java.lang.InterruptedException,
                              ObjectDoesNotExistException
Returns the drawer from which the job and file separator pages are to be taken. Possible values are:

Returns:
The separator drawer.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException
See Also:
com.ibm.as400.access.config.PrinterDeviceDescription

getSpooledFileCreationDate

public java.util.Date getSpooledFileCreationDate()
                                          throws AS400SecurityException,
                                                 ErrorCompletingRequestException,
                                                 java.io.IOException,
                                                 java.lang.InterruptedException,
                                                 ObjectDoesNotExistException
Returns the date and time the spooled file was created on the system.

Returns:
The spooled file creation date, or null if the iSeries system is not running OS/400 V5R2 or higher.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

getSpooledFileJobName

public java.lang.String getSpooledFileJobName()
                                       throws AS400SecurityException,
                                              ErrorCompletingRequestException,
                                              java.io.IOException,
                                              java.lang.InterruptedException,
                                              ObjectDoesNotExistException
Returns the name of the job that created the spooled file currently being processed by the writer.

Returns:
The job name, or "" if no spooled file is printing.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException
See Also:
Job

getSpooledFileJobNumber

public java.lang.String getSpooledFileJobNumber()
                                         throws AS400SecurityException,
                                                ErrorCompletingRequestException,
                                                java.io.IOException,
                                                java.lang.InterruptedException,
                                                ObjectDoesNotExistException
Returns the number of the job that created the spooled file currently being processed by the writer.

Returns:
The job number, or "" if no spooled file is printing.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException
See Also:
Job

getSpooledFileJobSystem

public java.lang.String getSpooledFileJobSystem()
                                         throws AS400SecurityException,
                                                ErrorCompletingRequestException,
                                                java.io.IOException,
                                                java.lang.InterruptedException,
                                                ObjectDoesNotExistException
Returns the name of the system where the job that created the spooled file ran.

Returns:
The system name, or "" if no spooled file is printing, or null if the iSeries system is not running OS/400 V5R2 or higher.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

getSpooledFileJobUser

public java.lang.String getSpooledFileJobUser()
                                       throws AS400SecurityException,
                                              ErrorCompletingRequestException,
                                              java.io.IOException,
                                              java.lang.InterruptedException,
                                              ObjectDoesNotExistException
Returns the user of the job that created the spooled file currently being processed by the writer.

Returns:
The user name, or "" if no spooled file is printing.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException
See Also:
Job, User

getSpooledFileName

public java.lang.String getSpooledFileName()
                                    throws AS400SecurityException,
                                           ErrorCompletingRequestException,
                                           java.io.IOException,
                                           java.lang.InterruptedException,
                                           ObjectDoesNotExistException
Returns the name of the spooled file currently being processed by the writer.

Returns:
The spooled file name, or "" if no spooled file is printing.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

getSpooledFileNumber

public int getSpooledFileNumber()
                         throws AS400SecurityException,
                                ErrorCompletingRequestException,
                                java.io.IOException,
                                java.lang.InterruptedException,
                                ObjectDoesNotExistException
Returns the number of the spooled file currently being processed by the writer.

Returns:
The spooled file number, or 0 if no spooled file is printing.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

getStarterUser

public java.lang.String getStarterUser()
                                throws AS400SecurityException,
                                       ErrorCompletingRequestException,
                                       java.io.IOException,
                                       java.lang.InterruptedException,
                                       ObjectDoesNotExistException
Returns the name of the user that started the writer.

Returns:
The user name.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException
See Also:
User

getSystem

public AS400 getSystem()
Returns the system.

Returns:
The system.
See Also:
ISeriesPrinter(com.ibm.as400.access.AS400, java.lang.String)

getTotalCopies

public int getTotalCopies()
                   throws AS400SecurityException,
                          ErrorCompletingRequestException,
                          java.io.IOException,
                          java.lang.InterruptedException,
                          ObjectDoesNotExistException
Returns the total number of copies to be printed.

Returns:
The number of copies.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

getTotalPages

public int getTotalPages()
                  throws AS400SecurityException,
                         ErrorCompletingRequestException,
                         java.io.IOException,
                         java.lang.InterruptedException,
                         ObjectDoesNotExistException
Returns the total number of pages in the spooled file.

Returns:
The number of pages, or 0 if no spooled file is printing.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

getWriterChangeTime

public java.lang.String getWriterChangeTime()
                                     throws AS400SecurityException,
                                            ErrorCompletingRequestException,
                                            java.io.IOException,
                                            java.lang.InterruptedException,
                                            ObjectDoesNotExistException
Returns the time at which the pending changes to the writer take effect. Possible values are:

Returns:
The writer change setting.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

getWriterEndTime

public java.lang.String getWriterEndTime()
                                  throws AS400SecurityException,
                                         ErrorCompletingRequestException,
                                         java.io.IOException,
                                         java.lang.InterruptedException,
                                         ObjectDoesNotExistException
Returns when to end the writer if it is to end automatically. Possible values are:

Returns:
The writer end time setting.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

getWriterJobName

public java.lang.String getWriterJobName()
                                  throws AS400SecurityException,
                                         ErrorCompletingRequestException,
                                         java.io.IOException,
                                         java.lang.InterruptedException,
                                         ObjectDoesNotExistException
Returns the job name of the printer writer.

Returns:
The job name.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException
See Also:
getWriterJobNumber(), getWriterJobUser(), Job

getWriterJobNumber

public java.lang.String getWriterJobNumber()
                                    throws AS400SecurityException,
                                           ErrorCompletingRequestException,
                                           java.io.IOException,
                                           java.lang.InterruptedException,
                                           ObjectDoesNotExistException
Returns the job number of the printer writer.

Returns:
The job number.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException
See Also:
getWriterJobName(), getWriterJobUser(), Job

getWriterJobUser

public java.lang.String getWriterJobUser()
                                  throws AS400SecurityException,
                                         ErrorCompletingRequestException,
                                         java.io.IOException,
                                         java.lang.InterruptedException,
                                         ObjectDoesNotExistException
Returns the name of the system user.

Returns:
The user name.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException
See Also:
getWriterJobName(), getWriterJobNumber(), Job, User

getWriterMessageKey

public byte[] getWriterMessageKey()
                           throws AS400SecurityException,
                                  ErrorCompletingRequestException,
                                  java.io.IOException,
                                  java.lang.InterruptedException,
                                  ObjectDoesNotExistException
Returns the key to the message that the writer is waiting for a reply.

Returns:
The 4-byte message key, which will consist of all 0's if the writer is not waiting for a reply to an inquiry message.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

getWriterStatus

public int getWriterStatus()
                    throws AS400SecurityException,
                           ErrorCompletingRequestException,
                           java.io.IOException,
                           java.lang.InterruptedException,
                           ObjectDoesNotExistException
Returns the status of the writer for this printer. Possible values are:

Returns:
The writer status.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

getWritingStatus

public int getWritingStatus()
                     throws AS400SecurityException,
                            ErrorCompletingRequestException,
                            java.io.IOException,
                            java.lang.InterruptedException,
                            ObjectDoesNotExistException
Returns whether the printer writer is in writing status. Possible values are:

Returns:
The writing status.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

hashCode

public int hashCode()
Returns the hash code value for the name of this ISeriesPrinter object.

Overrides:
hashCode in class java.lang.Object
Returns:
The hash code.

isBetweenCopies

public boolean isBetweenCopies()
                        throws AS400SecurityException,
                               ErrorCompletingRequestException,
                               java.io.IOException,
                               java.lang.InterruptedException,
                               ObjectDoesNotExistException
Returns whether the writer is between copies of a multiple copy spooled file.

Returns:
true if the writer is between copies, false otherwise.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

isBetweenFiles

public boolean isBetweenFiles()
                       throws AS400SecurityException,
                              ErrorCompletingRequestException,
                              java.io.IOException,
                              java.lang.InterruptedException,
                              ObjectDoesNotExistException
Returns whether the writer is between spooled files.

Returns:
true if the writer is between spooled files, false otherwise.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

isHeld

public boolean isHeld()
               throws AS400SecurityException,
                      ErrorCompletingRequestException,
                      java.io.IOException,
                      java.lang.InterruptedException,
                      ObjectDoesNotExistException
Returns whether the writer is held.

Returns:
true if the writer is held, false otherwise.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

isOnJobQueue

public boolean isOnJobQueue()
                     throws AS400SecurityException,
                            ErrorCompletingRequestException,
                            java.io.IOException,
                            java.lang.InterruptedException,
                            ObjectDoesNotExistException
Returns whether the writer is on a job queue and is not currently running.

Returns:
true if the writer is on a job queue, false otherwise.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

isPublishedInNetworkDirectory

public boolean isPublishedInNetworkDirectory()
                                      throws AS400SecurityException,
                                             ErrorCompletingRequestException,
                                             java.io.IOException,
                                             java.lang.InterruptedException,
                                             ObjectDoesNotExistException
Returns whether the printer is published in the network directory.

Returns:
true if the printer is published, false otherwise.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

isWaitingForData

public boolean isWaitingForData()
                         throws AS400SecurityException,
                                ErrorCompletingRequestException,
                                java.io.IOException,
                                java.lang.InterruptedException,
                                ObjectDoesNotExistException
Returns whether the writer has written all the data currently in the spooled file and is waiting for more data.

Returns:
true if the writer is waiting for more data when the writer is producing an open spooled file with SCHEDULE(*IMMED) specified; false otherwise.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

isWaitingForDevice

public boolean isWaitingForDevice()
                           throws AS400SecurityException,
                                  ErrorCompletingRequestException,
                                  java.io.IOException,
                                  java.lang.InterruptedException,
                                  ObjectDoesNotExistException
Returns whether the writer is waiting to get the device from a job that is printing directly to the printer.

Returns:
true if the writer is waiting for the device, false otherwise.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

isWaitingForMessage

public boolean isWaitingForMessage()
                            throws AS400SecurityException,
                                   ErrorCompletingRequestException,
                                   java.io.IOException,
                                   java.lang.InterruptedException,
                                   ObjectDoesNotExistException
Returns whether the writer is waiting for a reply to an inquiry message.

Returns:
true if the writer is waiting for a reply, false otherwise.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

isWriterStarted

public boolean isWriterStarted()
                        throws AS400SecurityException,
                               ErrorCompletingRequestException,
                               java.io.IOException,
                               java.lang.InterruptedException,
                               ObjectDoesNotExistException
Returns whether the writer is started for this printer.

Returns:
true if the writer is started, false otherwise.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

refresh

public void refresh()
             throws AS400SecurityException,
                    ErrorCompletingRequestException,
                    java.io.IOException,
                    java.lang.InterruptedException,
                    ObjectDoesNotExistException
Refreshes the information about this printer object from the system. This method is implicitly called by the getXXX() methods on this class the first time. Call this method explicitly to refresh the information returned by the various getXXX() methods.

AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException

supportsAFP

public boolean supportsAFP()
                    throws AS400SecurityException,
                           ErrorCompletingRequestException,
                           java.io.IOException,
                           java.lang.InterruptedException,
                           ObjectDoesNotExistException
Returns whether the printer supports Advanced Function Printing.

Returns:
true if Advanced Function Printing is supported, false otherwise.
AS400SecurityException
ErrorCompletingRequestException
java.io.IOException
java.lang.InterruptedException
ObjectDoesNotExistException
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD