com.ibm.as400.access
Class OutputQueue
java.lang.Object
|
+--com.ibm.as400.access.PrintObject
|
+--com.ibm.as400.access.OutputQueue
- public class OutputQueue
- extends PrintObject
- implements java.io.Serializable
The OutputQueue class represents an AS/400 output queue.
An instance of this class can be used to manipulate an individual
AS/400 output queue (hold, release, clear, and so on).
See Output Queue Attributes for
valid attributes.
- See Also:
- Serialized Form
Fields inherited from class com.ibm.as400.access.PrintObject |
ATTR_AFP,
ATTR_AFP_RESOURCE,
ATTR_ALIGN,
ATTR_ALIGNFORMS,
ATTR_ALWDRTPRT,
ATTR_AUTHCHCK,
ATTR_AUTHORITY,
ATTR_AUTOEND,
ATTR_BACK_OVERLAY,
ATTR_BKMGN_ACR,
ATTR_BKMGN_DWN,
ATTR_BKOVL_ACR,
ATTR_BKOVL_DWN,
ATTR_BTWNCPYSTS,
ATTR_BTWNFILESTS,
ATTR_CHANGES,
ATTR_CHAR_ID,
ATTR_CODEDFNT,
ATTR_CODEDFNTLIB,
ATTR_CODEPAGE,
ATTR_CONTROLCHAR,
ATTR_CONVERT_LINEDATA,
ATTR_COPIES,
ATTR_COPIESLEFT,
ATTR_CORNER_STAPLE,
ATTR_CPI,
ATTR_CURPAGE,
ATTR_DATA_QUEUE,
ATTR_DATAFORMAT,
ATTR_DATE,
ATTR_DATE_WTR_BEGAN_FILE,
ATTR_DATE_WTR_CMPL_FILE,
ATTR_DBCSCPI,
ATTR_DBCSDATA,
ATTR_DBCSEXTENSN,
ATTR_DBCSROTATE,
ATTR_DBCSSISO,
ATTR_DELETESPLF,
ATTR_DESCRIPTION,
ATTR_DESTINATION,
ATTR_DESTOPTION,
ATTR_DEVCLASS,
ATTR_DEVMODEL,
ATTR_DEVSTATUS,
ATTR_DEVTYPE,
ATTR_DFR_WRITE,
ATTR_DISPLAYANY,
ATTR_DRWRSEP,
ATTR_DUPLEX,
ATTR_EDGESTITCH_NUMSTAPLES,
ATTR_EDGESTITCH_REF,
ATTR_EDGESTITCH_REFOFF,
ATTR_ENDPAGE,
ATTR_ENDPNDSTS,
ATTR_ENVLP_SOURCE,
ATTR_FIDELITY,
ATTR_FILESEP,
ATTR_FOLDREC,
ATTR_FONTID,
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_HELDSTS,
ATTR_HOLD,
ATTR_HOLDPNDSTS,
ATTR_HOLDTYPE,
ATTR_INTERNETADDR,
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_JOBUSER,
ATTR_JUSTIFY,
ATTR_LASTPAGE,
ATTR_LIBRARY,
ATTR_LINESPACING,
ATTR_LPI,
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_NUMWRITERS,
ATTR_OBJEXTATTR,
ATTR_ONJOBQSTS,
ATTR_OPCNTRL,
ATTR_OPENCMDS,
ATTR_ORDER,
ATTR_OUTPTY,
ATTR_OUTPUT_QUEUE,
ATTR_OUTPUTBIN,
ATTR_OUTQSTS,
ATTR_OVERALLSTS,
ATTR_OVERFLOW,
ATTR_PAGE_AT_A_TIME,
ATTR_PAGE_DEFINITION,
ATTR_PAGELEN,
ATTR_PAGENUMBER,
ATTR_PAGES,
ATTR_PAGES_EST,
ATTR_PAGEWIDTH,
ATTR_PAGRTT,
ATTR_PAPER_SOURCE_1,
ATTR_PAPER_SOURCE_2,
ATTR_PELDENSITY,
ATTR_POINTSIZE,
ATTR_PRINTER,
ATTR_PRINTER_FILE,
ATTR_PRTASSIGNED,
ATTR_PRTDEVTYPE,
ATTR_PRTQUALITY,
ATTR_PRTSEQUENCE,
ATTR_PRTTEXT,
ATTR_RECLENGTH,
ATTR_REDUCE,
ATTR_RESTART,
ATTR_RMTPRTQ,
ATTR_RMTSYSTEM,
ATTR_RPLCHAR,
ATTR_RPLUNPRT,
ATTR_SADDLESTITCH_NUMSTAPLES,
ATTR_SADDLESTITCH_REF,
ATTR_SAVE,
ATTR_SCHEDULE,
ATTR_SCS2ASCII,
ATTR_SEEKOFF,
ATTR_SEEKORG,
ATTR_SENDPTY,
ATTR_SEPPAGE,
ATTR_SPLF_AUTH_METHOD,
ATTR_SPLF_SECURITY_METHOD,
ATTR_SPLFNUM,
ATTR_SPLFSTATUS,
ATTR_SPLSCS,
ATTR_SPOOL,
ATTR_SPOOLFILE,
ATTR_SRCDRWR,
ATTR_STARTEDBY,
ATTR_STARTPAGE,
ATTR_SYSTEM,
ATTR_TIME,
ATTR_TIME_WTR_BEGAN_FILE,
ATTR_TIME_WTR_CMPL_FILE,
ATTR_TOADDRESS,
ATTR_TOUSERID,
ATTR_UNITOFMEAS,
ATTR_USER_DEFINED_OBJECT,
ATTR_USER_DRIVER_PROG,
ATTR_USER_TRANSFORM_PROG,
ATTR_USERCMT,
ATTR_USERDATA,
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 |
Constructor Summary |
OutputQueue()
Constructs an OutputQueue object. |
OutputQueue(AS400 system,
java.lang.String queueName)
Constructs an OutputQueue object. |
Method Summary |
void |
addOutputQueueListener(OutputQueueListener listener)
Adds the specified OutputQueue listener to receive
OutputQueue events from this OutputQueue. |
void |
clear(PrintParameterList clearOptions)
Clears the output queue on the AS/400. |
java.lang.String |
getName()
Returns the name of the output queue. |
java.lang.String |
getPath()
Returns the integrated file system pathname of the output queue. |
void |
hold()
Holds the output queue on the AS/400. |
void |
release()
Releases a held output queue on the AS/400. |
void |
removeOutputQueueListener(OutputQueueListener listener)
Removes the specified OutputQueue listener
so that it no longer receives OutputQueue events
from this OutputQueue. |
void |
setPath(java.lang.String path)
Sets the integrated file system pathname of the output queue. |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
OutputQueue
public OutputQueue()
- Constructs an OutputQueue object. The AS/400 system and the
integrated file system name of the output queue must be set
later. This constructor is provided for visual application
builders that support JavaBeans. It is not intended for use
by application programmers.
- See Also:
PrintObject.setSystem(com.ibm.as400.access.AS400)
,
setPath(java.lang.String)
OutputQueue
public OutputQueue(AS400 system,
java.lang.String queueName)
- Constructs an OutputQueue object. It uses the specified system and
output queue name that identifies it on that system.
- Parameters:
system
- The AS/400 on which this output queue exists.queueName
- The integrated file system name of the output queue. The format of
the queue string must be in the format of /QSYS.LIB/libname.LIB/queuename.OUTQ.
addOutputQueueListener
public void addOutputQueueListener(OutputQueueListener listener)
- Adds the specified OutputQueue listener to receive
OutputQueue events from this OutputQueue.
- Parameters:
listener
- The OutputQueue listener.- See Also:
removeOutputQueueListener(com.ibm.as400.access.OutputQueueListener)
clear
public void clear(PrintParameterList clearOptions)
throws AS400Exception,
AS400SecurityException,
ErrorCompletingRequestException,
java.io.IOException,
java.lang.InterruptedException,
RequestNotSupportedException
- Clears the output queue on the AS/400.
- Parameters:
clearOptions
- A PrintParameterList object that may have any of the
following attributes set:
-
ATTR_JOBUSER - Clear output queue by a user id. May be a specific userid, "*ALL" or
"*CURRENT". "*CURRENT" is the default.
-
ATTR_FORMTYPE - Clear output queue by a form type. May be a specific form type, "*ALL" or
"*STD". "*ALL" is the default.
-
ATTR_USERDATA - Clear output queue by user data. May be a specific user data or "*ALL".
"*ALL" is the default.
clearOptions may be null.- 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 output queue.
- Returns:
- The name of the output queue.
getPath
public java.lang.String getPath()
- Returns the integrated file system pathname of the output queue.
- Returns:
- The integrated file system pathname of the output queue.
hold
public void hold()
throws AS400Exception,
AS400SecurityException,
ErrorCompletingRequestException,
java.io.IOException,
java.lang.InterruptedException,
RequestNotSupportedException
- Holds the output queue on the AS/400.
- 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.
release
public void release()
throws AS400Exception,
AS400SecurityException,
ErrorCompletingRequestException,
java.io.IOException,
java.lang.InterruptedException,
RequestNotSupportedException
- Releases a held output queue on the AS/400.
- 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.
removeOutputQueueListener
public void removeOutputQueueListener(OutputQueueListener listener)
- Removes the specified OutputQueue listener
so that it no longer receives OutputQueue events
from this OutputQueue.
- Parameters:
listener
- The OutputQueue listener.- See Also:
addOutputQueueListener(com.ibm.as400.access.OutputQueueListener)
setPath
public void setPath(java.lang.String path)
throws java.beans.PropertyVetoException
- Sets the integrated file system pathname of the output queue.
- Parameters:
path
- The integrated file system pathname of the output queue. The format of
the queue string must be in the format of /QSYS.LIB/libname.LIB/queuename.OUTQ.- Throws:
- java.beans.PropertyVetoException - If the change is vetoed.