com.ibm.as400.resource
Class RPrinter

java.lang.Object
  |
  +--com.ibm.as400.resource.Resource
        |
        +--com.ibm.as400.resource.ChangeableResource
              |
              +--com.ibm.as400.resource.RPrinter
All Implemented Interfaces:
java.io.Serializable

public class RPrinter
extends ChangeableResource

The RPrinter class represents an AS/400 printer.

The following attribute IDs are supported:

Use any of these attribute IDs with getAttributeValue() and setAttributeValue() to access the attribute values for an RPrinter.

// Create an RPrinter object to refer to a specific printer.
AS400 system = new AS400("MYSYSTEM", "MYUSERID", "MYPASSWORD");
RPrinter printer = new RPrinter(system, "PRT0506");

// Get the text description. String textDescription = (String)printer.getAttributeValue(RPrinter.TEXT_DESCRIPTION);
// Set the form type for a printer to all. printer.setAttributeValue(RPrinter.FORM_TYPE, RPrinter.FORM_TYPE_ALL);
// Commit the attribute change. printer.commitAttributeChanges();

See Also:
RPrinterList, Serialized Form

Field Summary
static java.lang.String ADVANCED_FUNCTION_PRINTING
          Attribute ID for advanced function printing.
static java.lang.String ALIGN_FORMS
          Attribute ID for align forms.
static java.lang.String ALIGN_FORMS_FILE
          Attribute value indicating that control of the page alignment is specified by each file.
static java.lang.String ALIGN_FORMS_WRITER
          Attribute value indicating that the writer determines when the forms alignment message is sent.
static java.lang.String ALLOW_DIRECT_PRINTING
          Attribute ID for allow direct printing.
static java.lang.String AUTOMATICALLY_END_WRITER
          Attribute ID for automatically end writer.
static java.lang.String BETWEEN_COPIES_STATUS
          Attribute ID for between copies status.
static java.lang.String BETWEEN_FILES_STATUS
          Attribute ID for between files status.
static java.lang.String CHANGES_TAKE_EFFECT
          Attribute ID for changes take effect.
static java.lang.String COPIES_LEFT_TO_PRODUCE
          Attribute ID for copies left to produce.
static java.lang.String DEVICE_NAME
          Attribute ID for device name.
static java.lang.String DEVICE_STATUS
          Attribute ID for device status.
static java.lang.String DEVICE_TYPE
          Attribute ID for device type.
static java.lang.String END_PENDING_STATUS
          Attribute ID for end pending status.
static java.lang.String FORM_TYPE
          Attribute ID for form type.
static java.lang.String FORM_TYPE_ALL
          Attribute value indicating that the writer is started with the option to print all spooled files of any form type.
static java.lang.String FORM_TYPE_FORMS
          Attribute value indicating that the writer is started with the option to print all spooled files with the same form type before using a different form type.
static java.lang.String FORM_TYPE_STANDARD
          Attribute value indicating that the writer is started with the option to print all spooled files with a form type of *STD.
static java.lang.String HELD_STATUS
          Attribute ID for held status.
static java.lang.String HOLD_PENDING_STATUS
          Attribute ID for hold pending status.
static java.lang.String JOB_NAME
          Attribute ID for job name.
static java.lang.String JOB_NUMBER
          Attribute ID for job number.
static java.lang.String JOB_QUEUE_STATUS
          Attribute ID for job queue status.
static java.lang.String MESSAGE_KEY
          Attribute ID for message key.
static java.lang.String MESSAGE_OPTION
          Attribute ID for message option.
static java.lang.String MESSAGE_OPTION_INFORMATIONAL_MESSAGE
          Attribute value indicating that an informational message is sent to the message queue when this form is finished.
static java.lang.String MESSAGE_OPTION_INQUIRY_MESSAGE
          Attribute value indicating that an inquiry message is sent to the message queue when this form is finished.
static java.lang.String MESSAGE_OPTION_MESSAGE
          Attribute value indicating that a message is sent to the message queue when this form is finished.
static java.lang.String MESSAGE_OPTION_NO_MESSAGE
          Attribute value indicating that no message is sent to the message queue when this form is finished.
static java.lang.String MESSAGE_QUEUE
          Attribute ID for message queue.
static java.lang.String NEXT_FILE_SEPARATORS
          Attribute ID for next file separators.
static java.lang.String NEXT_FORM_TYPE
          Attribute ID for next form type.
static java.lang.String NEXT_MESSAGE_OPTION
          Attribute ID for next message option.
static java.lang.String NEXT_OUTPUT_QUEUE
          Attribute ID for next output queue.
static java.lang.String NEXT_SEPARATOR_DRAWER
          Attribute ID for next separator drawer.
static java.lang.String NUMBER_OF_SEPARATORS
          Attribute ID for number of separators.
static java.lang.String OPERATION_FILE_END
          Attribute value that indicates that an operation is effective when the current spooled file has been printed.
static java.lang.String OPERATION_NO_FILES_READY
          Attribute value that indicates that an operation is effective when there are no files are ready to print on the output queue from which the writer is selected files.
static java.lang.String OPERATION_NONE
          Attribute value that indicates that an operation is not effective.
static java.lang.String OUTPUT_QUEUE
          Attribute ID for output queue.
static java.lang.String OUTPUT_QUEUE_STATUS
          Attribute ID for output queue status.
static java.lang.String OVERALL_STATUS
          Attribute ID for overall status.
static java.lang.String PAGE_BEING_WRITTEN
          Attribute ID for page being written.
static java.lang.String PENDING_STATUS_CONTROLLED
          Attribute value for status indicating that an operation is pending and will take effect after the current copy of the spooled file has been printed.
static java.lang.String PENDING_STATUS_IMMEDIATE
          Attribute value for status indicating that an operation is pending and will take effect as soon as its output buffers are empty.
static java.lang.String PENDING_STATUS_NONE
          Attribute value for status indicating that no operation is pending.
static java.lang.String PENDING_STATUS_PAGE_END
          Attribute value for status indicating that an operation is pending and will take effect at the end of the page.
static java.lang.String PUBLISHED_STATUS
          Attribute ID for published status.
static java.lang.String SEPARATOR_DRAWER
          Attribute ID for separator drawer.
static java.lang.Integer SEPARATOR_PAGE_DEVICE
          Attribute value that indicates that separator page information is set in the device description.
static java.lang.Integer SEPARATOR_PAGE_FILE
          Attribute value that indicates that separator page information is set in the file.
static java.lang.Integer SEPARATOR_PAGE_NONE
          Attribute value that indicates that there is no separator page.
static java.lang.String SPOOLED_FILE_NAME
          Attribute ID for spooled file name.
static java.lang.String SPOOLED_FILE_NUMBER
          Attribute ID for spooled file number.
static java.lang.String STARTED_BY_USER
          Attribute ID for started by user.
static java.lang.String STATUS_HELD
          Attribute value for status indicating held.
static java.lang.String STATUS_RELEASED
          Attribute value for status indicating released.
static java.lang.String TEXT_DESCRIPTION
          Attribute ID for text description.
static java.lang.String TOTAL_COPIES
          Attribute ID for total copies.
static java.lang.String TOTAL_PAGES
          Attribute ID for total pages.
static java.lang.String USER_NAME
          Attribute ID for user name.
static java.lang.String WAITING_FOR_DATA_STATUS
          Attribute ID for waiting for data status.
static java.lang.String WAITING_FOR_DEVICE_STATUS
          Attribute ID for waiting for device status.
static java.lang.String WAITING_FOR_MESSAGE_STATUS
          Attribute ID for waiting for message status.
static java.lang.String WRITER_JOB_NAME
          Attribute ID for writer job name.
static java.lang.String WRITER_JOB_NUMBER
          Attribute ID for writer job number.
static java.lang.String WRITER_JOB_USER_NAME
          Attribute ID for writer job user name.
static java.lang.String WRITER_STARTED
          Attribute ID for waiting for device status.
static java.lang.String WRITER_STATUS
          Attribute ID for writer status.
static byte[] WRITER_STATUS_ENDED
          Attribute value indicating that the writer is ended.
static byte[] WRITER_STATUS_HELD
          Attribute value indicating that the writer is held.
static byte[] WRITER_STATUS_JOB_QUEUE
          Attribute value indicating that the writer is on a job queue.
static byte[] WRITER_STATUS_MESSAGE_WAITING
          Attribute value indicating that the writer is waiting on a message.
static byte[] WRITER_STATUS_STARTED
          Attribute value indicating that the writer is started.
static java.lang.String WRITING_STATUS
          Attribute ID for writing status.
static java.lang.String WRITING_STATUS_NO
          Attribute value indicating that the writer is not in writing status.
static java.lang.String WRITING_STATUS_SEPARATORS
          Attribute value indicating that the writer is writing the file separators.
static java.lang.String WRITING_STATUS_YES
          Attribute value indicating that the writer is in writing status.
 
Constructor Summary
RPrinter()
          Constructs an RPrinter object.
RPrinter(AS400 system, java.lang.String name)
          Constructs an RPrinter object.
 
Method Summary
protected  void commitAttributeChanges(java.lang.Object[] attributeIDs, java.lang.Object[] values, int[] bidiStringTypes)
          Commits the specified attribute changes.
protected  void establishConnection()
          Establishes the connection to the AS/400.
protected  void freezeProperties()
          Freezes any property changes.
 java.lang.Object getAttributeUnchangedValue(java.lang.Object attributeID, int bidiStringType)
          Returns the unchanged value of an attribute.
 java.lang.String getName()
          Returns the printer device name.
protected  boolean isBidiEnabled()
          Indicates if this resource is enabled for bidirectional character conversion.
 void refreshAttributeValues()
          Refreshes the values for all attributes.
 void setName(java.lang.String name)
          Sets the printer device name.
 
Methods inherited from class com.ibm.as400.resource.ChangeableResource
cancelAttributeChanges, commitAttributeChanges, commitAttributeChanges, fireAttributeChangesCanceled, fireAttributeChangesCommitted, fireAttributeValueChanged, fireResourceCreated, fireResourceDeleted, getAttributeUnchangedValue, getAttributeValue, getAttributeValue, hasUncommittedAttributeChanges, initializeAttributeValue, setAttributeValue, setAttributeValue
 
Methods inherited from class com.ibm.as400.resource.Resource
addActiveStatusListener, addPropertyChangeListener, addResourceListener, addVetoableChangeListener, arePropertiesFrozen, equals, fireAttributeValuesRefreshed, fireBusy, fireIdle, firePropertyChange, fireVetoableChange, getAttributeMetaData, getAttributeMetaData, getPresentation, getResourceKey, getSystem, isConnectionEstablished, removeActiveStatusListener, removePropertyChangeListener, removeResourceListener, removeVetoableChangeListener, setPresentation, setResourceKey, setSystem, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

OPERATION_FILE_END

public static final java.lang.String OPERATION_FILE_END
Attribute value that indicates that an operation is effective when the current spooled file has been printed.

OPERATION_NO_FILES_READY

public static final java.lang.String OPERATION_NO_FILES_READY
Attribute value that indicates that an operation is effective when there are no files are ready to print on the output queue from which the writer is selected files.

OPERATION_NONE

public static final java.lang.String OPERATION_NONE
Attribute value that indicates that an operation is not effective.

PENDING_STATUS_CONTROLLED

public static final java.lang.String PENDING_STATUS_CONTROLLED
Attribute value for status indicating that an operation is pending and will take effect after the current copy of the spooled file has been printed.

PENDING_STATUS_IMMEDIATE

public static final java.lang.String PENDING_STATUS_IMMEDIATE
Attribute value for status indicating that an operation is pending and will take effect as soon as its output buffers are empty.

PENDING_STATUS_NONE

public static final java.lang.String PENDING_STATUS_NONE
Attribute value for status indicating that no operation is pending.

PENDING_STATUS_PAGE_END

public static final java.lang.String PENDING_STATUS_PAGE_END
Attribute value for status indicating that an operation is pending and will take effect at the end of the page.

SEPARATOR_PAGE_DEVICE

public static final java.lang.Integer SEPARATOR_PAGE_DEVICE
Attribute value that indicates that separator page information is set in the device description.

SEPARATOR_PAGE_FILE

public static final java.lang.Integer SEPARATOR_PAGE_FILE
Attribute value that indicates that separator page information is set in the file.

SEPARATOR_PAGE_NONE

public static final java.lang.Integer SEPARATOR_PAGE_NONE
Attribute value that indicates that there is no separator page.

STATUS_HELD

public static final java.lang.String STATUS_HELD
Attribute value for status indicating held.

STATUS_RELEASED

public static final java.lang.String STATUS_RELEASED
Attribute value for status indicating released.

ADVANCED_FUNCTION_PRINTING

public static final java.lang.String ADVANCED_FUNCTION_PRINTING
Attribute ID for advanced function printing. This identifies a read-only Boolean attribute, which indicates whether the printer supports Advanced Function Printing.

ALIGN_FORMS

public static final java.lang.String ALIGN_FORMS
Attribute ID for align forms. This identifies a read-only String attribute, which represents the time at which the forms alignment message will be sent. Possible values are:

ALIGN_FORMS_WRITER

public static final java.lang.String ALIGN_FORMS_WRITER
Attribute value indicating that the writer determines when the forms alignment message is sent.
See Also:
ALIGN_FORMS

ALIGN_FORMS_FILE

public static final java.lang.String ALIGN_FORMS_FILE
Attribute value indicating that control of the page alignment is specified by each file.
See Also:
ALIGN_FORMS

ALLOW_DIRECT_PRINTING

public static final java.lang.String ALLOW_DIRECT_PRINTING
Attribute ID for allow direct printing. This identifies a read-only Boolean attribute, which indicates whether the printer writer allows the printer to be allocated to a job that prints directly to a printer.

AUTOMATICALLY_END_WRITER

public static final java.lang.String AUTOMATICALLY_END_WRITER
Attribute ID for automatically end writer. This identifies a read-only String attribute, which represents when to end the writer if it is to end automatically. Possible values are:

BETWEEN_COPIES_STATUS

public static final java.lang.String BETWEEN_COPIES_STATUS
Attribute ID for between copies status. This identifies a read-only Boolean attribute, which indicates whether the writer is between copies of a multiple copy spooled file.

BETWEEN_FILES_STATUS

public static final java.lang.String BETWEEN_FILES_STATUS
Attribute ID for between files status. This identifies a read-only Boolean attribute, which indicates whether the writer is between spooled files.

CHANGES_TAKE_EFFECT

public static final java.lang.String CHANGES_TAKE_EFFECT
Attribute ID for changes take effect. This identifies a String attribute, which represents the time at which the pending changes to the writer take effect. Possible values are:

COPIES_LEFT_TO_PRODUCE

public static final java.lang.String COPIES_LEFT_TO_PRODUCE
Attribute ID for copies left to produce. This identifies a read-only Integer attribute, which represents the number of copies left to be printed, or 0 when no file is printing.

DEVICE_NAME

public static final java.lang.String DEVICE_NAME
Attribute ID for device name. This identifies a read-only String attribute, which represents the name of the printer device.

DEVICE_STATUS

public static final java.lang.String DEVICE_STATUS
Attribute ID for device status. This identifies a read-only Integer attribute, which represents the status of the printer device.

DEVICE_TYPE

public static final java.lang.String DEVICE_TYPE
Attribute ID for device type. This identifies a read-only String attribute, which represents the type of the printer.

END_PENDING_STATUS

public static final java.lang.String END_PENDING_STATUS
Attribute ID for end pending status. This identifies a read-only String attribute, which represents whether an End Writer (ENDWTR) command has been issued for this writer. Possible values are:

FORM_TYPE

public static final java.lang.String FORM_TYPE
Attribute ID for form type. This identifies a String attribute, which represents the type of form being used to print the spooled file. Possible values are:

FORM_TYPE_ALL

public static final java.lang.String FORM_TYPE_ALL
Attribute value indicating that the writer is started with the option to print all spooled files of any form type.
See Also:
FORM_TYPE

FORM_TYPE_FORMS

public static final java.lang.String FORM_TYPE_FORMS
Attribute value indicating that the writer is started with the option to print all spooled files with the same form type before using a different form type.
See Also:
FORM_TYPE

FORM_TYPE_STANDARD

public static final java.lang.String FORM_TYPE_STANDARD
Attribute value indicating that the writer is started with the option to print all spooled files with a form type of *STD.
See Also:
FORM_TYPE

HELD_STATUS

public static final java.lang.String HELD_STATUS
Attribute ID for held status. This identifies a read-only Boolean attribute, which indicates whether the writer is held.

HOLD_PENDING_STATUS

public static final java.lang.String HOLD_PENDING_STATUS
Attribute ID for hold pending status. This identifies a read-only String attribute, which represents whether an Hold Writer (HLDWTR) command has been issued for this writer. Possible values are:

JOB_NAME

public static final java.lang.String JOB_NAME
Attribute ID for job name. This identifies a read-only String attribute, which represents the name of the job that created the spooled file currently being processed by the writer, or "" when no spooled file is printing.

JOB_NUMBER

public static final java.lang.String JOB_NUMBER
Attribute ID for job number. This identifies a read-only String attribute, which represents the number of the job that created the spooled file currently being processed by the writer, or "" when no spooled file is printing.

JOB_QUEUE_STATUS

public static final java.lang.String JOB_QUEUE_STATUS
Attribute ID for job queue status. This identifies a read-only Boolean attribute, which indicates whether the writer is on a job queue.

MESSAGE_KEY

public static final java.lang.String MESSAGE_KEY
Attribute ID for message key. This identifies a read-only byte array attribute, which represents the message key for the message that the writer is waiting for a reply, or all 0x00's if the writer is not waiting for a reply to an inquiry message.

MESSAGE_OPTION

public static final java.lang.String MESSAGE_OPTION
Attribute ID for message option. This identifies a read-only String attribute, which represents an option for sending a message to the message queue when this form is finished. Possible values are:

MESSAGE_OPTION_MESSAGE

public static final java.lang.String MESSAGE_OPTION_MESSAGE
Attribute value indicating that a message is sent to the message queue when this form is finished.
See Also:
MESSAGE_OPTION

MESSAGE_OPTION_NO_MESSAGE

public static final java.lang.String MESSAGE_OPTION_NO_MESSAGE
Attribute value indicating that no message is sent to the message queue when this form is finished.
See Also:
MESSAGE_OPTION

MESSAGE_OPTION_INFORMATIONAL_MESSAGE

public static final java.lang.String MESSAGE_OPTION_INFORMATIONAL_MESSAGE
Attribute value indicating that an informational message is sent to the message queue when this form is finished.
See Also:
MESSAGE_OPTION

MESSAGE_OPTION_INQUIRY_MESSAGE

public static final java.lang.String MESSAGE_OPTION_INQUIRY_MESSAGE
Attribute value indicating that an inquiry message is sent to the message queue when this form is finished.
See Also:
MESSAGE_OPTION

MESSAGE_QUEUE

public static final java.lang.String MESSAGE_QUEUE
Attribute ID for message queue. This identifies a read-only String attribute, which represents the fully qualified integrated file system path name of the message queue that this writer uses for operational messages.
See Also:
QSYSObjectPathName

NEXT_FILE_SEPARATORS

public static final java.lang.String NEXT_FILE_SEPARATORS
Attribute ID for next file separators. This identifies a read-only Integer attribute, which represents the next number of separator pages to be printed when the change to the writer takes place. Possible values are:

NEXT_FORM_TYPE

public static final java.lang.String NEXT_FORM_TYPE
Attribute ID for next form type. This identifies a read-only String attribute, which represents the next type of form to be printed. Possible values are:

NEXT_MESSAGE_OPTION

public static final java.lang.String NEXT_MESSAGE_OPTION
Attribute ID for next message option. This identifies a read-only String attribute, which represents the option for sending a message to the message queue when the next form type is finished. Possible values are:

NEXT_OUTPUT_QUEUE

public static final java.lang.String NEXT_OUTPUT_QUEUE
Attribute ID for next output queue. This identifies a read-only String attribute, which represents the fully qualified integrated file system path name of the next output queue to be processed, or "" if no changes have been made to the writer.
See Also:
QSYSObjectPathName

NEXT_SEPARATOR_DRAWER

public static final java.lang.String NEXT_SEPARATOR_DRAWER
Attribute ID for next separator drawer. This identifies a read-only Integer attribute, which represents the drawer from which the job and file separator pages are to be taken if there is a change to the writer. Possible values are:

NUMBER_OF_SEPARATORS

public static final java.lang.String NUMBER_OF_SEPARATORS
Attribute ID for number of separators. This identifies a Integer attribute, which represents the number of separator pages to be printed. Possible values are:

OUTPUT_QUEUE

public static final java.lang.String OUTPUT_QUEUE
Attribute ID for output queue. This identifies a String attribute, which represents the fully qualified integrated file system path name of the output queue from which the spooled files are being selected for printing.
See Also:
QSYSObjectPathName

OUTPUT_QUEUE_STATUS

public static final java.lang.String OUTPUT_QUEUE_STATUS
Attribute ID for output queue status. This identifies a read-only String attribute, which represents the status of the output queue from which spooled files are being selected for printing. Possible values are:

OVERALL_STATUS

public static final java.lang.String OVERALL_STATUS
Attribute ID for overall status. This identifies a read-only Integer attribute, which represents the overall status of the logical printer.

PAGE_BEING_WRITTEN

public static final java.lang.String PAGE_BEING_WRITTEN
Attribute ID for page being written. This identifies a read-only Integer attribute, which represents the page number in the spooled file that is currently being processed by the writer, or 0 if no spooled file is printing.

PUBLISHED_STATUS

public static final java.lang.String PUBLISHED_STATUS
Attribute ID for published status. This identifies a read-only Boolean attribute, which indicates whether the printer is published. This attribute is supported only when connecting to servers running OS/400 V5R1 or later.

SEPARATOR_DRAWER

public static final java.lang.String SEPARATOR_DRAWER
Attribute ID for separator drawer. This identifies a Integer attribute, which represents the drawer from which the job and file separator pages are to be taken. Possible values are:

SPOOLED_FILE_NAME

public static final java.lang.String SPOOLED_FILE_NAME
Attribute ID for spooled file name. This identifies a read-only String attribute, which represents the name of the spooled file currently being processed by the writer, or "" if no spooled file is printing.

SPOOLED_FILE_NUMBER

public static final java.lang.String SPOOLED_FILE_NUMBER
Attribute ID for spooled file number. This identifies a read-only Integer attribute, which represents the number of the spooled file currently being processed by the writer, or 0 if no spooled file is printing.

STARTED_BY_USER

public static final java.lang.String STARTED_BY_USER
Attribute ID for started by user. This identifies a read-only String attribute, which represents the name of the user that started the writer.

TEXT_DESCRIPTION

public static final java.lang.String TEXT_DESCRIPTION
Attribute ID for text description. This identifies a String attribute, which represents the text description of the printer device.

TOTAL_COPIES

public static final java.lang.String TOTAL_COPIES
Attribute ID for total copies. This identifies a read-only Integer attribute, which represents the total number of copies to be printed.

TOTAL_PAGES

public static final java.lang.String TOTAL_PAGES
Attribute ID for total pages. This identifies a read-only Integer attribute, which represents the total number of pages in the spooled file, or 0 if no spooled file is printing.

USER_NAME

public static final java.lang.String USER_NAME
Attribute ID for user name. This identifies a read-only String attribute, which represents the name of the user who created the spooled file currently being processed by the writer, or "" if no spooled file is printing.

WAITING_FOR_DATA_STATUS

public static final java.lang.String WAITING_FOR_DATA_STATUS
Attribute ID for waiting for data status. This identifies a read-only Boolean attribute, which indicates whether the writer has written all of the data currently in the spooled file and is waiting for more data.

WAITING_FOR_DEVICE_STATUS

public static final java.lang.String WAITING_FOR_DEVICE_STATUS
Attribute ID for waiting for device status. This identifies a read-only Boolean attribute, which indicates whether the writer is waiting to get the device from a job that is printing directly to the printer.

WAITING_FOR_MESSAGE_STATUS

public static final java.lang.String WAITING_FOR_MESSAGE_STATUS
Attribute ID for waiting for message status. This identifies a read-only Boolean attribute, which indicates whether the writer is waiting for a reply to an inquiry message.

WRITER_JOB_NAME

public static final java.lang.String WRITER_JOB_NAME
Attribute ID for writer job name. This identifies a read-only String attribute, which represents the job name of the printer writer.

WRITER_JOB_NUMBER

public static final java.lang.String WRITER_JOB_NUMBER
Attribute ID for writer job number. This identifies a read-only String attribute, which represents the job number of the printer writer.

WRITER_JOB_USER_NAME

public static final java.lang.String WRITER_JOB_USER_NAME
Attribute ID for writer job user name. This identifies a read-only String attribute, which represents the the name of the system user.

WRITER_STARTED

public static final java.lang.String WRITER_STARTED
Attribute ID for waiting for device status. This identifies a read-only Boolean attribute, which indicates whether a writer is started for this printer.

WRITER_STATUS

public static final java.lang.String WRITER_STATUS
Attribute ID for writer status. This identifies a read-only byte[] attribute, which represents the status of the writer for this printer. Possible values are:

WRITER_STATUS_STARTED

public static final byte[] WRITER_STATUS_STARTED
Attribute value indicating that the writer is started.
See Also:
WRITER_STATUS

WRITER_STATUS_ENDED

public static final byte[] WRITER_STATUS_ENDED
Attribute value indicating that the writer is ended.
See Also:
WRITER_STATUS

WRITER_STATUS_JOB_QUEUE

public static final byte[] WRITER_STATUS_JOB_QUEUE
Attribute value indicating that the writer is on a job queue.
See Also:
WRITER_STATUS

WRITER_STATUS_HELD

public static final byte[] WRITER_STATUS_HELD
Attribute value indicating that the writer is held.
See Also:
WRITER_STATUS

WRITER_STATUS_MESSAGE_WAITING

public static final byte[] WRITER_STATUS_MESSAGE_WAITING
Attribute value indicating that the writer is waiting on a message.
See Also:
WRITER_STATUS

WRITING_STATUS

public static final java.lang.String WRITING_STATUS
Attribute ID for writing status. This identifies a read-only String attribute, which indicates whether the printer writer is in writing status. Possible values are:

WRITING_STATUS_YES

public static final java.lang.String WRITING_STATUS_YES
Attribute value indicating that the writer is in writing status.
See Also:
WRITING_STATUS

WRITING_STATUS_NO

public static final java.lang.String WRITING_STATUS_NO
Attribute value indicating that the writer is not in writing status.
See Also:
WRITING_STATUS

WRITING_STATUS_SEPARATORS

public static final java.lang.String WRITING_STATUS_SEPARATORS
Attribute value indicating that the writer is writing the file separators.
See Also:
WRITING_STATUS
Constructor Detail

RPrinter

public RPrinter()
Constructs an RPrinter object.

RPrinter

public RPrinter(AS400 system,
                java.lang.String name)
Constructs an RPrinter object.
Parameters:
system - The system.
name - The printer device name.
Method Detail

commitAttributeChanges

protected void commitAttributeChanges(java.lang.Object[] attributeIDs,
                                      java.lang.Object[] values,
                                      int[] bidiStringTypes)
                               throws ResourceException
Commits the specified attribute changes.
Overrides:
commitAttributeChanges in class ChangeableResource
Parameters:
attributeIDs - The attribute IDs for the specified attribute changes.
values - The specified attribute changes
bidiStringTypes - The bidi string types as defined by the CDRA (Character Data Representataion Architecture). See BidiStringType for more information and valid values.
Throws:
ResourceException - If an error occurs.

establishConnection

protected void establishConnection()
                            throws ResourceException
Establishes the connection to the AS/400.

The method is called by the resource framework automatically when the connection needs to be established.

Overrides:
establishConnection in class Resource
Throws:
ResourceException - If an error occurs.

freezeProperties

protected void freezeProperties()
                         throws ResourceException
Freezes any property changes. After this is called, property changes should not be made. Properties are not the same thing as attributes. Properties are basic pieces of information which must be set to make the object usable, such as the system and the name.

The method is called by the resource framework automatically when the properties need to be frozen.

Overrides:
freezeProperties in class Resource
Throws:
ResourceException - If an error occurs.

getAttributeUnchangedValue

public java.lang.Object getAttributeUnchangedValue(java.lang.Object attributeID,
                                                   int bidiStringType)
                                            throws ResourceException
Returns the unchanged value of an attribute. If the attribute value has an uncommitted change, this returns the unchanged value. If the attribute value does not have an uncommitted change, this returns the same value as getAttributeValue().
Overrides:
getAttributeUnchangedValue in class ChangeableResource
Parameters:
attributeID - Identifies the attribute.
bidiStringType - The bidi string type as defined by the CDRA (Character Data Representataion Architecture). See BidiStringType for more information and valid values.
Returns:
The attribute value, or null if the attribute value is not available.
Throws:
ResourceException - If an error occurs.

getName

public java.lang.String getName()
Returns the printer device name.
Returns:
The printer device name.

isBidiEnabled

protected boolean isBidiEnabled()
Indicates if this resource is enabled for bidirectional character conversion. This always returns true.
Overrides:
isBidiEnabled in class Resource
Returns:
Always true.

refreshAttributeValues

public void refreshAttributeValues()
                            throws ResourceException
Refreshes the values for all attributes. This does not cancel uncommitted changes. This method fires an attributeValuesRefreshed() ResourceEvent.
Overrides:
refreshAttributeValues in class ChangeableResource
Throws:
ResourceException - If an error occurs.

setName

public void setName(java.lang.String name)
             throws java.beans.PropertyVetoException
Sets the printer device name. This does not change the printer on the AS/400. Instead, it changes the printer to which this object references. This cannot be changed if the object has established a connection to the AS/400.
Parameters:
name - The printer device name.
Throws:
java.beans.PropertyVetoException - If the property change is vetoed.