com.ibm.as400.access
Class WriterJob

java.lang.Object
  |
  +--com.ibm.as400.access.PrintObject
        |
        +--com.ibm.as400.access.WriterJob

All Implemented Interfaces:

java.io.Serializable

public class WriterJob

extends PrintObject

The WriterJob class represents an AS/400 writer job. An instance of this class can be used to manipulate an individual AS/400 writer. Use the start method to obtain a instance of this class. See Writer Job Attributes for valid attributes.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ibm.as400.access.PrintObject

ATTR_3812SCS, ATTR_ACCOUNT_CODE, ATTR_AFP, ATTR_AFP_RESOURCE, ATTR_AFPRESOURCE, ATTR_ALIGN, ATTR_ALIGNFORMS, ATTR_ALWDRTPRT, ATTR_ASCIITRANS, ATTR_ASPDEVICE, ATTR_AUTHCHCK, ATTR_AUTHORITY, ATTR_AUTOEND, ATTR_AUX_POOL, ATTR_BACK_OVERLAY, ATTR_BARCODE, ATTR_BKMGN_ACR, ATTR_BKMGN_DWN, ATTR_BKOVL_ACR, ATTR_BKOVL_DWN, ATTR_BTWNCPYSTS, ATTR_BTWNFILESTS, ATTR_CHANGES, ATTR_CHAR_ID, ATTR_CHARID, ATTR_CHR_RTT_CMDS, ATTR_CHRSET, ATTR_CHRSET_LIB, ATTR_CHRSET_SIZE, ATTR_CODEDFNT, ATTR_CODEDFNTLIB, ATTR_CODEDFONT_SIZE, ATTR_CODEPAGE, ATTR_CODEPAGE_NAME, ATTR_CODEPAGE_NAME_LIB, ATTR_CODFNT_ARRAY, ATTR_COLOR, ATTR_CONSTBCK_OVL, ATTR_CONTROLCHAR, ATTR_CONVERT_LINEDATA, ATTR_COPIES, ATTR_COPIESLEFT, ATTR_CORNER_STAPLE, ATTR_CPI, ATTR_CPI_CHANGES, ATTR_CURPAGE, ATTR_DATA_QUEUE, ATTR_DATAFORMAT, ATTR_DATE, ATTR_DATE_END, ATTR_DATE_USED, ATTR_DATE_WTR_BEGAN_FILE, ATTR_DATE_WTR_CMPL_FILE, ATTR_DBCS_FNT, ATTR_DBCS_FNT_LIB, ATTR_DBCS_FNT_SIZE, ATTR_DBCSCPI, ATTR_DBCSDATA, ATTR_DBCSEXTENSN, ATTR_DBCSROTATE, ATTR_DBCSSISO, ATTR_DDS, ATTR_DECIMAL_FMT, ATTR_DELETESPLF, ATTR_DESCRIPTION, ATTR_DESTINATION, ATTR_DESTOPTION, ATTR_DEVCLASS, ATTR_DEVMODEL, ATTR_DEVSTATUS, ATTR_DEVTYPE, ATTR_DFR_WRITE, ATTR_DISPLAYANY, ATTR_DOUBLEWIDE, ATTR_DRAWERCHANGE, ATTR_DRWRSEP, ATTR_DUPLEX, ATTR_EDGESTITCH_NUMSTAPLES, ATTR_EDGESTITCH_REF, ATTR_EDGESTITCH_REFOFF, ATTR_ENDPAGE, ATTR_ENDPNDSTS, ATTR_ENVLP_SOURCE, ATTR_FIDELITY, ATTR_FIELD_OUTLIN, ATTR_FILESEP, ATTR_FOLDREC, ATTR_FONT_CHANGES, ATTR_FONTID, ATTR_FONTRESFMT, ATTR_FORM_DEFINITION, ATTR_FORMFEED, ATTR_FORMTYPE, ATTR_FORMTYPEMSG, ATTR_FRONT_OVERLAY, ATTR_FTMGN_ACR, ATTR_FTMGN_DWN, ATTR_FTOVL_ACR, ATTR_FTOVL_DWN, ATTR_GRAPHICS, ATTR_GRAPHICS_TOK, ATTR_GRPLVL_IDXTAG, ATTR_HELDSTS, ATTR_HIGHLIGHT, ATTR_HOLD, ATTR_HOLDPNDSTS, ATTR_HOLDTYPE, ATTR_IMGCFG, ATTR_INTERNETADDR, ATTR_IPDSPASSTHRU, ATTR_IPP_ATTR_CCSID, ATTR_IPP_ATTR_NL, ATTR_IPP_JOB_ID, ATTR_IPP_JOB_NAME, ATTR_IPP_JOB_NAME_NL, ATTR_IPP_JOB_ORIGUSER, ATTR_IPP_JOB_ORIGUSER_NL, ATTR_IPP_PRINTER_NAME, ATTR_JOBNAME, ATTR_JOBNUMBER, ATTR_JOBSEPRATR, ATTR_JOBSYSTEM, ATTR_JOBUSER, ATTR_JUSTIFY, ATTR_LASTPAGE, ATTR_LIBRARY, ATTR_LINESPACING, ATTR_LPI, ATTR_LPI_CHANGES, ATTR_MAX_JOBS_PER_CLIENT, ATTR_MAXRCDS, ATTR_MEASMETHOD, ATTR_MESSAGE_QUEUE, ATTR_MFGTYPE, ATTR_MSGHELP, ATTR_MSGID, ATTR_MSGREPLY, ATTR_MSGSEV, ATTR_MSGTEXT, ATTR_MSGTYPE, ATTR_MULTI_ITEM_REPLY, ATTR_MULTIUP, ATTR_NETWORK, ATTR_NPSCCSID, ATTR_NPSLEVEL, ATTR_NUMBYTES, ATTR_NUMBYTES_SPLF, ATTR_NUMFILES, ATTR_NUMRSC_LIB_ENT, ATTR_NUMWRITERS, ATTR_OBJEXTATTR, ATTR_OFFICEVISION, ATTR_ONJOBQSTS, ATTR_OPCNTRL, ATTR_OPENCMDS, ATTR_ORDER, ATTR_OS4_CRT_AFP, ATTR_OUTPTY, ATTR_OUTPUT_QUEUE, ATTR_OUTPUTBIN, ATTR_OUTQSTS, ATTR_OVERALLSTS, ATTR_OVERFLOW, ATTR_PAGE_AT_A_TIME, ATTR_PAGE_DEFINITION, ATTR_PAGE_GROUPS, ATTR_PAGE_ROTATE, ATTR_PAGELEN, ATTR_PAGELVLIDXTAG, ATTR_PAGENUMBER, ATTR_PAGES, ATTR_PAGES_EST, ATTR_PAGEWIDTH, ATTR_PAGRTT, ATTR_PAPER_SOURCE_1, ATTR_PAPER_SOURCE_2, ATTR_PELDENSITY, ATTR_PGM_OPN_FILE, ATTR_PGM_OPN_LIB, ATTR_POINTSIZE, ATTR_PRINTER, ATTR_PRINTER_FILE, ATTR_PRTASSIGNED, ATTR_PRTDEVTYPE, ATTR_PRTQUALITY, ATTR_PRTSEQUENCE, ATTR_PRTTEXT, ATTR_PUBINF_COLOR_SUP, ATTR_PUBINF_DS, ATTR_PUBINF_DUPLEX_SUP, ATTR_PUBINF_LOCATION, ATTR_PUBINF_PPM, ATTR_PUBINF_PPM_COLOR, ATTR_RCDFMT_DATA, ATTR_RECLENGTH, ATTR_REDUCE, ATTR_RESTART, ATTR_RMTLOCNAME, ATTR_RMTPRTQ, ATTR_RMTSYSTEM, ATTR_RPLCHAR, ATTR_RPLUNPRT, ATTR_RSC_LIB_LIST, ATTR_SADDLESTITCH_NUMSTAPLES, ATTR_SADDLESTITCH_REF, ATTR_SADDLESTITCH_STPL_OFFSEINFO, ATTR_SAVE, ATTR_SCHEDULE, ATTR_SCS2ASCII, ATTR_SEEKOFF, ATTR_SEEKORG, ATTR_SENDPTY, ATTR_SEPPAGE, ATTR_SPLF_AUTH_METHOD, ATTR_SPLF_CREATOR, ATTR_SPLF_SECURITY_METHOD, ATTR_SPLF_SIZE, ATTR_SPLF_SIZE_MULT, ATTR_SPLFNUM, ATTR_SPLFSTATUS, ATTR_SPLSCS, ATTR_SPOOL, ATTR_SPOOLFILE, ATTR_SRC_CODEPAGE, ATTR_SRCDRWR, ATTR_STARTEDBY, ATTR_STARTPAGE, ATTR_SYS_DRV_PGM, ATTR_SYSTEM, ATTR_TGT_CODEPAGE, ATTR_TIME, ATTR_TIME_END, ATTR_TIME_WTR_BEGAN_FILE, ATTR_TIME_WTR_CMPL_FILE, ATTR_TOADDRESS, ATTR_TOUSERID, ATTR_TRC1403, ATTR_UNITOFMEAS, ATTR_USER_DEFINED_OBJECT, ATTR_USER_DFN_TXT, ATTR_USER_DRIVER_PROG, ATTR_USER_TRANSFORM_PROG, ATTR_USERCMT, ATTR_USERDATA, ATTR_USERGEN_DATA, ATTR_USRDEFDATA, ATTR_USRDEFFILE, ATTR_USRDEFOPT, ATTR_USRDRVDATA, ATTR_VIEWING_FIDELITY, ATTR_VMMVSCLASS, ATTR_WORKSTATION_CUST_OBJECT, ATTR_WRTNGSTS, ATTR_WTNGDATASTS, ATTR_WTNGDEVSTS, ATTR_WTNGMSGSTS, ATTR_WTRAUTOEND, ATTR_WTREND, ATTR_WTRINIT, ATTR_WTRJOBNAME, ATTR_WTRJOBNUM, ATTR_WTRJOBSTS, ATTR_WTRJOBUSER, ATTR_WTRSTRPAGE, ATTR_WTRSTRTD

Method Summary

void	end(java.lang.String endType) Ends a writer on the AS/400.
java.lang.String	getName() Returns the name of the writer.
static WriterJob	start(AS400 system, Printer printer, PrintParameterList options, OutputQueue outputQueue) Starts a writer on the AS/400.

Methods inherited from class com.ibm.as400.access.PrintObject

addPropertyChangeListener, addVetoableChangeListener, getFloatAttribute, getIntegerAttribute, getSingleFloatAttribute, getSingleIntegerAttribute, getSingleStringAttribute, getStringAttribute, getSystem, removePropertyChangeListener, removeVetoableChangeListener, setSystem, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

end

public void end(java.lang.String endType)
         throws AS400Exception,
                AS400SecurityException,
                ErrorCompletingRequestException,
                java.io.IOException,
                java.lang.InterruptedException,
                RequestNotSupportedException

Ends a writer on the AS/400.

Parameters:

endType - When to end the writer. May be any of the following values:

• *CNTRLD - The writer is ended at the end of the current spooled file.
• *IMMED - The writer is ended immediately.
• *PAGEEND - The writer is ended at the end of the current page.

endType may be null. If endType is not specified, the default is *IMMED.

Throws:

AS400Exception - If the AS/400 system returns an error message.

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

java.io.IOException - If an error occurs while communicating with the AS/400.

java.lang.InterruptedException - If this thread is interrupted.

RequestNotSupportedException - If the requested function is not supported because the AS/400 system is not at the correct level.

getName

public java.lang.String getName()

Returns the name of the writer.

Returns:

The name of the writer.

start

public static WriterJob start(AS400 system,
                              Printer printer,
                              PrintParameterList options,
                              OutputQueue outputQueue)
                       throws AS400Exception,
                              AS400SecurityException,
                              ErrorCompletingRequestException,
                              java.io.IOException,
                              java.lang.InterruptedException

Starts a writer on the AS/400. Use this method to start a new writer job on the given AS/400 with the specified parameters.

Parameters:

system - The system on which to start the writer job.

printer - The printer that should be used to start the writer job. This printer must reside on the same AS/400 system that the writer job is being started.

options - Optional. A print parameter list that contains a list of attributes to start the writer job. The output queue parameters set in this list override the output queue parameter. The following parameters may be set:

• ATTR_ALIGN - Align page
• ATTR_ALWDRTPRT - Allow direct print
• ATTR_AUTOEND - Automatically end writer
• ATTR_DRWRSEP - Drawer for separators
• ATTR_FILESEP - File separators
• ATTR_FORMTYPE - Form type
• ATTR_WTRINIT - Initialize the writer
• ATTR_JOBNAME - Job name
• ATTR_JOBNUMBER - Job number
• ATTR_JOBUSER - Job user
• ATTR_FORMTYPEMSG - Form type message option
• ATTR_MESSAGE_QUEUE - Message queue integrated file system name
• ATTR_OUTPUT_QUEUE - Output queue integrated file system name
• ATTR_SPOOLFILE - Spooled file name
• ATTR_SPLFNUM - Spooled file number
• ATTR_WTRAUTOEND - When to automatically end writer
• ATTR_WTRSTRPAGE - Writer starting page
• ATTR_WTRJOBNAME - Writer job name

outputQueue - Optional. The output queue to start the writer job. The output queue must reside on the same AS/400 system that the writer job is being created.

Returns:

A writer job object that was created.

Throws:

AS400Exception - If the AS/400 system returns an error message.

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

java.io.IOException - If an error occurs while communicating with the AS/400.

java.lang.InterruptedException - If this thread is interrupted.