Package 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:

Serializable

public class RPrinter
extends ChangeableResource

Deprecated.

Use Printer instead, as this package may be removed in the future.

The RPrinter class represents a printer connected to the system. The following attribute IDs are supported:

• ADVANCED_FUNCTION_PRINTING
• ALIGN_FORMS
• ALLOW_DIRECT_PRINTING
• AUTOMATICALLY_END_WRITER
• BETWEEN_COPIES_STATUS
• BETWEEN_FILES_STATUS
• CHANGES_TAKE_EFFECT
• COPIES_LEFT_TO_PRODUCE
• DEVICE_NAME
• DEVICE_STATUS
• DEVICE_TYPE
• END_PENDING_STATUS
• FORM_TYPE
• HELD_STATUS
• HOLD_PENDING_STATUS
• JOB_NAME
• JOB_NUMBER
• JOB_QUEUE_STATUS
• MESSAGE_KEY
• MESSAGE_OPTION
• MESSAGE_QUEUE
• NEXT_FILE_SEPARATORS
• NEXT_FORM_TYPE
• NEXT_MESSAGE_OPTION
• NEXT_OUTPUT_QUEUE
• NEXT_SEPARATOR_DRAWER
• NUMBER_OF_SEPARATORS
• OUTPUT_QUEUE
• OUTPUT_QUEUE_STATUS
• OVERALL_STATUS
• PAGE_BEING_WRITTEN
• SEPARATOR_DRAWER
• SPOOLED_FILE_NAME
• SPOOLED_FILE_NUMBER
• STARTED_BY_USER
• TEXT_DESCRIPTION
• TOTAL_COPIES
• TOTAL_PAGES
• USER_NAME
• WAITING_FOR_DATA_STATUS
• WAITING_FOR_DEVICE_STATUS
• WAITING_FOR_MESSAGE_STATUS
• WRITER_JOB_NAME
• WRITER_JOB_NUMBER
• WRITER_JOB_USER_NAME
• WRITER_STARTED
• WRITER_STATUS
• WRITING_STATUS

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

Fields

Modifier and Type	Field	Description
static String	ADVANCED_FUNCTION_PRINTING	Deprecated. Attribute ID for advanced function printing.
static String	ALIGN_FORMS	Deprecated. Attribute ID for align forms.
static String	ALIGN_FORMS_FILE	Deprecated. Attribute value indicating that control of the page alignment is specified by each file.
static String	ALIGN_FORMS_WRITER	Deprecated. Attribute value indicating that the writer determines when the forms alignment message is sent.
static String	ALLOW_DIRECT_PRINTING	Deprecated. Attribute ID for allow direct printing.
static String	AUTOMATICALLY_END_WRITER	Deprecated. Attribute ID for automatically end writer.
static String	BETWEEN_COPIES_STATUS	Deprecated. Attribute ID for between copies status.
static String	BETWEEN_FILES_STATUS	Deprecated. Attribute ID for between files status.
static String	CHANGES_TAKE_EFFECT	Deprecated. Attribute ID for changes take effect.
static String	COPIES_LEFT_TO_PRODUCE	Deprecated. Attribute ID for copies left to produce.
static String	DEVICE_NAME	Deprecated. Attribute ID for device name.
static String	DEVICE_STATUS	Deprecated. Attribute ID for device status.
static String	DEVICE_TYPE	Deprecated. Attribute ID for device type.
static String	END_PENDING_STATUS	Deprecated. Attribute ID for end pending status.
static String	FORM_TYPE	Deprecated. Attribute ID for form type.
static String	FORM_TYPE_ALL	Deprecated. Attribute value indicating that the writer is started with the option to print all spooled files of any form type.
static String	FORM_TYPE_FORMS	Deprecated. 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 String	FORM_TYPE_STANDARD	Deprecated. Attribute value indicating that the writer is started with the option to print all spooled files with a form type of *STD.
static String	HELD_STATUS	Deprecated. Attribute ID for held status.
static String	HOLD_PENDING_STATUS	Deprecated. Attribute ID for hold pending status.
static String	JOB_NAME	Deprecated. Attribute ID for job name.
static String	JOB_NUMBER	Deprecated. Attribute ID for job number.
static String	JOB_QUEUE_STATUS	Deprecated. Attribute ID for job queue status.
static String	MESSAGE_KEY	Deprecated. Attribute ID for message key.
static String	MESSAGE_OPTION	Deprecated. Attribute ID for message option.
static String	MESSAGE_OPTION_INFORMATIONAL_MESSAGE	Deprecated. Attribute value indicating that an informational message is sent to the message queue when this form is finished.
static String	MESSAGE_OPTION_INQUIRY_MESSAGE	Deprecated. Attribute value indicating that an inquiry message is sent to the message queue when this form is finished.
static String	MESSAGE_OPTION_MESSAGE	Deprecated. Attribute value indicating that a message is sent to the message queue when this form is finished.
static String	MESSAGE_OPTION_NO_MESSAGE	Deprecated. Attribute value indicating that no message is sent to the message queue when this form is finished.
static String	MESSAGE_QUEUE	Deprecated. Attribute ID for message queue.
static String	NEXT_FILE_SEPARATORS	Deprecated. Attribute ID for next file separators.
static String	NEXT_FORM_TYPE	Deprecated. Attribute ID for next form type.
static String	NEXT_MESSAGE_OPTION	Deprecated. Attribute ID for next message option.
static String	NEXT_OUTPUT_QUEUE	Deprecated. Attribute ID for next output queue.
static String	NEXT_SEPARATOR_DRAWER	Deprecated. Attribute ID for next separator drawer.
static String	NUMBER_OF_SEPARATORS	Deprecated. Attribute ID for number of separators.
static String	OPERATION_FILE_END	Deprecated. Attribute value that indicates that an operation is effective when the current spooled file has been printed.
static String	OPERATION_NO_FILES_READY	Deprecated. 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 String	OPERATION_NONE	Deprecated. Attribute value that indicates that an operation is not effective.
static String	OUTPUT_QUEUE	Deprecated. Attribute ID for output queue.
static String	OUTPUT_QUEUE_STATUS	Deprecated. Attribute ID for output queue status.
static String	OVERALL_STATUS	Deprecated. Attribute ID for overall status.
static String	PAGE_BEING_WRITTEN	Deprecated. Attribute ID for page being written.
static String	PENDING_STATUS_CONTROLLED	Deprecated. 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 String	PENDING_STATUS_IMMEDIATE	Deprecated. Attribute value for status indicating that an operation is pending and will take effect as soon as its output buffers are empty.
static String	PENDING_STATUS_NONE	Deprecated. Attribute value for status indicating that no operation is pending.
static String	PENDING_STATUS_PAGE_END	Deprecated. Attribute value for status indicating that an operation is pending and will take effect at the end of the page.
static String	PUBLISHED_STATUS	Deprecated. Attribute ID for published status.
static String	SEPARATOR_DRAWER	Deprecated. Attribute ID for separator drawer.
static Integer	SEPARATOR_PAGE_DEVICE	Deprecated. Attribute value that indicates that separator page information is set in the device description.
static Integer	SEPARATOR_PAGE_FILE	Deprecated. Attribute value that indicates that separator page information is set in the file.
static Integer	SEPARATOR_PAGE_NONE	Deprecated. Attribute value that indicates that there is no separator page.
static String	SPOOLED_FILE_NAME	Deprecated. Attribute ID for spooled file name.
static String	SPOOLED_FILE_NUMBER	Deprecated. Attribute ID for spooled file number.
static String	STARTED_BY_USER	Deprecated. Attribute ID for started by user.
static String	STATUS_HELD	Deprecated. Attribute value for status indicating held.
static String	STATUS_RELEASED	Deprecated. Attribute value for status indicating released.
static String	TEXT_DESCRIPTION	Deprecated. Attribute ID for text description.
static String	TOTAL_COPIES	Deprecated. Attribute ID for total copies.
static String	TOTAL_PAGES	Deprecated. Attribute ID for total pages.
static String	USER_NAME	Deprecated. Attribute ID for user name.
static String	WAITING_FOR_DATA_STATUS	Deprecated. Attribute ID for waiting for data status.
static String	WAITING_FOR_DEVICE_STATUS	Deprecated. Attribute ID for waiting for device status.
static String	WAITING_FOR_MESSAGE_STATUS	Deprecated. Attribute ID for waiting for message status.
static String	WRITER_JOB_NAME	Deprecated. Attribute ID for writer job name.
static String	WRITER_JOB_NUMBER	Deprecated. Attribute ID for writer job number.
static String	WRITER_JOB_USER_NAME	Deprecated. Attribute ID for writer job user name.
static String	WRITER_STARTED	Deprecated. Attribute ID for waiting for device status.
static String	WRITER_STATUS	Deprecated. Attribute ID for writer status.
static byte[]	WRITER_STATUS_ENDED	Deprecated. Attribute value indicating that the writer is ended.
static byte[]	WRITER_STATUS_HELD	Deprecated. Attribute value indicating that the writer is held.
static byte[]	WRITER_STATUS_JOB_QUEUE	Deprecated. Attribute value indicating that the writer is on a job queue.
static byte[]	WRITER_STATUS_MESSAGE_WAITING	Deprecated. Attribute value indicating that the writer is waiting on a message.
static byte[]	WRITER_STATUS_STARTED	Deprecated. Attribute value indicating that the writer is started.
static String	WRITING_STATUS	Deprecated. Attribute ID for writing status.
static String	WRITING_STATUS_NO	Deprecated. Attribute value indicating that the writer is not in writing status.
static String	WRITING_STATUS_SEPARATORS	Deprecated. Attribute value indicating that the writer is writing the file separators.
static String	WRITING_STATUS_YES	Deprecated. Attribute value indicating that the writer is in writing status.

Constructor Summary

Constructors

Constructor	Description
RPrinter()	Deprecated. Constructs an RPrinter object.
RPrinter(AS400 system, String name)	Deprecated. Constructs an RPrinter object.

Method Summary

Modifier and Type	Method	Description
protected void	commitAttributeChanges(Object[] attributeIDs, Object[] values, int[] bidiStringTypes)	Deprecated. Commits the specified attribute changes.
protected void	establishConnection()	Deprecated. Establishes the connection to the system.
protected void	freezeProperties()	Deprecated. Freezes any property changes.
Object	getAttributeUnchangedValue(Object attributeID, int bidiStringType)	Deprecated. Returns the unchanged value of an attribute.
String	getName()	Deprecated. Returns the printer device name.
protected boolean	isBidiEnabled()	Deprecated. Indicates if this resource is enabled for bidirectional character conversion.
void	refreshAttributeValues()	Deprecated. Refreshes the values for all attributes.
void	setName(String name)	Deprecated. 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 String OPERATION_FILE_END

Deprecated.

Attribute value that indicates that an operation is effective when the current spooled file has been printed.

See Also:

Constant Field Values

OPERATION_NO_FILES_READY

public static final String OPERATION_NO_FILES_READY

Deprecated.

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.

See Also:

Constant Field Values

OPERATION_NONE

public static final String OPERATION_NONE

Deprecated.

Attribute value that indicates that an operation is not effective.

See Also:

Constant Field Values

PENDING_STATUS_CONTROLLED

public static final String PENDING_STATUS_CONTROLLED

Deprecated.

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.

See Also:

Constant Field Values

PENDING_STATUS_IMMEDIATE

public static final String PENDING_STATUS_IMMEDIATE

Deprecated.

Attribute value for status indicating that an operation is pending and will take effect as soon as its output buffers are empty.

See Also:

Constant Field Values

PENDING_STATUS_NONE

public static final String PENDING_STATUS_NONE

Deprecated.

Attribute value for status indicating that no operation is pending.

See Also:

Constant Field Values

PENDING_STATUS_PAGE_END

public static final String PENDING_STATUS_PAGE_END

Deprecated.

Attribute value for status indicating that an operation is pending and will take effect at the end of the page.

See Also:

Constant Field Values

SEPARATOR_PAGE_DEVICE

public static final Integer SEPARATOR_PAGE_DEVICE

Deprecated.

Attribute value that indicates that separator page information is set in the device description.

SEPARATOR_PAGE_FILE

public static final Integer SEPARATOR_PAGE_FILE

Deprecated.

Attribute value that indicates that separator page information is set in the file.

SEPARATOR_PAGE_NONE

public static final Integer SEPARATOR_PAGE_NONE

Deprecated.

Attribute value that indicates that there is no separator page.

STATUS_HELD

public static final String STATUS_HELD

Deprecated.

Attribute value for status indicating held.

See Also:

Constant Field Values

STATUS_RELEASED

public static final String STATUS_RELEASED

Deprecated.

Attribute value for status indicating released.

See Also:

Constant Field Values

ADVANCED_FUNCTION_PRINTING

public static final String ADVANCED_FUNCTION_PRINTING

Deprecated.

Attribute ID for advanced function printing. This identifies a read-only Boolean attribute, which indicates whether the printer supports Advanced Function Printing.

See Also:

Constant Field Values

ALIGN_FORMS

public static final String ALIGN_FORMS

Deprecated.

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 - The writer determines when the message is sent.
• ALIGN_FORMS_FILE - Control of the page alignment is specified by each file.
• "" - The writer is ended.

See Also:

Constant Field Values

ALIGN_FORMS_WRITER

public static final String ALIGN_FORMS_WRITER

Deprecated.

Attribute value indicating that the writer determines when the forms alignment message is sent.

See Also:

ALIGN_FORMS, Constant Field Values

ALIGN_FORMS_FILE

public static final String ALIGN_FORMS_FILE

Deprecated.

Attribute value indicating that control of the page alignment is specified by each file.

See Also:

ALIGN_FORMS, Constant Field Values

ALLOW_DIRECT_PRINTING

public static final String ALLOW_DIRECT_PRINTING

Deprecated.

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.

See Also:

Constant Field Values

AUTOMATICALLY_END_WRITER

public static final String AUTOMATICALLY_END_WRITER

Deprecated.

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:

• OPERATION_NO_FILES_READY - When no files are ready to print on the output queue from which the writer is selecting files to be printed.
• OPERATION_FILE_END - When the current spooled file has been printed.
• OPERATION_NONE - The writer will not end, but it will wait for more spooled files.
• "" - The writer is ended.

See Also:

Constant Field Values

BETWEEN_COPIES_STATUS

public static final String BETWEEN_COPIES_STATUS

Deprecated.

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.

See Also:

Constant Field Values

BETWEEN_FILES_STATUS

public static final String BETWEEN_FILES_STATUS

Deprecated.

Attribute ID for between files status. This identifies a read-only Boolean attribute, which indicates whether the writer is between spooled files.

See Also:

Constant Field Values

CHANGES_TAKE_EFFECT

public static final String CHANGES_TAKE_EFFECT

Deprecated.

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:

• OPERATION_NO_FILES_READY - When all the current eligible files are printed.
• OPERATION_FILE_END - When the current spooled file is done printing.
• "" - No pending changes to the writer.

See Also:

Constant Field Values

COPIES_LEFT_TO_PRODUCE

public static final String COPIES_LEFT_TO_PRODUCE

Deprecated.

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.

See Also:

Constant Field Values

DEVICE_NAME

public static final String DEVICE_NAME

Deprecated.

Attribute ID for device name. This identifies a read-only String attribute, which represents the name of the printer device.

See Also:

Constant Field Values

DEVICE_STATUS

public static final String DEVICE_STATUS

Deprecated.

Attribute ID for device status. This identifies a read-only Integer attribute, which represents the status of the printer device.

See Also:

Constant Field Values

DEVICE_TYPE

public static final String DEVICE_TYPE

Deprecated.

Attribute ID for device type. This identifies a read-only String attribute, which represents the type of the printer.

See Also:

Constant Field Values

END_PENDING_STATUS

public static final String END_PENDING_STATUS

Deprecated.

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:

• PENDING_STATUS_NONE - No End Writer (ENDWTR) command has been issued.
• PENDING_STATUS_IMMEDIATE - The writer ends as soon as its output buffers are empty.
• PENDING_STATUS_CONTROLLED - The writer ends after the current copy of the spooled file has been printed.
• PENDING_STATUS_PAGE_END - The writer ends at the end of the page.
• "" - The writer is ended.

See Also:

Constant Field Values

FORM_TYPE

public static final String FORM_TYPE

Deprecated.

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 - The writer is started with the option to print all spooled files of any form type.
• FORM_TYPE_FORMS - The writer is started with the option to print all spooled files with the same form type before using a different form type.
• FORM_TYPE_STANDARD - The writer is started with the option to print all spooled files with a form type of *STD.
• A form type name - The writer is started with the option to print all spooled files with the specified form type.

See Also:

Constant Field Values

FORM_TYPE_ALL

public static final String FORM_TYPE_ALL

Deprecated.

Attribute value indicating that the writer is started with the option to print all spooled files of any form type.

See Also:

FORM_TYPE, Constant Field Values

FORM_TYPE_FORMS

public static final String FORM_TYPE_FORMS

Deprecated.

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, Constant Field Values

FORM_TYPE_STANDARD

public static final String FORM_TYPE_STANDARD

Deprecated.

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, Constant Field Values

HELD_STATUS

public static final String HELD_STATUS

Deprecated.

Attribute ID for held status. This identifies a read-only Boolean attribute, which indicates whether the writer is held.

See Also:

Constant Field Values

HOLD_PENDING_STATUS

public static final String HOLD_PENDING_STATUS

Deprecated.

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:

• PENDING_STATUS_NONE - No Hold Writer (HLDWTR) command has been issued.
• PENDING_STATUS_IMMEDIATE - The writer is held as soon as its output buffers are empty.
• PENDING_STATUS_CONTROLLED - The writer is held after the current copy of the spooled file has been printed.
• PENDING_STATUS_PAGE_END - The writer is held at the end of the page.
• "" - The writer is ended.

See Also:

Constant Field Values

JOB_NAME

public static final String JOB_NAME

Deprecated.

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.

See Also:

Constant Field Values

JOB_NUMBER

public static final String JOB_NUMBER

Deprecated.

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.

See Also:

Constant Field Values

JOB_QUEUE_STATUS

public static final String JOB_QUEUE_STATUS

Deprecated.

Attribute ID for job queue status. This identifies a read-only Boolean attribute, which indicates whether the writer is on a job queue.

See Also:

Constant Field Values

MESSAGE_KEY

public static final String MESSAGE_KEY

Deprecated.

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.

See Also:

Constant Field Values

MESSAGE_OPTION

public static final String MESSAGE_OPTION

Deprecated.

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 - A message is sent to the message queue.
• MESSAGE_OPTION_NO_MESSAGE - No message is sent to the message queue.
• MESSAGE_OPTION_INFORMATIONAL_MESSAGE - An informational message is sent to the message queue.
• MESSAGE_OPTION_INQUIRY_MESSAGE - An inquiry message is sent to the message queue.
• "" - The writer is ended.

See Also:

Constant Field Values

MESSAGE_OPTION_MESSAGE

public static final String MESSAGE_OPTION_MESSAGE

Deprecated.

Attribute value indicating that a message is sent to the message queue when this form is finished.

See Also:

MESSAGE_OPTION, Constant Field Values

MESSAGE_OPTION_NO_MESSAGE

public static final String MESSAGE_OPTION_NO_MESSAGE

Deprecated.

Attribute value indicating that no message is sent to the message queue when this form is finished.

See Also:

MESSAGE_OPTION, Constant Field Values

MESSAGE_OPTION_INFORMATIONAL_MESSAGE

public static final String MESSAGE_OPTION_INFORMATIONAL_MESSAGE

Deprecated.

Attribute value indicating that an informational message is sent to the message queue when this form is finished.

See Also:

MESSAGE_OPTION, Constant Field Values

MESSAGE_OPTION_INQUIRY_MESSAGE

public static final String MESSAGE_OPTION_INQUIRY_MESSAGE

Deprecated.

Attribute value indicating that an inquiry message is sent to the message queue when this form is finished.

See Also:

MESSAGE_OPTION, Constant Field Values

MESSAGE_QUEUE

public static final String MESSAGE_QUEUE

Deprecated.

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, Constant Field Values

NEXT_FILE_SEPARATORS

public static final String NEXT_FILE_SEPARATORS

Deprecated.

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:

• SEPARATOR_PAGE_FILE - The number of separator pages is specified by each file.
• SEPARATOR_PAGE_NONE - There are no pending changes to the writer.
• The number of separator pages to be printed.

See Also:

Constant Field Values

NEXT_FORM_TYPE

public static final String NEXT_FORM_TYPE

Deprecated.

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:

• FORM_TYPE_ALL - The writer is changed with the option to print all spooled files of any form type.
• FORM_TYPE_FORMS - The writer is changed with the option to print all spooled files with the same form type before using a different form type.
• FORM_TYPE_STANDARD - The writer is changed with the option to print all spooled files with a form type of *STD.
• A form type name - The writer is changed with the option to print all spooled files with the specified form type.
• "" - No change has been made to this writer.

See Also:

Constant Field Values

NEXT_MESSAGE_OPTION

public static final String NEXT_MESSAGE_OPTION

Deprecated.

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:

• MESSAGE_OPTION_MESSAGE - A message is sent to the message queue.
• MESSAGE_OPTION_NO_MESSAGE - No message is sent to the message queue.
• MESSAGE_OPTION_INFORMATIONAL_MESSAGE - An informational message is sent to the message queue.
• MESSAGE_OPTION_INQUIRY_MESSAGE - An inquiry message is sent to the message queue.
• "" - No change is pending.

See Also:

Constant Field Values

NEXT_OUTPUT_QUEUE

public static final String NEXT_OUTPUT_QUEUE

Deprecated.

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, Constant Field Values

NEXT_SEPARATOR_DRAWER

public static final String NEXT_SEPARATOR_DRAWER

Deprecated.

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:

• SEPARATOR_PAGE_FILE - The separator pages are taken from the same drawer that the file is printed from.
• SEPARATOR_PAGE_DEVICE - The separator pages are taken from the separator drawer specified in the printer device description.
• SEPARATOR_PAGE_NONE - There are no pending changes to the writer.
• A drawer number.

See Also:

Constant Field Values

NUMBER_OF_SEPARATORS

public static final String NUMBER_OF_SEPARATORS

Deprecated.

Attribute ID for number of separators. This identifies a Integer attribute, which represents the number of separator pages to be printed. Possible values are:

• SEPARATOR_PAGE_FILE - The number of separator pages is specified by each file.
• The number of separator pages.

See Also:

Constant Field Values

OUTPUT_QUEUE

public static final String OUTPUT_QUEUE

Deprecated.

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, Constant Field Values

OUTPUT_QUEUE_STATUS

public static final String OUTPUT_QUEUE_STATUS

Deprecated.

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:

• STATUS_HELD - The output queue is held.
• STATUS_RELEASED - The output queue is released.
• "" - The output queue is not set.

See Also:

Constant Field Values

OVERALL_STATUS

public static final String OVERALL_STATUS

Deprecated.

Attribute ID for overall status. This identifies a read-only Integer attribute, which represents the overall status of the logical printer.

See Also:

Constant Field Values

PAGE_BEING_WRITTEN

public static final String PAGE_BEING_WRITTEN

Deprecated.

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.

See Also:

Constant Field Values

PUBLISHED_STATUS

public static final String PUBLISHED_STATUS

Deprecated.

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 systems running OS/400 V5R1 or later.

See Also:

Constant Field Values

SEPARATOR_DRAWER

public static final String SEPARATOR_DRAWER

Deprecated.

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:

• SEPARATOR_PAGE_FILE - The separator pages are taken from the same drawer that the file is printed from.
• SEPARATOR_PAGE_DEVICE - The separator pages are taken from the separator drawer specified in the printer device description.
• A drawer number.

See Also:

Constant Field Values

SPOOLED_FILE_NAME

public static final String SPOOLED_FILE_NAME

Deprecated.

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.

See Also:

Constant Field Values

SPOOLED_FILE_NUMBER

public static final String SPOOLED_FILE_NUMBER

Deprecated.

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.

See Also:

Constant Field Values

STARTED_BY_USER

public static final String STARTED_BY_USER

Deprecated.

Attribute ID for started by user. This identifies a read-only String attribute, which represents the name of the user that started the writer.

See Also:

Constant Field Values

TEXT_DESCRIPTION

public static final String TEXT_DESCRIPTION

Deprecated.

Attribute ID for text description. This identifies a String attribute, which represents the text description of the printer device.

See Also:

Constant Field Values

TOTAL_COPIES

public static final String TOTAL_COPIES

Deprecated.

Attribute ID for total copies. This identifies a read-only Integer attribute, which represents the total number of copies to be printed.

See Also:

Constant Field Values

TOTAL_PAGES

public static final String TOTAL_PAGES

Deprecated.

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.

See Also:

Constant Field Values

USER_NAME

public static final String USER_NAME

Deprecated.

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.

See Also:

Constant Field Values

WAITING_FOR_DATA_STATUS

public static final String WAITING_FOR_DATA_STATUS

Deprecated.

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.

See Also:

Constant Field Values

WAITING_FOR_DEVICE_STATUS

public static final String WAITING_FOR_DEVICE_STATUS

Deprecated.

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.

See Also:

Constant Field Values

WAITING_FOR_MESSAGE_STATUS

public static final String WAITING_FOR_MESSAGE_STATUS

Deprecated.

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.

See Also:

Constant Field Values

WRITER_JOB_NAME

public static final String WRITER_JOB_NAME

Deprecated.

Attribute ID for writer job name. This identifies a read-only String attribute, which represents the job name of the printer writer.

See Also:

Constant Field Values

WRITER_JOB_NUMBER

public static final String WRITER_JOB_NUMBER

Deprecated.

Attribute ID for writer job number. This identifies a read-only String attribute, which represents the job number of the printer writer.

See Also:

Constant Field Values

WRITER_JOB_USER_NAME

public static final String WRITER_JOB_USER_NAME

Deprecated.

Attribute ID for writer job user name. This identifies a read-only String attribute, which represents the the name of the system user.

See Also:

Constant Field Values

WRITER_STARTED

public static final String WRITER_STARTED

Deprecated.

Attribute ID for waiting for device status. This identifies a read-only Boolean attribute, which indicates whether a writer is started for this printer.

See Also:

Constant Field Values

WRITER_STATUS

public static final String WRITER_STATUS

Deprecated.

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 - The writer is started.
• WRITER_STATUS_ENDED - The writer is ended.
• WRITER_STATUS_JOB_QUEUE - The writer is on a job queue.
• WRITER_STATUS_HELD - The writer is held.
• WRITER_STATUS_MESSAGE_WAITING - The writer is waiting on a message.

See Also:

Constant Field Values

WRITER_STATUS_STARTED

public static final byte[] WRITER_STATUS_STARTED

Deprecated.

Attribute value indicating that the writer is started.

See Also:

WRITER_STATUS

WRITER_STATUS_ENDED

public static final byte[] WRITER_STATUS_ENDED

Deprecated.

Attribute value indicating that the writer is ended.

See Also:

WRITER_STATUS

WRITER_STATUS_JOB_QUEUE

public static final byte[] WRITER_STATUS_JOB_QUEUE

Deprecated.

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

Deprecated.

Attribute value indicating that the writer is held.

See Also:

WRITER_STATUS

WRITER_STATUS_MESSAGE_WAITING

public static final byte[] WRITER_STATUS_MESSAGE_WAITING

Deprecated.

Attribute value indicating that the writer is waiting on a message.

See Also:

WRITER_STATUS

WRITING_STATUS

public static final String WRITING_STATUS

Deprecated.

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 - The writer is in writing status.
• WRITING_STATUS_NO - The writer is not in writing status.
• WRITING_STATUS_SEPARATORS - The writer is writing the file separators.
• "" - The writer is ended.

See Also:

Constant Field Values

WRITING_STATUS_YES

public static final String WRITING_STATUS_YES

Deprecated.

Attribute value indicating that the writer is in writing status.

See Also:

WRITING_STATUS, Constant Field Values

WRITING_STATUS_NO

public static final String WRITING_STATUS_NO

Deprecated.

Attribute value indicating that the writer is not in writing status.

See Also:

WRITING_STATUS, Constant Field Values

WRITING_STATUS_SEPARATORS

public static final String WRITING_STATUS_SEPARATORS

Deprecated.

Attribute value indicating that the writer is writing the file separators.

See Also:

WRITING_STATUS, Constant Field Values

Constructor Detail

RPrinter

public RPrinter()

Deprecated.

Constructs an RPrinter object.

RPrinter

public RPrinter(AS400 system,
                String name)

Deprecated.

Constructs an RPrinter object.

Parameters:

system - The system.

name - The printer device name.

Method Detail

commitAttributeChanges

protected void commitAttributeChanges(Object[] attributeIDs,
                                      Object[] values,
                                      int[] bidiStringTypes)
                               throws ResourceException

Deprecated.

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 Representation Architecture). See BidiStringType for more information and valid values.

Throws:

ResourceException - If an error occurs.

See Also:

Subclass notes

establishConnection

protected void establishConnection()
                            throws ResourceException

Deprecated.

Establishes the connection to the system.

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

Deprecated.

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 Object getAttributeUnchangedValue(Object attributeID,
                                         int bidiStringType)
                                  throws ResourceException

Deprecated.

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 Representation 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.

See Also:

Subclass notes

getName

public String getName()

Deprecated.

Returns the printer device name.

Returns:

The printer device name.

isBidiEnabled

protected boolean isBidiEnabled()

Deprecated.

Indicates if this resource is enabled for bidirectional character conversion. This always returns true.

Overrides:

isBidiEnabled in class Resource

Returns:

Always true.

See Also:

Subclass notes

refreshAttributeValues

public void refreshAttributeValues()
                            throws ResourceException

Deprecated.

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(String name)
             throws PropertyVetoException

Deprecated.

Sets the printer device name. This does not change the printer on the system. Instead, it changes the printer to which this object references. This cannot be changed if the object has established a connection to the system.

Parameters:

name - The printer device name.

Throws:

PropertyVetoException - If the property change is vetoed.