All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.access.Job

java.lang.Object
   |
   +----com.ibm.as400.access.Job

public class Job
extends Object
implements Serializable
The Job class represents an AS/400 job. You can get and set the attribute of the job in the system. In Job there is a cache to store the changed value which will be set to the system. You can use cacheChanges and commitChanges to store the change values, or change the value to system directly. Here is a example showing how to use cache when setting value and getting value:

  try {
      // Creates AS400 object.
      AS400 as400 = new AS400("systemName");
      // Constructs a Job object
      Job job = new Job(as400,"QDEV002");
      // Gets job information
      System.out.println("User of this job : "+job.getUser());
      System.out.println("CPU used : "+job.getCPUUsed();
      System.out.println("Job enter system date : "+job.getJobEnterSystemDate());
      // Sets cache mode
      job.setCacheChanges(true);
      // Changes will be store in the cache.
      job.setRunPriority(66);
      job.setDateFormat("*YMD");
      // Commit changes, this will set the value to system.
      job.commitChanges();
      // Set job information to system directly(without cache).
      job.setCacheChanges(false);
      job.setRunPriority(60);
  } catch (Exception e)
  {
      System.out.println("error : "+e)
  }
 


Constructor Index

 o Job(AS400, String)
Constructs a Job object.
 o Job(AS400, String, String, String)
Constructs a Job object.

Method Index

 o commitChanges()
Commits the updated job information to the AS/400.
 o getAuxiliaryIORequests()
Returns the number of auxiliary storage input or output requests.
 o getBreakMessageHandling()
Returns the break message handling method.
 o getCacheChanges()
Returns the value indicating whether the changes are cached.
 o getCodedCharacterSetID()
Returns the coded character set identifier for this job.
 o getCompletionStatus()
Returns the completion status of the job.
 o getCountryID()
Returns the country identifier associated with this job.
 o getCPUUsed()
Returns the amount of processing time that the job used, in milliseconds.
 o getCurrentLibrary()
Returns the name of the current library for the initial thread of the job.
 o getCurrentLibraryExistence()
Returns the current library existence field.
 o getDate()
Returns the date and time when the job was placed on the system.
 o getDateFormat()
Returns the date format.
 o getDateSeparator()
Returns the date separator.
 o getDDMConversationHandling()
Returns the DDM conversation handling.
 o getDecimalFormat()
Returns the decimal format used for this job.
 o getDefaultCodedCharacterSetIdentifier()
Returns the default coded character set identifier used for this job.
 o getDefaultWait()
Returns the default wait time (in seconds).
 o getDeviceRecoveryAction()
Returns the device recovery action.
 o getEndSeverity()
Returns the end severity.
 o getFunctionName()
Returns additional information, as described in the function type field, about the function the initial thread is currently performing.
 o getFunctionType()
Returns a value indicating if the initial thread is performing a high-level function and what the function type is.
 o getInquiryMessageReply()
Returns the inquiry message reply method.
 o getInteractiveTransactions()
Returns the number of interactive transactions.
 o getJobAccountingCode()
Returns the job accounting code.
 o getJobActiveDate()
Returns the date and time the job became active.
 o getJobDate()
Returns the date assigned to the job.
 o getJobDescription()
Returns the full qualified integrated path of the job description.
 o getJobEnterSystemDate()
Returns the date and time the job entered the system.
 o getJobMessageQueueFullAction()
Returns the job message queue full action.
 o getJobMessageQueueMaximumSize()
Returns the job message queue maximum size.
 o getJobPutOnJobQueueDate()
Returns the date and time the job was put on the job queue.
 o getJobStatusInJobQueue()
Returns the status of the job on the job queue.
 o getJobSwitches()
Returns the current setting of the job switches used for the job.
 o getLanguageID()
Returns the language identifier associated with this job.
 o getLoggingCLPrograms()
Returns the value indicating whether or not messages are logged for CL programs that are run.
 o getLoggingLevel()
Returns the logging level.
 o getLoggingSeverity()
Returns the logging severity.
 o getLoggingText()
Returns the logging text.
 o getModeName()
Returns the mode name.
 o getName()
Returns the job name.
 o getNumber()
Returns the job number.
 o getNumberOfLibrariesInSYSLIBL()
Returns the number of libraries in the system part of the library list of the initial thread.
 o getNumberOfLibrariesInUSRLIBL()
Returns the number of libraries in the user library list of the initial thread.
 o getNumberOfProductLibraries()
Returns the number of product libraries found in the library list of the initial thread.
 o getOutputQueue()
Returns the fully-qualified integrated file system path name of the output queue.
 o getOutputQueuePriority()
Returns the output priority for spooled files that this job produces.
 o getPoolIdentifier()
Returns the identifier of the system-related pool from which the job's main storage is allocated.
 o getPrinterDeviceName()
Returns the printer device name used for printing output from this job.
 o getPrintKeyFormat()
Returns the print key format.
 o getPrintText()
Returns the print text.
 o getProductLibraries()
Returns the libraries that contain product information for the initial thread.
 o getPurge()
Returns the value which indicates whether the job is eligible to be moved out of main storage and put into auxiliary storage at the end of a time slice or when beginning a long wait (such as waiting for a work station user's response).
 o getQueue()
Returns the fully-qualified integrated file system path name of the job queue that the job is currently on, or that the job is on when it is active.
 o getQueuePriority()
Returns the scheduling priority of the job compared to other jobs on the same job queue.
 o getRoutingData()
Returns the routing data that is used to determine the routing entry that identifies the program to start for the routing step.
 o getRunPriority()
Returns the priority at which the job is currently running, relative to other jobs on the system.
 o getScheduleDate()
Returns the date and time the job is scheduled to run.
 o getSignedOnJob()
Returns the value which indicates whether the job is to be treated like a signed-on user on the system.
 o getSortSequenceTable()
Returns the full qualified integrated file system path name of sort sequence table associated with this job.
 o getStatus()
Returns the job status.
 o getStatusMessageHandling()
Returns the value indicating whether you want status messages displayed for this job.
 o getSubsystem()
Returns the fully-qualified integrated file system path name of the subsystem description in which the job is running.
 o getSubtype()
Returns additional information about the job type.
 o getSystem()
Returns the AS/400 system from which the job information will be retrieved.
 o getSystemLibraryList()
Returns the system portion of the library list of the initial thread.
 o getTimeSeparator()
Returns the time separator.
 o getTimeSlice()
Gets the time slice (in milliseconds).
 o getTimeSliceEndPool()
Gets the key indicating whether interactive jobs are moved to another main storage pool at the end of the time slice.
 o getTotalResponseTime()
Returns the total amount of response time for the job, in milliseconds.
 o getType()
Returns the job type.
 o getUser()
Returns the user profile under which the job runs.
 o getUserLibraryList()
Returns the user portion of the library list for the initial thread.
 o getWorkIDUnit()
Returns the unit of work identifier.
 o loadInformation()
Loads job information from the AS/400.
 o setBreakMessageHandling(String)
Sets the break message handling.
 o setCacheChanges(boolean)
Sets the value indicating whether the changes are cached.
 o setCodedCharacterSetID(int)
Sets the coded character set identifier.
 o setCountryID(String)
Sets the country identifier.
 o setDateFormat(String)
Sets the date format.
 o setDateSeparator(String)
Sets the date separator.
 o setDDMConversationHandling(String)
Sets the DDM conversation handling.
 o setDecimalFormat(String)
Sets the decimal format.
 o setDefaultWait(int)
Sets the default wait time (in seconds).
 o setDeviceRecoveryAction(String)
Sets the device recovery action.
 o setInquiryMessageReply(String)
Sets the inquiry message reply.
 o setJobAccountingCode(String)
Sets the job accounting code.
 o setJobDate(Date)
Sets the date that is assigned to the job.
 o setJobMessageQueueFullAction(String)
Sets the job message queue full action.
 o setJobSwitches(String)
Sets the job switches used by this job.
 o setLanguageID(String)
Sets the language identifier that is associated with this job.
 o setLoggingCLPrograms(String)
Sets the value indicating whether or not messages are logged for CL programs that are run.
 o setLoggingLevel(int)
Sets the logging level.
 o setLoggingSeverity(int)
Sets the logging severity.
 o setLoggingText(String)
Sets the logging text.
 o setOutputQueue(String)
Sets the output queue.
 o setOutputQueuePriority(int)
Sets the output queue priority.
 o setPrinterDeviceName(String)
Sets the printer device name.
 o setPrintKeyFormat(String)
Sets the print key format.
 o setPrintText(String)
Sets the print text.
 o setPurge(boolean)
Sets the value indicating whether or not the job is eligible to be moved out of main storage and put into auxiliary storage at the end of a time slice or when entering a long wait (such as waiting for a work station user's response).
 o setQueue(String)
Sets the job queue.
 o setQueuePriority(int)
Sets the job queue priority.
 o setRunPriority(int)
Sets the run priority.
 o setScheduleDate(Date)
Sets the schedule date.
 o setScheduleDate(String)
Sets the schedule date.
 o setScheduleTime(Date)
Sets the schedule time.
 o setScheduleTime(String)
Sets the schedule time.
 o setSortSequenceTable(String)
Sets the sort sequence table.
 o setStatusMessageHandling(String)
Sets the status message handling.
 o setTimeSeparator(String)
Sets the time separator.
 o setTimeSlice(int)
Sets the time slice (in milliseconds).
 o setTimeSliceEndPool(String)
Sets the key whether you want interactive jobs moved to another main storage pool at the end of the time slice.
 o toString()
Returns the string representation of the job.

Constructors

 o Job
 public Job(AS400 system,
            String jobName,
            String userName,
            String jobNumber)
Constructs a Job object.

Parameters:
system - The AS/400 system.
jobName - The job name. It can be "*" or a specific job name. If "*" is specified, the other two parameters, userName and jobNumber, must be blank.
userName - The user profile name.
jobNumber - The job number.
 o Job
 public Job(AS400 system,
            String internalJobID)
Constructs a Job object.

Parameters:
system - The AS/400 system.
internalJobID - The internal job identifier.

Methods

 o commitChanges
 public void commitChanges() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Commits the updated job information to the AS/400.

Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getAuxiliaryIORequests
 public int getAuxiliaryIORequests() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the number of auxiliary storage input or output requests. This includes both database and nondatabase paging.

Returns:
The number of auxiliary storage input or output requests.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getBreakMessageHandling
 public String getBreakMessageHandling() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the break message handling method.

Returns:
The break message handling method. The possible values are:
  • "*NORMAL" - The message queue status determines break message handling.
  • "*HOLD" - The message queue holds break mesages until a user or program requests them.
  • "*NOTIFY" - The system notifies the job's message queue when a message arrives.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getCacheChanges
 public boolean getCacheChanges()
Returns the value indicating whether the changes are cached.

Returns:
The value indicating whether the changes are cached.
 o getCodedCharacterSetID
 public int getCodedCharacterSetID() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the coded character set identifier for this job. This attribute controls the type of CCSID conversion that occurs for display files, printer files, and panel groups.

Returns:
The coded character set identifier for this job.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getCompletionStatus
 public String getCompletionStatus() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the completion status of the job.

Returns:
The completion status of the job. The possible values are:
  • " " - The job has not completed.
  • "0" - The job completed normally.
  • "1" - The job completed abnormally.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getCountryID
 public String getCountryID() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the country identifier associated with this job.

Returns:
The country identifier associated with this job.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
setCountryID
 o getCPUUsed
 public int getCPUUsed() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the amount of processing time that the job used, in milliseconds.

Returns:
The amount of processing time that the job used, in milliseconds.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getCurrentLibrary
 public String getCurrentLibrary() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the name of the current library for the initial thread of the job. If no current library exists, an empty String is returned.

Returns:
The current library for the initial thread of the job.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getCurrentLibraryExistence
 public boolean getCurrentLibraryExistence() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the current library existence field.

Returns:
The current library existence field. Possible values are :
  • false - No current library exists.
  • true - A current library exists.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getDate
 public Date getDate() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the date and time when the job was placed on the system. This method is the same as getJobEnterSystemDate().

Returns:
The date and time when the job was placed on the system. This is null if the job did not become active.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getDateFormat
 public String getDateFormat() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the date format.

Returns:
The date format. The possible values are:
  • "*YMD" - Year, month, and day format.
  • "*MDY" - Month, day, and Year format.
  • "*DMY" - Day, month, and Year format.
  • "*JUL" - Julian format (year and day).
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getDateSeparator
 public String getDateSeparator() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the date separator. The date separator is used to separate days, months, and years when representing a date.

Returns:
The date separator. The possible values are :
  • "/" A slash (/) is used for the date separator.
  • "-" A dash (-) is used for the date separator.
  • "." A period (.) is used for the date separator.
  • " " A blank (/) is used for the date separator.
  • "," A comma (,) is used for the date separator.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getDDMConversationHandling
 public String getDDMConversationHandling() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the DDM conversation handling. It specifies whether connections using distributed data management (DDM) protocols remain active when they are not being used.

Returns:
The DDM conversation handling. The possible values are:
  • "*KEEP" - The system keeps DDM connections active when there are no users.
  • "*DROP" - The system ends a DDM connection when there are no users.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getDecimalFormat
 public String getDecimalFormat() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the decimal format used for this job.

Returns:
The decimal format used for this job. The possible values are:
  • " " - Uses a period for a decimal point, a comma for a 3-digit grouping character, and zero-suppress to the left of the decimal point.
  • "J"- Uses a period for a decimal point, a comma for a 3-digit grouping character, and zero-suppression character is in the second position (rather than the first) to the left of the decimal notation.
  • "l" - Uses a comma for a decimal point, a period for a 3-digit grouping character, and zero-suppress to the left of the decimal point.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getDefaultCodedCharacterSetIdentifier
 public int getDefaultCodedCharacterSetIdentifier() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the default coded character set identifier used for this job.

Returns:
The default coded character set identifier used for this job. It will be zero if the job is not an active job.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getDefaultWait
 public int getDefaultWait() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the default wait time (in seconds).

Returns:
The default wait time (in seconds).
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getDeviceRecoveryAction
 public String getDeviceRecoveryAction() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the device recovery action. It is the action taken for interactive jobs when an I/O error occurs for the job's requesting program device.

Returns:
The device recovery action. The possible values are:
  • "*MSG" - Signals the I/O error message to the application and lets the application program perform error recovery.
  • "*DSCMSG" - Disconnects the job when an I/O error occurs. When the job reconnects, the system sends an error message to the application program, indicating the job has reconnected and that the work station device has recovered.
  • "*DSCENDRQS" - Disconnects the job when an I/O error occurs. When the job reconnects, the system sends the End Request (ENDRQS) command to return control to the previous request level.
  • "*ENDJOB" - Ends the job when an I/O error occurs. A message is sent to the job's log and to the history log (QHST) indicating the job ended because of a device error.
  • "ENDJOBNOLIST" - Ends the job when an I/O error occurs. There is no job log produced for the job. The system sends a message to the QHST log indicating the job ended because of a device error.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getEndSeverity
 public int getEndSeverity() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the end severity. This is the message severity level of escape messages that can cause a batch job to end. The batch job ends when a request in the batch input stream sends an escape message, whose severity is equal to or greater than this value to the request processing program.

Returns:
The end severity.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getFunctionName
 public String getFunctionName() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns additional information, as described in the function type field, about the function the initial thread is currently performing. This information is updated only when a command is processed.

Returns:
The additional information, as described in the function bype field, about the function that the initial thread is currently performing.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getFunctionType
 o getFunctionType
 public String getFunctionType() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns a value indicating if the initial thread is performing a high-level function and what the function type is.

Returns:
The function type. Possible values are:
  • " " - The system is not doing a logged function.
  • "C" - A command is running interactively, or it is in a batch input stream, or it was requested from a system menu.
  • "D" - The job is processing a Delay Job (DLYJOB) command. The function name contains the number of seconds the job is delayed, or the time when the job is to resume processing, depending on how the command was specified.
  • "G" - The Transfer Group Job (TFRGRPJOB) command suspended the job. The function name contains the group job name.
  • "I" - The job is rebuilding an index (access path). The function name contains the name of the logical file whose index is rebuilt.
  • "L" - The system logs history information in a database file. The function name contains the name of the log.
  • "M" - The job is a multiple requester terminal (MRT) job or an interactive job attached to an MRT job.
  • "N" - The job is currently at a system menu. The function name contains the name of the menu.
  • "O" - The job is a subsystem monitor that is performing input/output operations to a workstation. The function name contains the name of the workstation device.
  • "P" - The job is running a program. The function name contains the name of the program.
  • "R" - The job is running a procedure. The function name contains the name of the procedure.
  • "*" - This is a special function. The function name contains an entry that further describes the special function.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getFunctionName
 o getInquiryMessageReply
 public String getInquiryMessageReply() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the inquiry message reply method.

Returns:
The inquiry message reply method. The possible values are:
  • "*RQD" - The job requires an answer for any inquiry messages that occur while this job is running.
  • "*DFT" - The system uses the default message reply to answer any inquiry message issued while this job is running. The default reply is either defined in the message description or is the default system reply.
  • "SYSRPYL" - The system reply list is checked to see if there is an entry for an inquiry message issued while this job is running. If a match occurs, the system uses the reply value for that entry. If no entry exists for that message, the system uses an inquiry message.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getInteractiveTransactions
 public int getInteractiveTransactions() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the number of interactive transactions.

Returns:
The number of interactive transactions. It will be zero if the job has no interactions.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getJobAccountingCode
 public String getJobAccountingCode() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the job accounting code. The job accounting code is an identifier assigned to the job by the system to collect resource use information for the job when job accounting is active. See AS/400 System API Reference for details.

Returns:
The job accounting code.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getJobActiveDate
 public Date getJobActiveDate() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the date and time the job became active.

Returns:
The date and time the job became active.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getJobDate
 public Date getJobDate() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the date assigned to the job. This value is for jobs whose status is *JOBQ or *ACTIVE. For jobs with a status of *OUTQ, the value for this field is null.

Returns:
The date assigned to the job.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getJobDescription
 public String getJobDescription() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the full qualified integrated path of the job description. For example, the return value would look like "QGPL/QDFTJOBD".

Returns:
The full qualified integrated path of the job description.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getJobEnterSystemDate
 public Date getJobEnterSystemDate() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the date and time the job entered the system.

Returns:
The date and time the job entered the system.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getJobMessageQueueFullAction
 public String getJobMessageQueueFullAction() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the job message queue full action. This is the action to take when the message queue is full.

Returns:
The job message queue full action. The possible values are:
  • "*NOWRAP" - When the job message queue is full, do not wrap. This action causes the job to end.
  • "*WRAP" - When the job message queue is full, wrap to the beginning and start filling again.
  • "*PRTWRAP" - When the job message queue is full, wrap the message queue and print the messages that are being overlaid because of the wrapping.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getJobMessageQueueMaximumSize
 public int getJobMessageQueueMaximumSize() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the job message queue maximum size.

Returns:
The job message queue maximum size. The range is 2 through 64.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getJobPutOnJobQueueDate
 public Date getJobPutOnJobQueueDate() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the date and time the job was put on the job queue.

Returns:
The date and time the job was put on the job queue.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getScheduleDate
 public Date getScheduleDate() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the date and time the job is scheduled to run.

Returns:
The date and time the job is scheduled to run.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
setScheduleDate, setScheduleTime
 o getJobStatusInJobQueue
 public String getJobStatusInJobQueue() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the status of the job on the job queue.

Returns:
The status of the job on the job queue, possible values are:
  • " " - This job was not on a job queue.
  • "SCD" - This job will run as schduled.
  • "HLD" - This job is being held on the job queue.
  • "RLS" - This job is ready to be selected.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getJobSwitches
 public String getJobSwitches() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the current setting of the job switches used for the job.

Returns:
The current setting of the job switches used for the job.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getLanguageID
 public String getLanguageID() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the language identifier associated with this job.

Returns:
The language identifier associated with this job.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
setLanguageID
 o getLoggingCLPrograms
 public String getLoggingCLPrograms() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the value indicating whether or not messages are logged for CL programs that are run.

Returns:
The value indicating whether or not messages are logged for CL programs that are run. Possible balues are: *YES and *NO.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getLoggingLevel
 public int getLoggingLevel() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the logging level. It indicates what type of information is logged.

Returns:
The logging level. The possible values are :
  • 0 No messages are logged.
  • 1 All messages sent to the job's external message queue with a severity greater than or equal to the message logging severity are logged.
  • 2 The following information is logged :
    • Level 1 information
    • Requests or commands from CL programs for which the system issues messages with a severity code greater than or equal to the logging severity.
    • All messages associated with those requests or commands that have a severity code greater than or equal to the logging severity.
  • 3 The following information is logged :
    • Level 1 information
    • All requests or commands from CL programs.
    • All messages associated with those requests or commands that have a severity greater than or equal to the logging severity.
    • All messages associated with those requests or commands that have a severity code greater than or equal to the logging severity.
  • 4 The following information is logged :
    • All requests or commands from CL programs.
    • All messages with a severity code greater than or equal to the logging severity.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getLoggingSeverity
 public int getLoggingSeverity() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the logging severity. This is the minimum severity level that causes error messages to be logged in the job log.

Returns:
The logging severity.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getLoggingText
 public String getLoggingText() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the logging text. This is the level of mesage text that is written in the job or displayed to the user when an error message is created according to the first two message logging values.

Returns:
The logging text. The possible values are:
  • "*MSG" - Only the mesage is written to the job log.
  • "*SECLVL" - Both the message and the message help for the error message is written to the job log.
  • "*NOLIST" - If the job ends normally, there is no job log. If the job ends abnormally (if the job end code is 20 or higher), there is a job log. The messages appearing in the job's log contain both the message and the message help.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getModeName
 public String getModeName() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the mode name. This is the mode name of the advanced program-to-program communications device that started the job.

Returns:
The mode name. The possible values are:
  • "*BLANK" - The mode name is *BLANK.
  • " " - The mode name is blank.
  • Mode name - The name of the mode.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getName
 public String getName()
Returns the job name.

Returns:
The job name.
 o getNumber
 public String getNumber()
Returns the job number.

Returns:
The job number.
 o getNumberOfLibrariesInSYSLIBL
 public int getNumberOfLibrariesInSYSLIBL() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the number of libraries in the system part of the library list of the initial thread.

Returns:
The number of libraries in the system part of the library list of the initial thread.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getNumberOfLibrariesInUSRLIBL
 public int getNumberOfLibrariesInUSRLIBL() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the number of libraries in the user library list of the initial thread.

Returns:
The number of libraries in the user library list of the initial thread.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getNumberOfProductLibraries
 public int getNumberOfProductLibraries() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the number of product libraries found in the library list of the initial thread.

Returns:
The number of product libraries found in the library list of the initial thread.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getOutputQueue
 public String getOutputQueue() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the fully-qualified integrated file system path name of the output queue.

Returns:
The fully-qualified integrated file system path name of the output queue.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getOutputQueuePriority
 public int getOutputQueuePriority() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the output priority for spooled files that this job produces.

Returns:
The output priority for spooled files that this job produces. The highest priority is 0, and the lower is 9.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getPoolIdentifier
 public int getPoolIdentifier() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the identifier of the system-related pool from which the job's main storage is allocated.

Returns:
The identifier of the system-related pool from which the job's main storage is allocated.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getPrinterDeviceName
 public String getPrinterDeviceName() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the printer device name used for printing output from this job.

Returns:
The printer device name used for printing output from this job.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getPrintKeyFormat
 public String getPrintKeyFormat() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the print key format. The print key format indicates whether border and header information is provided when the Print key is pressed.

Returns:
The print key format. The possible values are:
  • "*NONE" - The border and header information is not included with output from the Print key.
  • "*PRTBDR" - The border information is included with output from the Print key.
  • "*PRTHDR" - The header information is included with output from the Print key.
  • "*PRTALL" - The border and header information is included with output from the Print key.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getPrintText
 public String getPrintText() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the print text. This is the line of text (if any) that is printed at the bottom of each page of printer output for the job.

Returns:
The print text.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getProductLibraries
 public String[] getProductLibraries() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the libraries that contain product information for the initial thread. If there are no libraries in the product library list, an array of size 0 is returned.

Returns:
The libraries that contain product information for the initial thread.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getPurge
 public boolean getPurge() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the value which indicates whether the job is eligible to be moved out of main storage and put into auxiliary storage at the end of a time slice or when beginning a long wait (such as waiting for a work station user's response).

Returns:
The value which indicates whether the job is to be purged. The possible values are:
  • true - The job is eligible to be purged.
  • false - The job is not eligible to be purged.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getQueue
 public String getQueue() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the fully-qualified integrated file system path name of the job queue that the job is currently on, or that the job is on when it is active. This value is for jobs whose status is *JOBQ or *ACTIV. For jobs with a status of *OUTQ, the value for this field is blank.

Returns:
The fully-qualified integrated file system path name of the job queue that the job is currently on, or that the job is on when it is active.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getQueuePriority
 public int getQueuePriority() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the scheduling priority of the job compared to other jobs on the same job queue. The highest priority is 0 and the lowest is 9. This value is for jobs whose status is *JOBQ or *ACTIVE. For jobs with a status of *OUTQ, the value for this field is -1.

Returns:
The scheduling priority of the job.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getRoutingData
 public String getRoutingData() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the routing data that is used to determine the routing entry that identifies the program to start for the routing step.

Returns:
The routing data that is used to determine the routing entry that identifies the program to start for the routing step.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getRunPriority
 public int getRunPriority() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the priority at which the job is currently running, relative to other jobs on the system. The run priority ranges from 1(highest) to 99 (lowest).

Returns:
The priority at which the job is currently running.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getSignedOnJob
 public boolean getSignedOnJob() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the value which indicates whether the job is to be treated like a signed-on user on the system.

Returns:
The value which indicates whether the job is to be treated like a signed-on user on the system. The possible values are:
  • true - The job should be treated like a signed-on user.
  • false - The job should not be treated like a signed-on user.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getSortSequenceTable
 public String getSortSequenceTable() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the full qualified integrated file system path name of sort sequence table associated with this job.

Returns:
The full qualified integrated file system path name of sort sequence table associated with this job.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getStatus
 public String getStatus() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the job status.

Returns:
The job status. The possible values are:
  • "*ACTIVE" - Active jobs, this includes group jobs, system request jobs, and disconnected jobs.
  • "*JOBQ" - Jobs that are currently on job queues.
  • "*OUTQ" - Jobs that have completed running but still have output on an output queue.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getStatusMessageHandling
 public String getStatusMessageHandling() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the value indicating whether you want status messages displayed for this job.

Returns:
The value indicating whether you want status messages displayed for this job. The possible values are:
  • "*NONE" - The job does not display status message.
  • "*NORMAL" - The job displays status message.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getSubsystem
 public String getSubsystem() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the fully-qualified integrated file system path name of the subsystem description in which the job is running.

Returns:
The fully-qualified integrated file system path name of the subsystem description, or "" if the job is not active.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getSubtype
 public String getSubtype() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns additional information about the job type.

Returns:
The additional information about the job type. Possible values are:
  • " " - The job has no special subtype.
  • "D" - The job is an immediate job.
  • "E" - The job started with a procedure start request.
  • "F" - The job is an Advanced 36 server (M36) job.
  • "J" - The job is a prestart job.
  • "P" - The job is a print driver job.
  • "T" - The job is a System/36 multiple requester terminal (MRT) job.
  • "U" - Alternate spool user.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getSystem
 public AS400 getSystem()
Returns the AS/400 system from which the job information will be retrieved.

Returns:
The AS/400 system from which the job information will be retrieved.
 o getSystemLibraryList
 public String[] getSystemLibraryList() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the system portion of the library list of the initial thread. If there are no libraries in the system library list, an array of size 0 is returned.

Returns:
The system portion of the library list of the initial thread.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getTimeSeparator
 public String getTimeSeparator() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the time separator. This is the time separator used to separate hours, minutes, and seconds when representing a time.

Returns:
The time separator. The possible values are :
  • ":" A colon (:) is used for the time separator.
  • "." A period (.) is used for the time separator.
  • " " A blank ( ) is used for the time separator.
  • "," A comma (,) is used for the time separator.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getTimeSlice
 public int getTimeSlice() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Gets the time slice (in milliseconds). The time slice is the maximum amount of processor time (in milliseconds) given to threads in this job before other threads in this job are given the opportunity to run.

Returns:
The time slice (in milliseconds).
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getTimeSliceEndPool
 public String getTimeSliceEndPool() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Gets the key indicating whether interactive jobs are moved to another main storage pool at the end of the time slice.

Returns:
The time slice end pool setting.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getTotalResponseTime
 public int getTotalResponseTime() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the total amount of response time for the job, in milliseconds.

Returns:
The total amount of response time for the job, in milliseconds.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getType
 public String getType() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the job type.

Returns:
The job type. Possible values are:
  • " " - The job is not a valid job.
  • "A" - The job is an autostart job.
  • "B" - The job is a batch job.
  • "I" - The job is an interactive job.
  • "M" - The job is a subsystem monitor job.
  • "R" - The job is a spooled reader job.
  • "S" - The job is a system job.
  • "W" - The job is a spooled writer job.
  • "X" - The job is a SCPF system job.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getUser
 public String getUser()
Returns the user profile under which the job runs.

Returns:
The user profile under which the job runs.
 o getUserLibraryList
 public String[] getUserLibraryList() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the user portion of the library list for the initial thread. If there are no libraries in the user library list, an array of size 0 is returned.

Returns:
The user portion of the library list for the initial thread.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o getWorkIDUnit
 public String getWorkIDUnit() throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Returns the unit of work identifier. The unit of work identifier is used to track jobs across multiple systems. If a job is not associated with a source or target system using advanced program-to-program communications(APPC), this information is not used. Every job on the system is assigned a unit of work identifier. The unit-of-work identifier is made up of :

Returns:
The unit of work identifier.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o loadInformation
 public void loadInformation()
Loads job information from the AS/400. After calling this method, the next time a get() method is called, it will retrieve the information in its format from the AS/400 instead of from its own internal cache.

 o setBreakMessageHandling
 public void setBreakMessageHandling(String newHandling) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the break message handling.

Parameters:
newHandling - The new break message handling. Possible values are :
  • *NORMAL The message queue status determines break message handling.
  • *HOLD The message queue holds break messages until a user or program requests them. The work station user uses the Display Message(DSPMSG) command to display the messages a program must issue a Receive Message(RCVMSG) command to receive a message and handle it.
  • *NOTIFY The system notifies the job's message queue when a message arrives. For interactive jobs, the audible alarm sounds if there is one, and the message-waiting light comes on.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getBreakMessageHandling
 o setCacheChanges
 public synchronized void setCacheChanges(boolean useCache)
Sets the value indicating whether the changes are cached. If set to false the value information stored in the cache will be cleared.

Parameters:
useCache - The value indicating whether the changes are cached.
 o setCodedCharacterSetID
 public void setCodedCharacterSetID(int newID) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the coded character set identifier.

Parameters:
newID - The new CCSID.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getCodedCharacterSetID
 o setCountryID
 public void setCountryID(String newID) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the country identifier.

Parameters:
newID - The new country identifier. The possible values are :
  • *SYSVAL The system value QCNTRYID is used.
  • country-ID Specify the country identifier to be used by the job.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getCountryID, getCountryID
 o setDateFormat
 public void setDateFormat(String newFormat) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the date format.

Parameters:
newFormat - The new date format.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getDateFormat
 o setDateSeparator
 public void setDateSeparator(String newSeparator) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the date separator.

Parameters:
newSeparator - The new date separator.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getDateSeparator
 o setDDMConversationHandling
 public void setDDMConversationHandling(String newHandling) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the DDM conversation handling.

Parameters:
newHandling - The new DDM conversation handling.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getDDMConversationHandling
 o setDecimalFormat
 public void setDecimalFormat(String newFormat) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the decimal format.

Parameters:
newFormat - The new decimal format.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getDecimalFormat
 o setDefaultWait
 public void setDefaultWait(int newTime) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the default wait time (in seconds).

Parameters:
newTime - The new default wait time (in seconds).
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o setDeviceRecoveryAction
 public void setDeviceRecoveryAction(String newAction) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the device recovery action.

Parameters:
newAction - The new device recovery action.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getDeviceRecoveryAction
 o setInquiryMessageReply
 public void setInquiryMessageReply(String newReply) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the inquiry message reply.

Parameters:
newReply - The new inquiry message reply.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getInquiryMessageReply
 o setJobAccountingCode
 public void setJobAccountingCode(String newCode) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the job accounting code.

Parameters:
newCode - The new job accounting code.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getJobAccountingCode
 o setJobDate
 public void setJobDate(Date newDate) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the date that is assigned to the job.

Parameters:
newDate - The new job date.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getJobDate
 o setJobMessageQueueFullAction
 public void setJobMessageQueueFullAction(String newAction) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the job message queue full action. This is the action to take when the message queue is full. Valid values are:

Parameters:
newAction - - The new job message queue full action.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getJobMessageQueueFullAction
 o setJobSwitches
 public void setJobSwitches(String newSwitches) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the job switches used by this job.

Parameters:
newSwitches - The new job switches.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getJobSwitches
 o setLanguageID
 public void setLanguageID(String newID) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the language identifier that is associated with this job. The language identifier is used when *LANGIDUNQ OR *LANGIDSHR is specified on the sort sequence parameter. If the job CCSID is 65525, this parameter is also used to determine the value of the job default CCSID. The possible values are :

Parameters:
newID - The new language identifier.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getLanguageID, getLanguageID
 o setLoggingCLPrograms
 public void setLoggingCLPrograms(String newPrograms) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the value indicating whether or not messages are logged for CL programs that are run. The possible values are *YES and *NO.

Parameters:
newPrograms - The new logging of CL programs.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getLoggingCLPrograms
 o setLoggingLevel
 public void setLoggingLevel(int newLevel) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the logging level. It indicates what type of information is logged. The possible values are :

Parameters:
newLevel - The new logging level.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getLoggingLevel
 o setLoggingSeverity
 public void setLoggingSeverity(int newSeverity) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the logging severity. This is the minimum severity level that causes error messages to be logged in the job log.

Parameters:
newSeverity - The new logging severity.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getLoggingSeverity
 o setLoggingText
 public void setLoggingText(String newText) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the logging text. This is the level of message text that is written in the job log or displayed to the user when an error message is created. Possible values are:

Parameters:
newText - The new logging text.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getLoggingText
 o setOutputQueue
 public void setOutputQueue(String newOutq) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the output queue. This is the default output queue that is used for spooled output produced by this job. The default output queue is only for spooled printer files that specify *JOB for the output queue.

Parameters:
newOutq - The new output queue.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getOutputQueue
 o setOutputQueuePriority
 public void setOutputQueuePriority(int newPriority) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the output queue priority. The highest priority is 0, and the lowest is 9.

Parameters:
newPriority - The new output queue priority.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getOutputQueuePriority
 o setPrinterDeviceName
 public void setPrinterDeviceName(String newName) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the printer device name.

Parameters:
newName - The new printer device name.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getPrinterDeviceName
 o setPrintKeyFormat
 public void setPrintKeyFormat(String newFormat) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the print key format.

Parameters:
newFormat - The new print key format.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getPrintKeyFormat
 o setPrintText
 public void setPrintText(String newText) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the print text. This is the line of text (if any) that is printed at the bottom of each page of printed output for the job.

Parameters:
newText - The new print text.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getPrintText
 o setPurge
 public void setPurge(boolean isPurge) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the value indicating whether or not the job is eligible to be moved out of main storage and put into auxiliary storage at the end of a time slice or when entering a long wait (such as waiting for a work station user's response).

Parameters:
isPurge - The new indication whether or not the job is eligible to be moved out of main storage and put into auxiliary storage.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o setQueue
 public void setQueue(String newJobQueue) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the job queue.

Parameters:
newJobQueue - The new job queue.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getQueue
 o setQueuePriority
 public void setQueuePriority(int newPriority) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the job queue priority. This is the scheduling priority of the job compared to other jobs on the same job queue. This highest priority is 0 and the lowest is 9.

Parameters:
newPriority - The new job queue priority.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getQueuePriority
 o setRunPriority
 public void setRunPriority(int newPriority) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the run priority. This is the priority at which the job is currently running, relative to other jobs on the system.

Parameters:
newPriority - The new run priority. It ranges from 1 (highest) to 99 (lowest).
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getRunPriority
 o setScheduleDate
 public void setScheduleDate(Date newDate) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the schedule date.

Parameters:
newDate - The new schedule date.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getScheduleDate
 o setScheduleDate
 public void setScheduleDate(String newDate) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the schedule date.

Parameters:
newDate - The new schedule date.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getScheduleDate
 o setScheduleTime
 public void setScheduleTime(Date newTime) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the schedule time.

Parameters:
newTime - The new schedule time.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getScheduleDate
 o setScheduleTime
 public void setScheduleTime(String newTime) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the schedule time.

Parameters:
newTime - The new schedule time.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getScheduleDate
 o setSortSequenceTable
 public void setSortSequenceTable(String newTable) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the sort sequence table.

Parameters:
newTable - The new sort sequence table.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getSortSequenceTable
 o setStatusMessageHandling
 public void setStatusMessageHandling(String newHandling) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the status message handling. This is the value that indicates whether the status messages are displayed. Possible values are:

Parameters:
newHandling - The new status message handling.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getStatusMessageHandling
 o setTimeSeparator
 public void setTimeSeparator(String newSeparator) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the time separator.

Parameters:
newSeparator - The new time separator.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
See Also:
getTimeSeparator
 o setTimeSlice
 public void setTimeSlice(int newTimeSlice) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the time slice (in milliseconds). The time slice is the maximum amount of processor time (in milliseconds) given to threads in this job before other threads in this job are given the opportunity to run.

Parameters:
newTimeSlice - The new time slice.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o setTimeSliceEndPool
 public void setTimeSliceEndPool(String newTimeSliceEndPool) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, IOException, ObjectDoesNotExistException, UnsupportedEncodingException
Sets the key whether you want interactive jobs moved to another main storage pool at the end of the time slice.

Parameters:
newValue - The new key. The possible values are:
  • "*SYSVAL" - The value in the system value, QTESPOOL, is used.
  • "*NONE" - The job does not move to another mainstorage pool when it reaches the end of the time slice.
  • "*BASE" - The job moves to the base pool when it reaches the end of the time slice.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: UnsupportedEncodingException
If the character encoding is not supported.
 o toString
 public String toString()
Returns the string representation of the job. This is in the format "number/user/name".

Returns:
The string representation of the job.
Overrides:
toString in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index