|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.ibm.as400.resource.Resource com.ibm.as400.resource.ChangeableResource com.ibm.as400.resource.RPrinter
Printer
instead, as this package may be removed in the future.
public class RPrinter extends ChangeableResource
The RPrinter class represents a printer connected to the system.
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();
RPrinterList
,
Serialized FormModifier and Type | Field and 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 and Description |
---|
RPrinter()
Deprecated. Constructs an RPrinter object. |
RPrinter(AS400 system,
String name)
Deprecated. Constructs an RPrinter object. |
Modifier and Type | Method and 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 java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String OPERATION_FILE_END
public static final String OPERATION_NO_FILES_READY
public static final String OPERATION_NONE
public static final String PENDING_STATUS_CONTROLLED
public static final String PENDING_STATUS_IMMEDIATE
public static final String PENDING_STATUS_NONE
public static final String PENDING_STATUS_PAGE_END
public static final Integer SEPARATOR_PAGE_DEVICE
public static final Integer SEPARATOR_PAGE_FILE
public static final Integer SEPARATOR_PAGE_NONE
public static final String STATUS_HELD
public static final String STATUS_RELEASED
public static final String ADVANCED_FUNCTION_PRINTING
public static final String ALIGN_FORMS
ALIGN_FORMS_WRITER
- The writer determines when the message is sent.
ALIGN_FORMS_FILE
- Control of the page alignment is specified by each file.
public static final String ALIGN_FORMS_WRITER
ALIGN_FORMS
,
Constant Field Valuespublic static final String ALIGN_FORMS_FILE
ALIGN_FORMS
,
Constant Field Valuespublic static final String ALLOW_DIRECT_PRINTING
public static final String AUTOMATICALLY_END_WRITER
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.
public static final String BETWEEN_COPIES_STATUS
public static final String BETWEEN_FILES_STATUS
public static final String CHANGES_TAKE_EFFECT
OPERATION_NO_FILES_READY
- When all the current eligible files are printed.
OPERATION_FILE_END
- When the current spooled file is done printing.
public static final String COPIES_LEFT_TO_PRODUCE
public static final String DEVICE_NAME
public static final String DEVICE_STATUS
public static final String DEVICE_TYPE
public static final String END_PENDING_STATUS
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.
public static final String FORM_TYPE
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.
public static final String FORM_TYPE_ALL
FORM_TYPE
,
Constant Field Valuespublic static final String FORM_TYPE_FORMS
FORM_TYPE
,
Constant Field Valuespublic static final String FORM_TYPE_STANDARD
FORM_TYPE
,
Constant Field Valuespublic static final String HELD_STATUS
public static final String HOLD_PENDING_STATUS
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.
public static final String JOB_NAME
public static final String JOB_NUMBER
public static final String JOB_QUEUE_STATUS
public static final String MESSAGE_KEY
public static final String MESSAGE_OPTION
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.
public static final String MESSAGE_OPTION_MESSAGE
MESSAGE_OPTION
,
Constant Field Valuespublic static final String MESSAGE_OPTION_NO_MESSAGE
MESSAGE_OPTION
,
Constant Field Valuespublic static final String MESSAGE_OPTION_INFORMATIONAL_MESSAGE
MESSAGE_OPTION
,
Constant Field Valuespublic static final String MESSAGE_OPTION_INQUIRY_MESSAGE
MESSAGE_OPTION
,
Constant Field Valuespublic static final String MESSAGE_QUEUE
QSYSObjectPathName
,
Constant Field Valuespublic static final String NEXT_FILE_SEPARATORS
SEPARATOR_PAGE_FILE
- The number of separator pages is specified by each file.
SEPARATOR_PAGE_NONE
- There are no pending changes to the writer.
public static final String NEXT_FORM_TYPE
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.
public static final String NEXT_MESSAGE_OPTION
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.
public static final String NEXT_OUTPUT_QUEUE
QSYSObjectPathName
,
Constant Field Valuespublic static final String NEXT_SEPARATOR_DRAWER
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.
public static final String NUMBER_OF_SEPARATORS
SEPARATOR_PAGE_FILE
- The number of separator pages is specified by each file.
public static final String OUTPUT_QUEUE
QSYSObjectPathName
,
Constant Field Valuespublic static final String OUTPUT_QUEUE_STATUS
STATUS_HELD
- The output queue is held.
STATUS_RELEASED
- The output queue is released.
public static final String OVERALL_STATUS
public static final String PAGE_BEING_WRITTEN
public static final String PUBLISHED_STATUS
public static final String SEPARATOR_DRAWER
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.
public static final String SPOOLED_FILE_NAME
public static final String SPOOLED_FILE_NUMBER
public static final String STARTED_BY_USER
public static final String TEXT_DESCRIPTION
public static final String TOTAL_COPIES
public static final String TOTAL_PAGES
public static final String USER_NAME
public static final String WAITING_FOR_DATA_STATUS
public static final String WAITING_FOR_DEVICE_STATUS
public static final String WAITING_FOR_MESSAGE_STATUS
public static final String WRITER_JOB_NAME
public static final String WRITER_JOB_NUMBER
public static final String WRITER_JOB_USER_NAME
public static final String WRITER_STARTED
public static final String WRITER_STATUS
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.
public static final byte[] WRITER_STATUS_STARTED
WRITER_STATUS
public static final byte[] WRITER_STATUS_ENDED
WRITER_STATUS
public static final byte[] WRITER_STATUS_JOB_QUEUE
WRITER_STATUS
public static final byte[] WRITER_STATUS_HELD
WRITER_STATUS
public static final byte[] WRITER_STATUS_MESSAGE_WAITING
WRITER_STATUS
public static final String WRITING_STATUS
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.
public static final String WRITING_STATUS_YES
WRITING_STATUS
,
Constant Field Valuespublic static final String WRITING_STATUS_NO
WRITING_STATUS
,
Constant Field Valuespublic static final String WRITING_STATUS_SEPARATORS
WRITING_STATUS
,
Constant Field ValuesConstructor Detail |
---|
public RPrinter()
public RPrinter(AS400 system, String name)
system
- The system.name
- The printer device name.Method Detail |
---|
protected void commitAttributeChanges(Object[] attributeIDs, Object[] values, int[] bidiStringTypes) throws ResourceException
commitAttributeChanges
in class ChangeableResource
attributeIDs
- The attribute IDs for the specified attribute changes.values
- The specified attribute changesbidiStringTypes
- The bidi string types as defined by the CDRA (Character Data
Representataion Architecture). See
BidiStringType
for more information and valid values.ResourceException
- If an error occurs.protected void establishConnection() throws ResourceException
The method is called by the resource framework automatically when the connection needs to be established.
establishConnection
in class Resource
ResourceException
- If an error occurs.protected void freezeProperties() throws ResourceException
The method is called by the resource framework automatically when the properties need to be frozen.
freezeProperties
in class Resource
ResourceException
- If an error occurs.public Object getAttributeUnchangedValue(Object attributeID, int bidiStringType) throws ResourceException
getAttributeUnchangedValue
in class ChangeableResource
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.ResourceException
- If an error occurs.public String getName()
protected boolean isBidiEnabled()
isBidiEnabled
in class Resource
public void refreshAttributeValues() throws ResourceException
refreshAttributeValues
in class ChangeableResource
ResourceException
- If an error occurs.public void setName(String name) throws PropertyVetoException
name
- The printer device name.PropertyVetoException
- If the property change is vetoed.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |