|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.as400.access.PrintObject | +--com.ibm.as400.access.OutputQueue
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.
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 com.ibm.as400.access.PrintObject |
addPropertyChangeListener, addVetoableChangeListener, getFloatAttribute, getIntegerAttribute, getStringAttribute, getSystem, removePropertyChangeListener, removeVetoableChangeListener, setSystem, update |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public OutputQueue()
PrintObject.setSystem(com.ibm.as400.access.AS400)
,
setPath(java.lang.String)
public OutputQueue(AS400 system, java.lang.String queueName)
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.Method Detail |
public void addOutputQueueListener(OutputQueueListener listener)
listener
- The OutputQueue listener.removeOutputQueueListener(com.ibm.as400.access.OutputQueueListener)
public void clear(PrintParameterList clearOptions) throws AS400Exception, AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, java.lang.InterruptedException, RequestNotSupportedException
clearOptions
- A PrintParameterList object that may have any of the
following attributes set:
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.public java.lang.String getName()
public java.lang.String getPath()
public void hold() throws AS400Exception, AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, java.lang.InterruptedException, RequestNotSupportedException
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.public void release() throws AS400Exception, AS400SecurityException, ErrorCompletingRequestException, java.io.IOException, java.lang.InterruptedException, RequestNotSupportedException
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.public void removeOutputQueueListener(OutputQueueListener listener)
listener
- The OutputQueue listener.addOutputQueueListener(com.ibm.as400.access.OutputQueueListener)
public void setPath(java.lang.String path) throws java.beans.PropertyVetoException
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.java.beans.PropertyVetoException
- If the change is vetoed.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |