|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | 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
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();
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 java.lang.Object |
clone,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
public static final java.lang.String OPERATION_FILE_END
public static final java.lang.String OPERATION_NO_FILES_READY
public static final java.lang.String OPERATION_NONE
public static final java.lang.String PENDING_STATUS_CONTROLLED
public static final java.lang.String PENDING_STATUS_IMMEDIATE
public static final java.lang.String PENDING_STATUS_NONE
public static final java.lang.String PENDING_STATUS_PAGE_END
public static final java.lang.Integer SEPARATOR_PAGE_DEVICE
public static final java.lang.Integer SEPARATOR_PAGE_FILE
public static final java.lang.Integer SEPARATOR_PAGE_NONE
public static final java.lang.String STATUS_HELD
public static final java.lang.String STATUS_RELEASED
public static final java.lang.String ADVANCED_FUNCTION_PRINTING
public static final java.lang.String ALIGN_FORMS
public static final java.lang.String ALIGN_FORMS_WRITER
ALIGN_FORMS
public static final java.lang.String ALIGN_FORMS_FILE
ALIGN_FORMS
public static final java.lang.String ALLOW_DIRECT_PRINTING
public static final java.lang.String AUTOMATICALLY_END_WRITER
public static final java.lang.String BETWEEN_COPIES_STATUS
public static final java.lang.String BETWEEN_FILES_STATUS
public static final java.lang.String CHANGES_TAKE_EFFECT
public static final java.lang.String COPIES_LEFT_TO_PRODUCE
public static final java.lang.String DEVICE_NAME
public static final java.lang.String DEVICE_STATUS
public static final java.lang.String DEVICE_TYPE
public static final java.lang.String END_PENDING_STATUS
public static final java.lang.String FORM_TYPE
public static final java.lang.String FORM_TYPE_ALL
FORM_TYPE
public static final java.lang.String FORM_TYPE_FORMS
FORM_TYPE
public static final java.lang.String FORM_TYPE_STANDARD
FORM_TYPE
public static final java.lang.String HELD_STATUS
public static final java.lang.String HOLD_PENDING_STATUS
public static final java.lang.String JOB_NAME
public static final java.lang.String JOB_NUMBER
public static final java.lang.String JOB_QUEUE_STATUS
public static final java.lang.String MESSAGE_KEY
public static final java.lang.String MESSAGE_OPTION
public static final java.lang.String MESSAGE_OPTION_MESSAGE
MESSAGE_OPTION
public static final java.lang.String MESSAGE_OPTION_NO_MESSAGE
MESSAGE_OPTION
public static final java.lang.String MESSAGE_OPTION_INFORMATIONAL_MESSAGE
MESSAGE_OPTION
public static final java.lang.String MESSAGE_OPTION_INQUIRY_MESSAGE
MESSAGE_OPTION
public static final java.lang.String MESSAGE_QUEUE
QSYSObjectPathName
public static final java.lang.String NEXT_FILE_SEPARATORS
public static final java.lang.String NEXT_FORM_TYPE
public static final java.lang.String NEXT_MESSAGE_OPTION
public static final java.lang.String NEXT_OUTPUT_QUEUE
QSYSObjectPathName
public static final java.lang.String NEXT_SEPARATOR_DRAWER
public static final java.lang.String NUMBER_OF_SEPARATORS
public static final java.lang.String OUTPUT_QUEUE
QSYSObjectPathName
public static final java.lang.String OUTPUT_QUEUE_STATUS
public static final java.lang.String OVERALL_STATUS
public static final java.lang.String PAGE_BEING_WRITTEN
public static final java.lang.String PUBLISHED_STATUS
public static final java.lang.String SEPARATOR_DRAWER
public static final java.lang.String SPOOLED_FILE_NAME
public static final java.lang.String SPOOLED_FILE_NUMBER
public static final java.lang.String STARTED_BY_USER
public static final java.lang.String TEXT_DESCRIPTION
public static final java.lang.String TOTAL_COPIES
public static final java.lang.String TOTAL_PAGES
public static final java.lang.String USER_NAME
public static final java.lang.String WAITING_FOR_DATA_STATUS
public static final java.lang.String WAITING_FOR_DEVICE_STATUS
public static final java.lang.String WAITING_FOR_MESSAGE_STATUS
public static final java.lang.String WRITER_JOB_NAME
public static final java.lang.String WRITER_JOB_NUMBER
public static final java.lang.String WRITER_JOB_USER_NAME
public static final java.lang.String WRITER_STARTED
public static final java.lang.String WRITER_STATUS
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 java.lang.String WRITING_STATUS
public static final java.lang.String WRITING_STATUS_YES
WRITING_STATUS
public static final java.lang.String WRITING_STATUS_NO
WRITING_STATUS
public static final java.lang.String WRITING_STATUS_SEPARATORS
WRITING_STATUS
Constructor Detail |
public RPrinter()
public RPrinter(AS400 system, java.lang.String name)
system
- The system.name
- The printer device name.Method Detail |
protected void commitAttributeChanges(java.lang.Object[] attributeIDs, java.lang.Object[] values, int[] bidiStringTypes) throws ResourceException
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.protected void establishConnection() throws ResourceException
The method is called by the resource framework automatically when the connection needs to be established.
protected void freezeProperties() throws ResourceException
The method is called by the resource framework automatically when the properties need to be frozen.
public java.lang.Object getAttributeUnchangedValue(java.lang.Object attributeID, int bidiStringType) throws ResourceException
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.public java.lang.String getName()
protected boolean isBidiEnabled()
public void refreshAttributeValues() throws ResourceException
public void setName(java.lang.String name) throws java.beans.PropertyVetoException
name
- The printer device name.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |