All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.as400.access.WriterJob
java.lang.Object
|
+----com.ibm.as400.access.PrintObject
|
+----com.ibm.as400.access.WriterJob
- 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.
-
end(String)
- Ends a writer on the AS/400.
-
getName()
- Returns the name of the writer.
-
start(AS400, Printer, PrintParameterList, OutputQueue)
- Starts a writer on the AS/400.
end
public void end(String endType) throws AS400Exception, AS400SecurityException, ErrorCompletingRequestException, IOException, 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.
- Throws: AS400SecurityException
- If a security or authority error occurs.
- Throws: ErrorCompletingRequestException
- If an error occurs before the request is completed.
- Throws: IOException
- If an error occurs while communicating with the AS/400.
- Throws: InterruptedException
- If this thread is interrupted.
- Throws: RequestNotSupportedException
- If the requested function is not supported because the
AS/400 system is not at the correct level.
getName
public 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, IOException, 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:
- 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.
- Throws: AS400SecurityException
- If a security or authority error occurs.
- Throws: ErrorCompletingRequestException
- If an error occurs before the request is completed.
- Throws: IOException
- If an error occurs while communicating with the AS/400.
- Throws: InterruptedException
- If this thread is interrupted.
All Packages Class Hierarchy This Package Previous Next Index