com.ibm.as400.access
Class Job

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

public class Job
extends java.lang.Object
implements java.io.Serializable

The Job class represents an AS/400 job. In order to access a job, the system and either the job name, user name, and job number or internal job identifier need to be set. A valid combination of these must be set by getting or setting any of the job's attributes.

Some of the attributes have associated get and set methods defined in this class. These are provided for backwards compatibility with previous versions of the AS/400 Toolbox for Java. The complete set of attribute values can be accessed using the RJob class.

Note: To obtain information about the job in which an AS/400 program or command runs, do something like the following:

AS400 sys = new AS400();
ProgramCall pgm = new ProgramCall(sys);
pgm.setThreadSafe(true); // indicates the program is to be run on-thread
String jobNumber = pgm.getJob().getNumber();

See Also:
RJob, CommandCall.getJob(), ProgramCall.getJob(), Serialized Form

Constructor Summary
Job()
          Constructs a Job object.
Job(AS400 system)
          Constructs a Job object.
Job(AS400 system, java.lang.String internalJobID)
          Constructs a Job object.
Job(AS400 system, java.lang.String name, java.lang.String user, java.lang.String number)
          Constructs a Job object.
 
Method Summary
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          Adds a PropertyChangeListener.
 void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
          Adds a VetoableChangeListener.
 void commitChanges()
          Commits all uncommitted attribute changes.
 int getAuxiliaryIORequests()
          Returns the number of auxiliary I/O requests for the initial thread of this job.
 java.lang.String getBreakMessageHandling()
          Returns a value which represents how this job handles break messages.
 boolean getCacheChanges()
          Indicates if the attribute value changes are cached.
 int getCodedCharacterSetID()
          Returns the coded character set identifier (CCSID).
 java.lang.String getCompletionStatus()
          Returns the completion status of the job.
 java.lang.String getCountryID()
          Returns the country ID.
 int getCPUUsed()
          Returns the amount of processing time used (in milliseconds) that the job used.
 java.lang.String getCurrentLibrary()
          Returns the name of the current library for the initial thread of the job.
 boolean getCurrentLibraryExistence()
          Indicates if a current library exists.
 java.util.Date getDate()
          Returns the date and time when the job was placed on the system.
 java.lang.String getDateFormat()
          Returns the format in which dates are presented.
 java.lang.String getDateSeparator()
          Returns the date separator.
 java.lang.String getDDMConversationHandling()
          Returns whether connections using distributed data management (DDM) protocols remain active when they are not being used.
 java.lang.String getDecimalFormat()
          Returns the decimal format used for this job.
 int getDefaultCodedCharacterSetIdentifier()
          Returns the default coded character set identifier (CCSID) for this job.
 int getDefaultWait()
          Returns the default maximum time (in seconds) that a thread in the job waits for a system instruction.
 java.lang.String getDeviceRecoveryAction()
          Returns the action taken for interactive jobs when an I/O error occurs for the job's requesting program device.
 int getEndSeverity()
          Returns the message severity level of escape messages that can cause a batch job to end.
 java.lang.String getFunctionName()
          Returns additional information about the function the initial thread is currently performing.
 java.lang.String getFunctionType()
          Returns the high-level function type the initial thread is performing, if any.
 java.lang.String getInquiryMessageReply()
          Returns how the job answers inquiry messages.
 int getInteractiveTransactions()
          Returns the number of interactive transactions.
 java.lang.String getInternalJobID()
          Returns the internal job identifier.
 java.lang.String getJobAccountingCode()
          Returns the identifier assigned to the job by the system to collect resource use information for the job when job accounting is active.
 java.util.Date getJobActiveDate()
          Returns the date and time when the job began to run on the system.
 java.util.Date getJobDate()
          Returns the date to be used for the job.
 java.lang.String getJobDescription()
          Returns the fully qualified integrated path name for the job description.
 java.util.Date getJobEnterSystemDate()
          Returns the date and time when the job was placed on the system.
 JobLog getJobLog()
          Returns the job log.
 java.lang.String getJobMessageQueueFullAction()
          Returns the action to take when the message queue is full.
 int getJobMessageQueueMaximumSize()
          Returns the maximum size (in megabytes) that the job message queue can become.
 java.util.Date getJobPutOnJobQueueDate()
          Returns the date and time the job was put on the job queue.
 java.lang.String getJobStatusInJobQueue()
          Returns the status of the job on the job queue.
 java.lang.String getJobSwitches()
          Returns the current setting of the job switches used by this job.
 java.lang.String getLanguageID()
          Returns the language identifier associated with this job.
 java.lang.String getLoggingCLPrograms()
          Returns a value indicating whether or not messages are logged for CL programs.
 int getLoggingLevel()
          Returns the type of information logged.
 int getLoggingSeverity()
          Returns the minimum severity level that causes error messages to be logged in the job log.
 java.lang.String getLoggingText()
          Returns the level of message text that is written in the job log or displayed to the user.
 java.lang.String getModeName()
          Returns the mode name of the advanced program-to-program communications (APPC) device that started the job.
 java.lang.String getName()
          Returns the job name.
 java.lang.String getNumber()
          Returns the job number.
 int getNumberOfLibrariesInSYSLIBL()
          Returns the number of libraries in the system portion of the library list of the initial thread.
 int getNumberOfLibrariesInUSRLIBL()
          Returns the number of libraries in the user portion of the library list of the initial thread.
 int getNumberOfProductLibraries()
          Returns the number of libraries that contain product information for the initial thread.
 java.lang.String getOutputQueue()
          Returns the fully qualified integrated file system path name of the default output queue that is used for spooled output produced by this job.
 int getOutputQueuePriority()
          Returns the output priority for spooled files that this job produces.
 int getPoolIdentifier()
          Returns the identifier of the system-related pool from which the job's main storage is allocated.
 java.lang.String getPrinterDeviceName()
          Returns the printer device used for printing output from this job.
 java.lang.String getPrintKeyFormat()
          Returns a value indicating whether border and header information is provided when the Print key is pressed.
 java.lang.String getPrintText()
          Returns the line of text, if any, that is printed at the bottom of each page of printed output for the job.
 java.lang.String[] getProductLibraries()
          Returns the libraries that contain product information for the initial thread.
 boolean getPurge()
          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 it is beginning a long wait.
 java.lang.String getQueue()
          Returns the fully qualified integrated file system path name of the job queue that the job is on, or that the job was on if it is active.
 int getQueuePriority()
          Returns the scheduling priority of the job compared to other jobs on the same job queue.
 java.lang.String getRoutingData()
          Returns the routing data that is used to determine the routing entry that identifies the program to start for the routing step.
 int getRunPriority()
          Returns the priority at which the job is currently running, relative to other jobs on the system.
 java.util.Date getScheduleDate()
          Returns the date and time the job is scheduled to become active.
 boolean getSignedOnJob()
          Indicates whether the job is to be treated like a signed-on user on the system.
 java.lang.String getSortSequenceTable()
          Returns the fully qualified integrated file system path name of the sort sequence table.
 java.lang.String getStatus()
          Returns the job status.
 java.lang.String getStatusMessageHandling()
          Returns a value indicating status messages are displayed for this job.
 java.lang.String getSubsystem()
          Returns the fully qualified integrated file system path name of the subsystem description for the subsystem in which the job is running.
 java.lang.String getSubtype()
          Returns additional information about the job type.
 AS400 getSystem()
          Returns the system.
 java.lang.String[] getSystemLibraryList()
          Returns the system portion of the library list of the initial thread.
 java.lang.String getTimeSeparator()
          Returns the value used to separate hours, minutes, and seconds when presenting a time.
 int getTimeSlice()
          Returns the maximum amount of processor time (in milliseconds) given to each thread in this job before other threads in this job and in other jobs are given the opportunity to run.
 java.lang.String getTimeSliceEndPool()
          Returns a value indicating whether a thread in an interactive job moves to another main storage pool at the end of its time slice.
 int getTotalResponseTime()
          Returns the total amount of response time (in milliseconds) for the initial thread.
 java.lang.String getType()
          Returns the job type.
 java.lang.String getUser()
          Returns the user name.
 java.lang.String[] getUserLibraryList()
          Returns the user portion of the library list of the initial thread.
 java.lang.String getWorkIDUnit()
          Returns the unit of work identifier.
 void loadInformation()
          Refreshes the values for all attributes.
 void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
          Removes a PropertyChangeListener.
 void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
          Removes a VetoableChangeListener.
 void setBreakMessageHandling(java.lang.String breakMessageHandling)
          Sets how this job handles break messages.
 void setCacheChanges(boolean cacheChanges)
          Sets the value indicating whether attribute value changes are committed immediately.
 void setCodedCharacterSetID(int codedCharacterSetID)
          Sets the coded character set identifier (CCSID).
 void setCountryID(java.lang.String countryID)
          Sets the country ID.
 void setDateFormat(java.lang.String dateFormat)
          Sets the format in which dates are presented.
 void setDateSeparator(java.lang.String dateSeparator)
          Sets the value used to separate days, months, and years when presenting a date.
 void setDDMConversationHandling(java.lang.String ddmConversationHandling)
          Sets whether connections using distributed data management (DDM) protocols remain active when they are not being used.
 void setDecimalFormat(java.lang.String decimalFormat)
          Sets the decimal format used for this job.
 void setDefaultWait(int defaultWait)
          Sets the default maximum time (in seconds) that a thread in the job waits for a system instruction.
 void setDeviceRecoveryAction(java.lang.String deviceRecoveryAction)
          Sets the action taken for interactive jobs when an I/O error occurs for the job's requesting program device.
 void setInquiryMessageReply(java.lang.String inquiryMessageReply)
          Sets how the job answers inquiry messages.
 void setInternalJobID(java.lang.String internalJobID)
          Sets the internal job identifier.
 void setJobAccountingCode(java.lang.String jobAccountingCode)
          Sets the identifier assigned to the job by the system to collect resource use information for the job when job accounting is active.
 void setJobDate(java.util.Date jobDate)
          Sets the date to be used for the job.
 void setJobMessageQueueFullAction(java.lang.String jobMessageQueueFullAction)
          Sets the action to take when the message queue is full.
 void setJobSwitches(java.lang.String jobSwitches)
          Sets the current setting of the job switches used by this job.
 void setLanguageID(java.lang.String languageID)
          Sets the language identifier associated with this job.
 void setLoggingCLPrograms(java.lang.String loggingCLPrograms)
          Sets whether messages are logged for CL programs.
 void setLoggingLevel(int loggingLevel)
          Sets the type of information that is logged.
 void setLoggingSeverity(int loggingSeverity)
          Sets the minimum severity level that causes error messages to be logged in the job log.
 void setLoggingText(java.lang.String loggingText)
          Sets the level of message text that is written in the job log or displayed to the user.
 void setName(java.lang.String name)
          Sets the job name.
 void setNumber(java.lang.String number)
          Sets the job number.
 void setOutputQueue(java.lang.String outputQueue)
          Sets the name of the default output queue that is used for spooled output produced by this job.
 void setOutputQueuePriority(int outputQueuePriority)
          Sets the output priority for spooled output files that this job produces.
 void setPrinterDeviceName(java.lang.String printerDeviceName)
          Sets the printer device name used for printing output from this job.
 void setPrintKeyFormat(java.lang.String printKeyFormat)
          Sets whether border and header information is provided when the Print key is pressed.
 void setPrintText(java.lang.String printText)
          Sets the line of text, if any, that is printed at the bottom of each page of printed output for the job.
 void setPurge(boolean purge)
          Sets the value indicating 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 it is beginning a long wait.
 void setQueue(java.lang.String jobQueue)
          Sets the job queue that the job is currently on.
 void setQueuePriority(int queuePriority)
          Sets the scheduling priority of the job compared to other jobs on the same job queue.
 void setRunPriority(int runPriority)
          Sets the priority at which the job is currently running, relative to other jobs on the system.
 void setScheduleDate(java.util.Date scheduleDate)
          Sets the date and time the job is scheduled to become active.
 void setScheduleDate(java.lang.String scheduleDate)
          Sets the date the job is scheduled to become active.
 void setScheduleTime(java.util.Date scheduleTime)
          Sets the date and time the job is scheduled to become active.
 void setScheduleTime(java.lang.String scheduleTime)
          Sets the time the job is scheduled to become active.
 void setSortSequenceTable(java.lang.String sortSequenceTable)
          Sets the sort sequence table.
 void setStatusMessageHandling(java.lang.String statusMessageHandling)
          Sets the value which indicates whether status messages are displayed for this job.
 void setSystem(AS400 system)
          Sets the system.
 void setTimeSeparator(java.lang.String timeSeparator)
          Sets the value used to separate hours, minutes, and seconds when presenting a time.
 void setTimeSlice(int timeSlice)
          Sets the maximum amount of processor time (in milliseconds) given to each thread in this job before other threads in this job and in other jobs are given the opportunity to run.
 void setTimeSliceEndPool(java.lang.String timeSliceEndPool)
          Sets the value which indicates whether a thread in an interactive job moves to another main storage pool at the end of its time slice.
 void setUser(java.lang.String user)
          Sets the user name.
 java.lang.String toString()
          Returns the string representation in the format "number/user/name".
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Job

public Job()
Constructs a Job object.

Job

public Job(AS400 system)
Constructs a Job object.
Parameters:
system - The system.

Job

public Job(AS400 system,
           java.lang.String name,
           java.lang.String user,
           java.lang.String number)
Constructs a Job object.
Parameters:
system - The system.
name - The job name. Specify "*" to indicate the job that this program running in.
user - The user name. This must be blank if name is "*".
number - The job number. This must be blank if name is "*".

Job

public Job(AS400 system,
           java.lang.String internalJobID)
Constructs a Job object. This sets the job name to "*INT".
Parameters:
system - The system.
internalJobID - The internal job identifier.
Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a PropertyChangeListener. The specified PropertyChangeListener's propertyChange() method will be called each time the value of any bound property is changed.
Parameters:
listener - The listener.

addVetoableChangeListener

public void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
Adds a VetoableChangeListener. The specified VetoableChangeListener's vetoableChange() method will be called each time the value of any constrained property is changed.
Parameters:
listener - The listener.

commitChanges

public void commitChanges()
                   throws AS400Exception,
                          AS400SecurityException,
                          ConnectionDroppedException,
                          ErrorCompletingRequestException,
                          java.lang.InterruptedException,
                          java.io.IOException,
                          ObjectDoesNotExistException,
                          java.io.UnsupportedEncodingException
Commits all uncommitted attribute changes.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.

getAuxiliaryIORequests

public int getAuxiliaryIORequests()
                           throws AS400Exception,
                                  AS400SecurityException,
                                  ConnectionDroppedException,
                                  ErrorCompletingRequestException,
                                  java.lang.InterruptedException,
                                  java.io.IOException,
                                  ObjectDoesNotExistException,
                                  java.io.UnsupportedEncodingException
Returns the number of auxiliary I/O requests for the initial thread of this job.
Returns:
The number of auxiliary I/O requests.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.AUXILIARY_IO_REQUESTS

getBreakMessageHandling

public java.lang.String getBreakMessageHandling()
                                         throws AS400Exception,
                                                AS400SecurityException,
                                                ConnectionDroppedException,
                                                ErrorCompletingRequestException,
                                                java.lang.InterruptedException,
                                                java.io.IOException,
                                                ObjectDoesNotExistException,
                                                java.io.UnsupportedEncodingException
Returns a value which represents how this job handles break messages.
Returns:
How this job handles break messages. Possible values are:
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.BREAK_MESSAGE_HANDLING

getCacheChanges

public boolean getCacheChanges()
Indicates if the attribute value changes are cached.
Returns:
true if attribute value changes are cached, false if attribute value changes are committed immediatly.

getCodedCharacterSetID

public int getCodedCharacterSetID()
                           throws AS400Exception,
                                  AS400SecurityException,
                                  ConnectionDroppedException,
                                  ErrorCompletingRequestException,
                                  java.lang.InterruptedException,
                                  java.io.IOException,
                                  ObjectDoesNotExistException,
                                  java.io.UnsupportedEncodingException
Returns the coded character set identifier (CCSID).
Returns:
The coded character set identifier.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.CCSID

getCompletionStatus

public java.lang.String getCompletionStatus()
                                     throws AS400Exception,
                                            AS400SecurityException,
                                            ConnectionDroppedException,
                                            ErrorCompletingRequestException,
                                            java.lang.InterruptedException,
                                            java.io.IOException,
                                            ObjectDoesNotExistException,
                                            java.io.UnsupportedEncodingException
Returns the completion status of the job.
Returns:
The completion status of the job. Possible values are:
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.COMPLETION_STATUS

getCountryID

public java.lang.String getCountryID()
                              throws AS400Exception,
                                     AS400SecurityException,
                                     ConnectionDroppedException,
                                     ErrorCompletingRequestException,
                                     java.lang.InterruptedException,
                                     java.io.IOException,
                                     ObjectDoesNotExistException,
                                     java.io.UnsupportedEncodingException
Returns the country ID.
Returns:
The country ID.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.COUNTRY_ID

getCPUUsed

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

getCurrentLibrary

public java.lang.String getCurrentLibrary()
                                   throws AS400Exception,
                                          AS400SecurityException,
                                          ConnectionDroppedException,
                                          ErrorCompletingRequestException,
                                          java.lang.InterruptedException,
                                          java.io.IOException,
                                          ObjectDoesNotExistException,
                                          java.io.UnsupportedEncodingException
Returns the name of the current library for the initial thread of the job.
Returns:
The name of the current library for the initial thread of the job.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.CURRENT_LIBRARY

getCurrentLibraryExistence

public boolean getCurrentLibraryExistence()
                                   throws AS400Exception,
                                          AS400SecurityException,
                                          ConnectionDroppedException,
                                          ErrorCompletingRequestException,
                                          java.lang.InterruptedException,
                                          java.io.IOException,
                                          ObjectDoesNotExistException,
                                          java.io.UnsupportedEncodingException
Indicates if a current library exists.
Returns:
true if a current library exists, false otherwise.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.CURRENT_LIBRARY_EXISTENCE

getDate

public java.util.Date getDate()
                       throws AS400Exception,
                              AS400SecurityException,
                              ConnectionDroppedException,
                              ErrorCompletingRequestException,
                              java.lang.InterruptedException,
                              java.io.IOException,
                              ObjectDoesNotExistException,
                              java.io.UnsupportedEncodingException
Returns the date and time when the job was placed on the system.
Returns:
The date and time when the job was placed on the system.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.DATE_ENTERED_SYSTEM

getDateFormat

public java.lang.String getDateFormat()
                               throws AS400Exception,
                                      AS400SecurityException,
                                      ConnectionDroppedException,
                                      ErrorCompletingRequestException,
                                      java.lang.InterruptedException,
                                      java.io.IOException,
                                      ObjectDoesNotExistException,
                                      java.io.UnsupportedEncodingException
Returns the format in which dates are presented.
Returns:
The format in which dates are presented. Possible values are:
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.DATE_FORMAT

getDateSeparator

public java.lang.String getDateSeparator()
                                  throws AS400Exception,
                                         AS400SecurityException,
                                         ConnectionDroppedException,
                                         ErrorCompletingRequestException,
                                         java.lang.InterruptedException,
                                         java.io.IOException,
                                         ObjectDoesNotExistException,
                                         java.io.UnsupportedEncodingException
Returns the date separator. The date separator is used to separate days, months, and years when representing a date.
Returns:
The date separator.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.DATE_SEPARATOR

getDDMConversationHandling

public java.lang.String getDDMConversationHandling()
                                            throws AS400Exception,
                                                   AS400SecurityException,
                                                   ConnectionDroppedException,
                                                   ErrorCompletingRequestException,
                                                   java.lang.InterruptedException,
                                                   java.io.IOException,
                                                   ObjectDoesNotExistException,
                                                   java.io.UnsupportedEncodingException
Returns whether connections using distributed data management (DDM) protocols remain active when they are not being used.
Returns:
Whether connections using distributed data management (DDM) protocols remain active when they are not being used. Possible values are:
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.KEEP_DDM_CONNECTIONS_ACTIVE

getDecimalFormat

public java.lang.String getDecimalFormat()
                                  throws AS400Exception,
                                         AS400SecurityException,
                                         ConnectionDroppedException,
                                         ErrorCompletingRequestException,
                                         java.lang.InterruptedException,
                                         java.io.IOException,
                                         ObjectDoesNotExistException,
                                         java.io.UnsupportedEncodingException
Returns the decimal format used for this job.
Returns:
The decimal format used for this job. Possible values are:
  • RJob.DECIMAL_FORMAT_PERIOD - Uses a period for a decimal point, a comma for a 3-digit grouping character, and zero-suppresses to the left of the decimal point.
  • RJob.DECIMAL_FORMAT_COMMA_I - Uses a comma for a decimal point and a period for a 3-digit grouping character. The zero-suppression character is in the second character (rather than the first) to the left of the decimal notation. Balances with zero values to the left of the comma are written with one leading zero.
  • RJob.DECIMAL_FORMAT_COMMA_J - Uses a comma for a decimal point, a period for a 3-digit grouping character, and zero-suppresses to the left of the decimal point.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.DECIMAL_FORMAT

getDefaultCodedCharacterSetIdentifier

public int getDefaultCodedCharacterSetIdentifier()
                                          throws AS400Exception,
                                                 AS400SecurityException,
                                                 ConnectionDroppedException,
                                                 ErrorCompletingRequestException,
                                                 java.lang.InterruptedException,
                                                 java.io.IOException,
                                                 ObjectDoesNotExistException,
                                                 java.io.UnsupportedEncodingException
Returns the default coded character set identifier (CCSID) for this job.
Returns:
The default coded character set identifier (CCSID) for this job. The value will be 0 if the job is not active.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.DEFAULT_CCSID

getDefaultWait

public int getDefaultWait()
                   throws AS400Exception,
                          AS400SecurityException,
                          ConnectionDroppedException,
                          ErrorCompletingRequestException,
                          java.lang.InterruptedException,
                          java.io.IOException,
                          ObjectDoesNotExistException,
                          java.io.UnsupportedEncodingException
Returns the default maximum time (in seconds) that a thread in the job waits for a system instruction.
Returns:
The default maximum time (in seconds) that a thread in the job waits for a system instruction. The value -1 means there is no maximum.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.DEFAULT_WAIT_TIME

getDeviceRecoveryAction

public java.lang.String getDeviceRecoveryAction()
                                         throws AS400Exception,
                                                AS400SecurityException,
                                                ConnectionDroppedException,
                                                ErrorCompletingRequestException,
                                                java.lang.InterruptedException,
                                                java.io.IOException,
                                                ObjectDoesNotExistException,
                                                java.io.UnsupportedEncodingException
Returns the action taken for interactive jobs when an I/O error occurs for the job's requesting program device.
Returns:
The action taken for interactive jobs when an I/O error occurs for the job's requesting program device. Possible values are:
  • RJob.DEVICE_RECOVERY_ACTION_MESSAGE - Signals the I/O error message to the application and lets the application program perform error recovery.
  • RJob.DEVICE_RECOVERY_ACTION_DISCONNECT_MESSAGE RJob.DEVICE_RECOVERY_ACTION_DISCONNECT_MESSAGE } - 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 workstation device has recovered.
  • RJob.DEVICE_RECOVERY_ACTION_DISCONNECT_END_REQUEST - 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.
  • RJob.DEVICE_RECOVERY_ACTION_END_JOB - 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.
  • RJob.DEVICE_RECOVERY_ACTION_END_JOB_NO_LIST - 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.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.DEVICE_RECOVERY_ACTION

getEndSeverity

public int getEndSeverity()
                   throws AS400Exception,
                          AS400SecurityException,
                          ConnectionDroppedException,
                          ErrorCompletingRequestException,
                          java.lang.InterruptedException,
                          java.io.IOException,
                          ObjectDoesNotExistException,
                          java.io.UnsupportedEncodingException
Returns 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 message severity level of escape messages that can cause a batch job to end.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.END_SEVERITY

getFunctionName

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

getFunctionType

public java.lang.String getFunctionType()
                                 throws AS400Exception,
                                        AS400SecurityException,
                                        ConnectionDroppedException,
                                        ErrorCompletingRequestException,
                                        java.lang.InterruptedException,
                                        java.io.IOException,
                                        ObjectDoesNotExistException,
                                        java.io.UnsupportedEncodingException
Returns the high-level function type the initial thread is performing, if any.
Returns:
The high-level function type the initial thread is performing, if any. Possible values are:
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.FUNCTION_TYPE

getInquiryMessageReply

public java.lang.String getInquiryMessageReply()
                                        throws AS400Exception,
                                               AS400SecurityException,
                                               ConnectionDroppedException,
                                               ErrorCompletingRequestException,
                                               java.lang.InterruptedException,
                                               java.io.IOException,
                                               ObjectDoesNotExistException,
                                               java.io.UnsupportedEncodingException
Returns how the job answers inquiry messages.
Returns:
How the job answers inquiry messages. Possible values are:
  • RJob.INQUIRY_MESSAGE_REPLY_REQUIRED - The job requires an answer for any inquiry messages that occur while this job is running.
  • RJob.INQUIRY_MESSAGE_REPLY_DEFAULT - The system uses the default message reply to answer any inquiry messages issued while this job is running. The default reply is either defined in the message description or is the default system reply.
  • RJob.INQUIRY_MESSAGE_REPLY_SYSTEM_REPLY_LIST 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.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.INQUIRY_MESSAGE_REPLY

getInteractiveTransactions

public int getInteractiveTransactions()
                               throws AS400Exception,
                                      AS400SecurityException,
                                      ConnectionDroppedException,
                                      ErrorCompletingRequestException,
                                      java.lang.InterruptedException,
                                      java.io.IOException,
                                      ObjectDoesNotExistException,
                                      java.io.UnsupportedEncodingException
Returns the number of interactive transactions.
Returns:
The number of interactive transactions.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.INTERACTIVE_TRANSACTIONS

getInternalJobID

public java.lang.String getInternalJobID()
Returns the internal job identifier.
Returns:
The internal job identifier.

getJobAccountingCode

public java.lang.String getJobAccountingCode()
                                      throws AS400Exception,
                                             AS400SecurityException,
                                             ConnectionDroppedException,
                                             ErrorCompletingRequestException,
                                             java.lang.InterruptedException,
                                             java.io.IOException,
                                             ObjectDoesNotExistException,
                                             java.io.UnsupportedEncodingException
Returns the identifier assigned to the job by the system to collect resource use information for the job when job accounting is active.
Returns:
The identifier assigned to the job by the system to collect resource use information for the job when job accounting is active.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.ACCOUNTING_CODE

getJobActiveDate

public java.util.Date getJobActiveDate()
                                throws AS400Exception,
                                       AS400SecurityException,
                                       ConnectionDroppedException,
                                       ErrorCompletingRequestException,
                                       java.lang.InterruptedException,
                                       java.io.IOException,
                                       ObjectDoesNotExistException,
                                       java.io.UnsupportedEncodingException
Returns the date and time when the job began to run on the system.
Returns:
The date and time when the job began to run on the system.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.DATE_STARTED

getJobDate

public java.util.Date getJobDate()
                          throws AS400Exception,
                                 AS400SecurityException,
                                 ConnectionDroppedException,
                                 ErrorCompletingRequestException,
                                 java.lang.InterruptedException,
                                 java.io.IOException,
                                 ObjectDoesNotExistException,
                                 java.io.UnsupportedEncodingException
Returns the date to be used for the job.
Returns:
The date to be used for the job.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.JOB_DATE

getJobDescription

public java.lang.String getJobDescription()
                                   throws AS400Exception,
                                          AS400SecurityException,
                                          ConnectionDroppedException,
                                          ErrorCompletingRequestException,
                                          java.lang.InterruptedException,
                                          java.io.IOException,
                                          ObjectDoesNotExistException,
                                          java.io.UnsupportedEncodingException
Returns the fully qualified integrated path name for the job description.
Returns:
The fully qualified integrated path name for the job description.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.JOB_DESCRIPTION, QSYSObjectPathName

getJobEnterSystemDate

public java.util.Date getJobEnterSystemDate()
                                     throws AS400Exception,
                                            AS400SecurityException,
                                            ConnectionDroppedException,
                                            ErrorCompletingRequestException,
                                            java.lang.InterruptedException,
                                            java.io.IOException,
                                            ObjectDoesNotExistException,
                                            java.io.UnsupportedEncodingException
Returns the date and time when the job was placed on the system.
Returns:
The date and time when the job was placed on the system.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.DATE_ENTERED_SYSTEM

getJobLog

public JobLog getJobLog()
Returns the job log.
Returns:
The job log.

getJobMessageQueueFullAction

public java.lang.String getJobMessageQueueFullAction()
                                              throws AS400Exception,
                                                     AS400SecurityException,
                                                     ConnectionDroppedException,
                                                     ErrorCompletingRequestException,
                                                     java.lang.InterruptedException,
                                                     java.io.IOException,
                                                     ObjectDoesNotExistException,
                                                     java.io.UnsupportedEncodingException
Returns the action to take when the message queue is full.
Returns:
The action to take when the message queue is full. Possible values are:
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.MESSAGE_QUEUE_ACTION

getJobMessageQueueMaximumSize

public int getJobMessageQueueMaximumSize()
                                  throws AS400Exception,
                                         AS400SecurityException,
                                         ConnectionDroppedException,
                                         ErrorCompletingRequestException,
                                         java.lang.InterruptedException,
                                         java.io.IOException,
                                         ObjectDoesNotExistException,
                                         java.io.UnsupportedEncodingException
Returns the maximum size (in megabytes) that the job message queue can become.
Returns:
The maximum size (in megabytes) that the job message queue can become. The range is 2 through 64.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.MESSAGE_QUEUE_MAX_SIZE

getJobPutOnJobQueueDate

public java.util.Date getJobPutOnJobQueueDate()
                                       throws AS400Exception,
                                              AS400SecurityException,
                                              ConnectionDroppedException,
                                              ErrorCompletingRequestException,
                                              java.lang.InterruptedException,
                                              java.io.IOException,
                                              ObjectDoesNotExistException,
                                              java.io.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.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.JOB_QUEUE_DATE

getScheduleDate

public java.util.Date getScheduleDate()
                               throws AS400Exception,
                                      AS400SecurityException,
                                      ConnectionDroppedException,
                                      ErrorCompletingRequestException,
                                      java.lang.InterruptedException,
                                      java.io.IOException,
                                      ObjectDoesNotExistException,
                                      java.io.UnsupportedEncodingException
Returns the date and time the job is scheduled to become active.
Returns:
The date and time the job is scheduled to become active.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.SCHEDULE_DATE

getJobStatusInJobQueue

public java.lang.String getJobStatusInJobQueue()
                                        throws AS400Exception,
                                               AS400SecurityException,
                                               ConnectionDroppedException,
                                               ErrorCompletingRequestException,
                                               java.lang.InterruptedException,
                                               java.io.IOException,
                                               ObjectDoesNotExistException,
                                               java.io.UnsupportedEncodingException
Returns the status of the job on the job queue.
Returns:
The status of the job on the job queue. Possible values are:
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.JOB_QUEUE_STATUS

getJobSwitches

public java.lang.String getJobSwitches()
                                throws AS400Exception,
                                       AS400SecurityException,
                                       ConnectionDroppedException,
                                       ErrorCompletingRequestException,
                                       java.lang.InterruptedException,
                                       java.io.IOException,
                                       ObjectDoesNotExistException,
                                       java.io.UnsupportedEncodingException
Returns the current setting of the job switches used by this job.
Returns:
The current setting of the job switches used by this job.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.JOB_SWITCHES

getLanguageID

public java.lang.String getLanguageID()
                               throws AS400Exception,
                                      AS400SecurityException,
                                      ConnectionDroppedException,
                                      ErrorCompletingRequestException,
                                      java.lang.InterruptedException,
                                      java.io.IOException,
                                      ObjectDoesNotExistException,
                                      java.io.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.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.LANGUAGE_ID

getLoggingCLPrograms

public java.lang.String getLoggingCLPrograms()
                                      throws AS400Exception,
                                             AS400SecurityException,
                                             ConnectionDroppedException,
                                             ErrorCompletingRequestException,
                                             java.lang.InterruptedException,
                                             java.io.IOException,
                                             ObjectDoesNotExistException,
                                             java.io.UnsupportedEncodingException
Returns a value indicating whether or not messages are logged for CL programs.
Returns:
The value indicating whether or not messages are logged for CL programs. Possible values are: RJob.YES and RJob.NO .
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.LOG_CL_PROGRAMS

getLoggingLevel

public int getLoggingLevel()
                    throws AS400Exception,
                           AS400SecurityException,
                           ConnectionDroppedException,
                           ErrorCompletingRequestException,
                           java.lang.InterruptedException,
                           java.io.IOException,
                           ObjectDoesNotExistException,
                           java.io.UnsupportedEncodingException
Returns the type of information logged.
Returns:
The type of information logged. 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 - Requests or commands from CL programs for which the system issues messages with a severity code greater than or equal to the logging severity and all messages associated with those requests or commands that have a severity code greater than or equal to the logging severity are logged.
  • 3 - All requests or commands from CL programs and all messages associated with those requests or commands that have a severity code greater than or equal to the logging severity are logged.
  • 4 - All requests or commands from CL programs and all messages with a severity code greater than or equal to the logging severity are logged.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.LOGGING_LEVEL

getLoggingSeverity

public int getLoggingSeverity()
                       throws AS400Exception,
                              AS400SecurityException,
                              ConnectionDroppedException,
                              ErrorCompletingRequestException,
                              java.lang.InterruptedException,
                              java.io.IOException,
                              ObjectDoesNotExistException,
                              java.io.UnsupportedEncodingException
Returns the minimum severity level that causes error messages to be logged in the job log.
Returns:
The minimum severity level that causes error messages to be logged in the job log.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.LOGGING_SEVERITY

getLoggingText

public java.lang.String getLoggingText()
                                throws AS400Exception,
                                       AS400SecurityException,
                                       ConnectionDroppedException,
                                       ErrorCompletingRequestException,
                                       java.lang.InterruptedException,
                                       java.io.IOException,
                                       ObjectDoesNotExistException,
                                       java.io.UnsupportedEncodingException
Returns the level of message text that is written in the job log or displayed to the user.
Returns:
The level of message text that is written in the job log or displayed to the user. Possible values are:
  • RJob.LOGGING_TEXT_MESSAGE - Only the message is written to the job log.
  • RJob.LOGGING_TEXT_SECLVL - Both the message and the message help for the error message are written to the job log.
  • RJob.LOGGING_TEXT_NO_LIST - If the job ends normally, there is no job log. If the job ends abnormally, there is a job log. The messages appearing in the job log contain both the message and the message help.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.LOGGING_TEXT

getModeName

public java.lang.String getModeName()
                             throws AS400Exception,
                                    AS400SecurityException,
                                    ConnectionDroppedException,
                                    ErrorCompletingRequestException,
                                    java.lang.InterruptedException,
                                    java.io.IOException,
                                    ObjectDoesNotExistException,
                                    java.io.UnsupportedEncodingException
Returns the mode name of the advanced program-to-program communications (APPC) device that started the job.
Returns:
The mode name of the advanced program-to-program communications (APPC) device that started the job.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.MODE

getName

public java.lang.String getName()
Returns the job name.
Returns:
The job name.

getNumber

public java.lang.String getNumber()
Returns the job number.
Returns:
The job number.

getNumberOfLibrariesInSYSLIBL

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

getNumberOfLibrariesInUSRLIBL

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

getNumberOfProductLibraries

public int getNumberOfProductLibraries()
                                throws AS400Exception,
                                       AS400SecurityException,
                                       ConnectionDroppedException,
                                       ErrorCompletingRequestException,
                                       java.lang.InterruptedException,
                                       java.io.IOException,
                                       ObjectDoesNotExistException,
                                       java.io.UnsupportedEncodingException
Returns the number of libraries that contain product information for the initial thread.
Returns:
The number of libraries that contain product information for the initial thread.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.PRODUCT_LIBRARIES

getOutputQueue

public java.lang.String getOutputQueue()
                                throws AS400Exception,
                                       AS400SecurityException,
                                       ConnectionDroppedException,
                                       ErrorCompletingRequestException,
                                       java.lang.InterruptedException,
                                       java.io.IOException,
                                       ObjectDoesNotExistException,
                                       java.io.UnsupportedEncodingException
Returns the fully qualified integrated file system path name of the default output queue that is used for spooled output produced by this job.
Returns:
The fully qualified integrated file system path name of the default output queue that is used for spooled output produced by this job.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.OUTPUT_QUEUE, QSYSObjectPathName

getOutputQueuePriority

public int getOutputQueuePriority()
                           throws AS400Exception,
                                  AS400SecurityException,
                                  ConnectionDroppedException,
                                  ErrorCompletingRequestException,
                                  java.lang.InterruptedException,
                                  java.io.IOException,
                                  ObjectDoesNotExistException,
                                  java.io.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 lowest is 9.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.OUTPUT_QUEUE_PRIORITY

getPoolIdentifier

public int getPoolIdentifier()
                      throws AS400Exception,
                             AS400SecurityException,
                             ConnectionDroppedException,
                             ErrorCompletingRequestException,
                             java.lang.InterruptedException,
                             java.io.IOException,
                             ObjectDoesNotExistException,
                             java.io.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.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.SYSTEM_POOL_ID

getPrinterDeviceName

public java.lang.String getPrinterDeviceName()
                                      throws AS400Exception,
                                             AS400SecurityException,
                                             ConnectionDroppedException,
                                             ErrorCompletingRequestException,
                                             java.lang.InterruptedException,
                                             java.io.IOException,
                                             ObjectDoesNotExistException,
                                             java.io.UnsupportedEncodingException
Returns the printer device used for printing output from this job.
Returns:
The printer device used for printing output from this job.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.PRINTER_DEVICE_NAME

getPrintKeyFormat

public java.lang.String getPrintKeyFormat()
                                   throws AS400Exception,
                                          AS400SecurityException,
                                          ConnectionDroppedException,
                                          ErrorCompletingRequestException,
                                          java.lang.InterruptedException,
                                          java.io.IOException,
                                          ObjectDoesNotExistException,
                                          java.io.UnsupportedEncodingException
Returns a value indicating whether border and header information is provided when the Print key is pressed.
Returns:
The value indicating whether border and header information is provided when the Print key is pressed.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.PRINT_KEY_FORMAT

getPrintText

public java.lang.String getPrintText()
                              throws AS400Exception,
                                     AS400SecurityException,
                                     ConnectionDroppedException,
                                     ErrorCompletingRequestException,
                                     java.lang.InterruptedException,
                                     java.io.IOException,
                                     ObjectDoesNotExistException,
                                     java.io.UnsupportedEncodingException
Returns the line of text, if any, that is printed at the bottom of each page of printed output for the job.
Returns:
The line of text, if any, that is printed at the bottom of each page of printed output for the job.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.PRINT_TEXT

getProductLibraries

public java.lang.String[] getProductLibraries()
                                       throws AS400Exception,
                                              AS400SecurityException,
                                              ConnectionDroppedException,
                                              ErrorCompletingRequestException,
                                              java.lang.InterruptedException,
                                              java.io.IOException,
                                              ObjectDoesNotExistException,
                                              java.io.UnsupportedEncodingException
Returns the libraries that contain product information for the initial thread.
Returns:
The libraries that contain product information for the initial thread.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.PRODUCT_LIBRARIES

getPurge

public boolean getPurge()
                 throws AS400Exception,
                        AS400SecurityException,
                        ConnectionDroppedException,
                        ErrorCompletingRequestException,
                        java.lang.InterruptedException,
                        java.io.IOException,
                        ObjectDoesNotExistException,
                        java.io.UnsupportedEncodingException
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 it is beginning a long wait.
Returns:
true 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 it is beginning a long wait, or false otherwise.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.ELIGIBLE_FOR_PURGE

getQueue

public java.lang.String getQueue()
                          throws AS400Exception,
                                 AS400SecurityException,
                                 ConnectionDroppedException,
                                 ErrorCompletingRequestException,
                                 java.lang.InterruptedException,
                                 java.io.IOException,
                                 ObjectDoesNotExistException,
                                 java.io.UnsupportedEncodingException
Returns the fully qualified integrated file system path name of the job queue that the job is on, or that the job was on if it is active.
Returns:
The fully qualified integrated file system path name of the job queue that the job is on, or that the job was on if it is active.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.JOB_QUEUE, QSYSObjectPathName

getQueuePriority

public int getQueuePriority()
                     throws AS400Exception,
                            AS400SecurityException,
                            ConnectionDroppedException,
                            ErrorCompletingRequestException,
                            java.lang.InterruptedException,
                            java.io.IOException,
                            ObjectDoesNotExistException,
                            java.io.UnsupportedEncodingException
Returns the scheduling priority of the job compared to other jobs on the same job queue.
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.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.JOB_QUEUE_PRIORITY

getRoutingData

public java.lang.String getRoutingData()
                                throws AS400Exception,
                                       AS400SecurityException,
                                       ConnectionDroppedException,
                                       ErrorCompletingRequestException,
                                       java.lang.InterruptedException,
                                       java.io.IOException,
                                       ObjectDoesNotExistException,
                                       java.io.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.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.ROUTING_DATA

getRunPriority

public int getRunPriority()
                   throws AS400Exception,
                          AS400SecurityException,
                          ConnectionDroppedException,
                          ErrorCompletingRequestException,
                          java.lang.InterruptedException,
                          java.io.IOException,
                          ObjectDoesNotExistException,
                          java.io.UnsupportedEncodingException
Returns the priority at which the job is currently running, relative to other jobs on the system.
Returns:
The priority at which the job is currently running, relative to other jobs on the system. The run priority ranges from 1 (highest priority) to 99 (lowest priority).
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.RUN_PRIORITY

getSignedOnJob

public boolean getSignedOnJob()
                       throws AS400Exception,
                              AS400SecurityException,
                              ConnectionDroppedException,
                              ErrorCompletingRequestException,
                              java.lang.InterruptedException,
                              java.io.IOException,
                              ObjectDoesNotExistException,
                              java.io.UnsupportedEncodingException
Indicates whether the job is to be treated like a signed-on user on the system.
Returns:
true if the job is to be treated like a signed-on user on the system, false otherwise.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.SIGNED_ON_JOB

getSortSequenceTable

public java.lang.String getSortSequenceTable()
                                      throws AS400Exception,
                                             AS400SecurityException,
                                             ConnectionDroppedException,
                                             ErrorCompletingRequestException,
                                             java.lang.InterruptedException,
                                             java.io.IOException,
                                             ObjectDoesNotExistException,
                                             java.io.UnsupportedEncodingException
Returns the fully qualified integrated file system path name of the sort sequence table.
Returns:
The fully qualified integrated file system path name of the sort sequence table.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.SORT_SEQUENCE_TABLE, QSYSObjectPathName

getStatus

public java.lang.String getStatus()
                           throws AS400Exception,
                                  AS400SecurityException,
                                  ConnectionDroppedException,
                                  ErrorCompletingRequestException,
                                  java.lang.InterruptedException,
                                  java.io.IOException,
                                  ObjectDoesNotExistException,
                                  java.io.UnsupportedEncodingException
Returns the job status.
Returns:
The job status. Possible values are:
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.JOB_STATUS

getStatusMessageHandling

public java.lang.String getStatusMessageHandling()
                                          throws AS400Exception,
                                                 AS400SecurityException,
                                                 ConnectionDroppedException,
                                                 ErrorCompletingRequestException,
                                                 java.lang.InterruptedException,
                                                 java.io.IOException,
                                                 ObjectDoesNotExistException,
                                                 java.io.UnsupportedEncodingException
Returns a value indicating status messages are displayed for this job.
Returns:
The value indicating status messages are displayed for this job.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.STATUS_MESSAGE_HANDLING

getSubsystem

public java.lang.String getSubsystem()
                              throws AS400Exception,
                                     AS400SecurityException,
                                     ConnectionDroppedException,
                                     ErrorCompletingRequestException,
                                     java.lang.InterruptedException,
                                     java.io.IOException,
                                     ObjectDoesNotExistException,
                                     java.io.UnsupportedEncodingException
Returns the fully qualified integrated file system path name of the subsystem description for the subsystem in which the job is running.
Returns:
The fully qualified integrated file system path name of the subsystem description for the subsystem in which the job is running.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.SUBSYSTEM, QSYSObjectPathName

getSubtype

public java.lang.String getSubtype()
                            throws AS400Exception,
                                   AS400SecurityException,
                                   ConnectionDroppedException,
                                   ErrorCompletingRequestException,
                                   java.lang.InterruptedException,
                                   java.io.IOException,
                                   ObjectDoesNotExistException,
                                   java.io.UnsupportedEncodingException
Returns additional information about the job type.
Returns:
Additional information about the job type. Possible values are:
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.JOB_SUBTYPE

getSystem

public AS400 getSystem()
Returns the system.
Returns:
The system.

getSystemLibraryList

public java.lang.String[] getSystemLibraryList()
                                        throws AS400Exception,
                                               AS400SecurityException,
                                               ConnectionDroppedException,
                                               ErrorCompletingRequestException,
                                               java.lang.InterruptedException,
                                               java.io.IOException,
                                               ObjectDoesNotExistException,
                                               java.io.UnsupportedEncodingException
Returns the system portion of the library list of the initial thread.
Returns:
The system portion of the library list of the initial thread.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.SYSTEM_LIBRARY_LIST

getTimeSeparator

public java.lang.String getTimeSeparator()
                                  throws AS400Exception,
                                         AS400SecurityException,
                                         ConnectionDroppedException,
                                         ErrorCompletingRequestException,
                                         java.lang.InterruptedException,
                                         java.io.IOException,
                                         ObjectDoesNotExistException,
                                         java.io.UnsupportedEncodingException
Returns the value used to separate hours, minutes, and seconds when presenting a time.
Returns:
The value used to separate hours, minutes, and seconds when presenting a time.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.TIME_SEPARATOR

getTimeSlice

public int getTimeSlice()
                 throws AS400Exception,
                        AS400SecurityException,
                        ConnectionDroppedException,
                        ErrorCompletingRequestException,
                        java.lang.InterruptedException,
                        java.io.IOException,
                        ObjectDoesNotExistException,
                        java.io.UnsupportedEncodingException
Returns the maximum amount of processor time (in milliseconds) given to each thread in this job before other threads in this job and in other jobs are given the opportunity to run.
Returns:
The maximum amount of processor time (in milliseconds) given to each thread in this job before other threads in this job and in other jobs are given the opportunity to run.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.TIME_SLICE

getTimeSliceEndPool

public java.lang.String getTimeSliceEndPool()
                                     throws AS400Exception,
                                            AS400SecurityException,
                                            ConnectionDroppedException,
                                            ErrorCompletingRequestException,
                                            java.lang.InterruptedException,
                                            java.io.IOException,
                                            ObjectDoesNotExistException,
                                            java.io.UnsupportedEncodingException
Returns a value indicating whether a thread in an interactive job moves to another main storage pool at the end of its time slice.
Returns:
The value indicating whether a thread in an interactive job moves to another main storage pool at the end of its time slice. Possible values are:
  • RJob.NONE - A thread in the job does not move to another main storage pool when it reaches the end of its time slice.
  • RJob.TIME_SLICE_END_POOL_BASE - A thread in the job moves to the base pool when it reaches the end of its time slice.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.TIME_SLICE_END_POOL

getTotalResponseTime

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

getType

public java.lang.String getType()
                         throws AS400Exception,
                                AS400SecurityException,
                                ConnectionDroppedException,
                                ErrorCompletingRequestException,
                                java.lang.InterruptedException,
                                java.io.IOException,
                                ObjectDoesNotExistException,
                                java.io.UnsupportedEncodingException
Returns the job type.
Returns:
The job type. Possible values are:
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.JOB_TYPE

getUser

public java.lang.String getUser()
Returns the user name.
Returns:
The user name.

getUserLibraryList

public java.lang.String[] getUserLibraryList()
                                      throws AS400Exception,
                                             AS400SecurityException,
                                             ConnectionDroppedException,
                                             ErrorCompletingRequestException,
                                             java.lang.InterruptedException,
                                             java.io.IOException,
                                             ObjectDoesNotExistException,
                                             java.io.UnsupportedEncodingException
Returns the user portion of the library list of the initial thread.
Returns:
The user portion of the library list of the initial thread.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.USER_LIBRARY_LIST

getWorkIDUnit

public java.lang.String getWorkIDUnit()
                               throws AS400Exception,
                                      AS400SecurityException,
                                      ConnectionDroppedException,
                                      ErrorCompletingRequestException,
                                      java.lang.InterruptedException,
                                      java.io.IOException,
                                      ObjectDoesNotExistException,
                                      java.io.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.
Returns:
The unit of work identifier, which is made up of:
  • Location name - 8 Characters. The name of the source system that originated the APPC job.
  • Network ID - 8 Characters. The network name associated with the unit of work.
  • Instance - 6 Characters. The value that further identifies the source of the job. This is shown as hexadecimal data.
  • Sequence Number - 2 Character. A value that identifies a check-point within the application program.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.LOCATION_NAME, RJob.NETWORK_ID, RJob.INSTANCE, RJob.SEQUENCE_NUMBER

loadInformation

public void loadInformation()
Refreshes the values for all attributes. This does not cancel uncommitted changes.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes a PropertyChangeListener.
Parameters:
listener - The listener.

removeVetoableChangeListener

public void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
Removes a VetoableChangeListener.
Parameters:
listener - The listener.

setBreakMessageHandling

public void setBreakMessageHandling(java.lang.String breakMessageHandling)
                             throws AS400Exception,
                                    AS400SecurityException,
                                    ConnectionDroppedException,
                                    ErrorCompletingRequestException,
                                    java.lang.InterruptedException,
                                    java.io.IOException,
                                    ObjectDoesNotExistException,
                                    java.io.UnsupportedEncodingException
Sets how this job handles break messages.
Parameters:
breakMessageHandling - How this job handles break messages. Possible values are:
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.BREAK_MESSAGE_HANDLING

setCacheChanges

public void setCacheChanges(boolean cacheChanges)
Sets the value indicating whether attribute value changes are committed immediately. The default is true.
Parameters:
cacheChanges - true to cache attribute value changes, false to commit all attribute value changes immediately.

setCodedCharacterSetID

public void setCodedCharacterSetID(int codedCharacterSetID)
                            throws AS400Exception,
                                   AS400SecurityException,
                                   ConnectionDroppedException,
                                   ErrorCompletingRequestException,
                                   java.lang.InterruptedException,
                                   java.io.IOException,
                                   ObjectDoesNotExistException,
                                   java.io.UnsupportedEncodingException
Sets the coded character set identifier (CCSID).
Parameters:
codedCharacterSetID - The coded character set identifier (CCSID). The following special values can be used:
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.CCSID

setCountryID

public void setCountryID(java.lang.String countryID)
                  throws AS400Exception,
                         AS400SecurityException,
                         ConnectionDroppedException,
                         ErrorCompletingRequestException,
                         java.lang.InterruptedException,
                         java.io.IOException,
                         ObjectDoesNotExistException,
                         java.io.UnsupportedEncodingException
Sets the country ID.
Parameters:
countryID - The country ID. The following special values can be used:
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.COUNTRY_ID

setDateFormat

public void setDateFormat(java.lang.String dateFormat)
                   throws AS400Exception,
                          AS400SecurityException,
                          ConnectionDroppedException,
                          ErrorCompletingRequestException,
                          java.lang.InterruptedException,
                          java.io.IOException,
                          ObjectDoesNotExistException,
                          java.io.UnsupportedEncodingException
Sets the format in which dates are presented.
Parameters:
dateFormat - The format in which dates are presented. Possible values are:
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.DATE_FORMAT

setDateSeparator

public void setDateSeparator(java.lang.String dateSeparator)
                      throws AS400Exception,
                             AS400SecurityException,
                             ConnectionDroppedException,
                             ErrorCompletingRequestException,
                             java.lang.InterruptedException,
                             java.io.IOException,
                             ObjectDoesNotExistException,
                             java.io.UnsupportedEncodingException
Sets the value used to separate days, months, and years when presenting a date.
Parameters:
dateSeparator - The value used to separate days, months, and years when presenting a date. The following special value can be used:
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.DATE_SEPARATOR

setDDMConversationHandling

public void setDDMConversationHandling(java.lang.String ddmConversationHandling)
                                throws AS400Exception,
                                       AS400SecurityException,
                                       ConnectionDroppedException,
                                       ErrorCompletingRequestException,
                                       java.lang.InterruptedException,
                                       java.io.IOException,
                                       ObjectDoesNotExistException,
                                       java.io.UnsupportedEncodingException
Sets whether connections using distributed data management (DDM) protocols remain active when they are not being used.
Parameters:
ddmConversationHandling - Whether connections using distributed data management (DDM) protocols remain active when they are not being used. Possible values are:
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.KEEP_DDM_CONNECTIONS_ACTIVE

setDecimalFormat

public void setDecimalFormat(java.lang.String decimalFormat)
                      throws AS400Exception,
                             AS400SecurityException,
                             ConnectionDroppedException,
                             ErrorCompletingRequestException,
                             java.lang.InterruptedException,
                             java.io.IOException,
                             ObjectDoesNotExistException,
                             java.io.UnsupportedEncodingException
Sets the decimal format used for this job.
Parameters:
decimalFormat - The decimal format used for this job. Possible values are:
  • RJob.DECIMAL_FORMAT_PERIOD - Uses a period for a decimal point, a comma for a 3-digit grouping character, and zero-suppresses to the left of the decimal point.
  • RJob.DECIMAL_FORMAT_COMMA_I - Uses a comma for a decimal point and a period for a 3-digit grouping character. The zero-suppression character is in the second character (rather than the first) to the left of the decimal notation. Balances with zero values to the left of the comma are written with one leading zero.
  • RJob.DECIMAL_FORMAT_COMMA_J - Uses a comma for a decimal point, a period for a 3-digit grouping character, and zero-suppresses to the left of the decimal point.
  • RJob.SYSTEM_VALUE - The system value QECFMT is used.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.DECIMAL_FORMAT

setDefaultWait

public void setDefaultWait(int defaultWait)
                    throws AS400Exception,
                           AS400SecurityException,
                           ConnectionDroppedException,
                           ErrorCompletingRequestException,
                           java.lang.InterruptedException,
                           java.io.IOException,
                           ObjectDoesNotExistException,
                           java.io.UnsupportedEncodingException
Sets the default maximum time (in seconds) that a thread in the job waits for a system instruction.
Parameters:
defaultWait - The default maximum time (in seconds) that a thread in the job waits for a system instruction. The value -1 means there is no maximum. The value 0 is not valid.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
ErrorCompletingRequestException - If an error occurs before the request is completed.
java.lang.InterruptedException - If this thread is interrupted.
java.io.IOException - If an error occurs while communicating with the AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
RJob.DEFAULT_WAIT_TIME

setDeviceRecoveryAction

public void setDeviceRecoveryAction(java.lang.String deviceRecoveryAction)
                             throws AS400Exception,
                                    AS400SecurityException,
                                    ConnectionDroppedException,
                                    ErrorCompletingRequestException,
                                    java.lang.InterruptedException,
                                    java.io.IOException,
                                    ObjectDoesNotExistException,
                                    java.io.UnsupportedEncodingException
Sets the action taken for interactive jobs when an I/O error occurs for the job's requesting program device.
Parameters:
deviceRecoveryAction - The action taken for interactive jobs when an I/O error occurs for the job's requesting program device. Possible values are:
  • RJob.DEVICE_RECOVERY_ACTION_MESSAGE - Signals the I/O error message to the application and lets the application program perform error recovery.
  • RJob.DEVICE_RECOVERY_ACTION_DISCONNECT_MESSAGE - 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 workstation device has recovered.
  • RJob.DEVICE_RECOVERY_ACTION_DISCONNECT_END_REQUEST - 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.
  • RJob.DEVICE_RECOVERY_ACTION_END_JOB - 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.
  • RJob.DEVICE_RECOVERY_ACTION_END_JOB_NO_LIST - 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.
  • RJob.SYSTEM_VALUE - The system value QDEVRCYACN is used.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.DEVICE_RECOVERY_ACTION

  • setInquiryMessageReply

    public void setInquiryMessageReply(java.lang.String inquiryMessageReply)
                                throws AS400Exception,
                                       AS400SecurityException,
                                       ConnectionDroppedException,
                                       ErrorCompletingRequestException,
                                       java.lang.InterruptedException,
                                       java.io.IOException,
                                       ObjectDoesNotExistException,
                                       java.io.UnsupportedEncodingException
    Sets how the job answers inquiry messages.
    Parameters:
    inquiryMessageReply - How the job answers inquiry messages. Possible values are:
    • RJob.INQUIRY_MESSAGE_REPLY_REQUIRED - The job requires an answer for any inquiry messages that occur while this job is running.
    • RJob.INQUIRY_MESSAGE_REPLY_DEFAULT - The system uses the default message reply to answer any inquiry messages issued while this job is running. The default reply is either defined in the message description or is the default system reply.
    • RJob.INQUIRY_MESSAGE_REPLY_SYSTEM_REPLY_LIST 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.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.INQUIRY_MESSAGE_REPLY

    setInternalJobID

    public void setInternalJobID(java.lang.String internalJobID)
                          throws java.beans.PropertyVetoException
    Sets the internal job identifier. This does not change the job on the AS/400. Instead, it changes the job this Job object references. The job name must be set to "*INT" for this to be recognized. This cannot be changed if the object has established a connection to the AS/400.
    Parameters:
    internalJobID - The internal job identifier.
    Throws:
    java.beans.PropertyVetoException - If the property change is vetoed.

    setJobAccountingCode

    public void setJobAccountingCode(java.lang.String jobAccountingCode)
                              throws AS400Exception,
                                     AS400SecurityException,
                                     ConnectionDroppedException,
                                     ErrorCompletingRequestException,
                                     java.lang.InterruptedException,
                                     java.io.IOException,
                                     ObjectDoesNotExistException,
                                     java.io.UnsupportedEncodingException
    Sets the identifier assigned to the job by the system to collect resource use information for the job when job accounting is active.
    Parameters:
    jobAccountingCode - The identifier assigned to the job by the system to collect resource use information for the job when job accounting is active.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.ACCOUNTING_CODE

    setJobDate

    public void setJobDate(java.util.Date jobDate)
                    throws AS400Exception,
                           AS400SecurityException,
                           ConnectionDroppedException,
                           ErrorCompletingRequestException,
                           java.lang.InterruptedException,
                           java.io.IOException,
                           ObjectDoesNotExistException,
                           java.io.UnsupportedEncodingException
    Sets the date to be used for the job.
    Parameters:
    jobDate - The date to be used for the job.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.JOB_DATE

    setJobMessageQueueFullAction

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

    setJobSwitches

    public void setJobSwitches(java.lang.String jobSwitches)
                        throws AS400Exception,
                               AS400SecurityException,
                               ConnectionDroppedException,
                               ErrorCompletingRequestException,
                               java.lang.InterruptedException,
                               java.io.IOException,
                               ObjectDoesNotExistException,
                               java.io.UnsupportedEncodingException
    Sets the current setting of the job switches used by this job.
    Parameters:
    jobSwitches - The current setting of the job switches used by this job.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.JOB_SWITCHES

    setLanguageID

    public void setLanguageID(java.lang.String languageID)
                       throws AS400Exception,
                              AS400SecurityException,
                              ConnectionDroppedException,
                              ErrorCompletingRequestException,
                              java.lang.InterruptedException,
                              java.io.IOException,
                              ObjectDoesNotExistException,
                              java.io.UnsupportedEncodingException
    Sets the language identifier associated with this job.
    Parameters:
    languageID - The language identifier associated with this job. The following special values can be used:
    • RJob.SYSTEM_VALUE - The system value QLANGID is used.
    • RJob.USER_PROFILE - The language identifier specified in the user profile in which this thread was initially running is used.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.LANGUAGE_ID

    setLoggingCLPrograms

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

    setLoggingLevel

    public void setLoggingLevel(int loggingLevel)
                         throws AS400Exception,
                                AS400SecurityException,
                                ConnectionDroppedException,
                                ErrorCompletingRequestException,
                                java.lang.InterruptedException,
                                java.io.IOException,
                                ObjectDoesNotExistException,
                                java.io.UnsupportedEncodingException
    Sets the type of information that is logged.
    Parameters:
    loggingLevel - The type of information that is logged. 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 - Requests or commands from CL programs for which the system issues messages with a severity code greater than or equal to the logging severity and all messages associated with those requests or commands that have a severity code greater than or equal to the logging severity are logged.
    • 3 - All requests or commands from CL programs and all messages associated with those requests or commands that have a severity code greater than or equal to the logging severity are logged.
    • 4 - All requests or commands from CL programs and all messages with a severity code greater than or equal to the logging severity are logged.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.LOGGING_LEVEL

    setLoggingSeverity

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

    setLoggingText

    public void setLoggingText(java.lang.String loggingText)
                        throws AS400Exception,
                               AS400SecurityException,
                               ConnectionDroppedException,
                               ErrorCompletingRequestException,
                               java.lang.InterruptedException,
                               java.io.IOException,
                               ObjectDoesNotExistException,
                               java.io.UnsupportedEncodingException
    Sets the level of message text that is written in the job log or displayed to the user.
    Parameters:
    loggingText - The level of message text that is written in the job log or displayed to the user. Possible values are:
    • RJob.LOGGING_TEXT_MESSAGE - Only the message is written to the job log.
    • RJob.LOGGING_TEXT_SECLVL - Both the message and the message help for the error message are written to the job log.
    • RJob.LOGGING_TEXT_NO_LIST - If the job ends normally, there is no job log. If the job ends abnormally, there is a job log. The messages appearing in the job log contain both the message and the message help.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.LOGGING_TEXT

    setName

    public void setName(java.lang.String name)
                 throws java.beans.PropertyVetoException
    Sets the job name. This does not change the job on the AS/400. Instead, it changes the job this Job object references. This cannot be changed if the object has established a connection to the AS/400.
    Parameters:
    name - The job name. Specify "*" to indicate the job this program running in, or "*INT" to indicate that the job is specified using the internal job identifier.
    Throws:
    java.beans.PropertyVetoException - If the property change is vetoed.

    setNumber

    public void setNumber(java.lang.String number)
                   throws java.beans.PropertyVetoException
    Sets the job number. This does not change the job on the AS/400. Instead, it changes the job this Job object references. This cannot be changed if the object has established a connection to the AS/400.
    Parameters:
    number - The job number. This must be blank if the job name is "*".
    Throws:
    java.beans.PropertyVetoException - If the property change is vetoed.

    setOutputQueue

    public void setOutputQueue(java.lang.String outputQueue)
                        throws AS400Exception,
                               AS400SecurityException,
                               ConnectionDroppedException,
                               ErrorCompletingRequestException,
                               java.lang.InterruptedException,
                               java.io.IOException,
                               ObjectDoesNotExistException,
                               java.io.UnsupportedEncodingException
    Sets the name of the default output queue that is used for spooled output produced by this job.
    Parameters:
    outputQueue - The fully qualified integrated integrated file system path name of the default output queue that is used for spooled output produced by this job.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.OUTPUT_QUEUE, QSYSObjectPathName

    setOutputQueuePriority

    public void setOutputQueuePriority(int outputQueuePriority)
                                throws AS400Exception,
                                       AS400SecurityException,
                                       ConnectionDroppedException,
                                       ErrorCompletingRequestException,
                                       java.lang.InterruptedException,
                                       java.io.IOException,
                                       ObjectDoesNotExistException,
                                       java.io.UnsupportedEncodingException
    Sets the output priority for spooled output files that this job produces.
    Parameters:
    outputQueuePriority - The output priority for spooled output files that this job produces. The highest priority is 0 and the lowest is 9.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.OUTPUT_QUEUE_PRIORITY

    setPrinterDeviceName

    public void setPrinterDeviceName(java.lang.String printerDeviceName)
                              throws AS400Exception,
                                     AS400SecurityException,
                                     ConnectionDroppedException,
                                     ErrorCompletingRequestException,
                                     java.lang.InterruptedException,
                                     java.io.IOException,
                                     ObjectDoesNotExistException,
                                     java.io.UnsupportedEncodingException
    Sets the printer device name used for printing output from this job.
    Parameters:
    printerDeviceName - The printer device name used for printing output from this job. The following special values can be used:
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.PRINTER_DEVICE_NAME

    setPrintKeyFormat

    public void setPrintKeyFormat(java.lang.String printKeyFormat)
                           throws AS400Exception,
                                  AS400SecurityException,
                                  ConnectionDroppedException,
                                  ErrorCompletingRequestException,
                                  java.lang.InterruptedException,
                                  java.io.IOException,
                                  ObjectDoesNotExistException,
                                  java.io.UnsupportedEncodingException
    Sets whether border and header information is provided when the Print key is pressed.
    Parameters:
    printKeyFormat - Whether border and header information is provided when the Print key is pressed. Possible values are:
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.PRINT_KEY_FORMAT

    setPrintText

    public void setPrintText(java.lang.String printText)
                      throws AS400Exception,
                             AS400SecurityException,
                             ConnectionDroppedException,
                             ErrorCompletingRequestException,
                             java.lang.InterruptedException,
                             java.io.IOException,
                             ObjectDoesNotExistException,
                             java.io.UnsupportedEncodingException
    Sets the line of text, if any, that is printed at the bottom of each page of printed output for the job.
    Parameters:
    printText - The line of text, if any, that is printed at the bottom of each page of printed output for the job. The following special value can be used:
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.PRINT_TEXT

    setPurge

    public void setPurge(boolean purge)
                  throws AS400Exception,
                         AS400SecurityException,
                         ConnectionDroppedException,
                         ErrorCompletingRequestException,
                         java.lang.InterruptedException,
                         java.io.IOException,
                         ObjectDoesNotExistException,
                         java.io.UnsupportedEncodingException
    Sets the value indicating 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 it is beginning a long wait.
    Parameters:
    purge - true to indicate that 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 it is beginning a long wait, false otherwise.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.ELIGIBLE_FOR_PURGE

    setQueue

    public void setQueue(java.lang.String jobQueue)
                  throws AS400Exception,
                         AS400SecurityException,
                         ConnectionDroppedException,
                         ErrorCompletingRequestException,
                         java.lang.InterruptedException,
                         java.io.IOException,
                         ObjectDoesNotExistException,
                         java.io.UnsupportedEncodingException
    Sets the job queue that the job is currently on.
    Parameters:
    jobQueue - The fully qualified integrate file system path name of the job queue.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.JOB_QUEUE, QSYSObjectPathName

    setQueuePriority

    public void setQueuePriority(int queuePriority)
                          throws AS400Exception,
                                 AS400SecurityException,
                                 ConnectionDroppedException,
                                 ErrorCompletingRequestException,
                                 java.lang.InterruptedException,
                                 java.io.IOException,
                                 ObjectDoesNotExistException,
                                 java.io.UnsupportedEncodingException
    Sets the scheduling priority of the job compared to other jobs on the same job queue.
    Parameters:
    queuePriority - 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.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.JOB_QUEUE_PRIORITY

    setRunPriority

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

    setScheduleDate

    public void setScheduleDate(java.util.Date scheduleDate)
                         throws AS400Exception,
                                AS400SecurityException,
                                ConnectionDroppedException,
                                ErrorCompletingRequestException,
                                java.lang.InterruptedException,
                                java.io.IOException,
                                ObjectDoesNotExistException,
                                java.io.UnsupportedEncodingException
    Sets the date and time the job is scheduled to become active.
    Parameters:
    scheduleDate - The date and time the job is scheduled to become active.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.SCHEDULE_DATE

    setScheduleDate

    public void setScheduleDate(java.lang.String scheduleDate)
                         throws AS400Exception,
                                AS400SecurityException,
                                ConnectionDroppedException,
                                ErrorCompletingRequestException,
                                java.lang.InterruptedException,
                                java.io.IOException,
                                ObjectDoesNotExistException,
                                java.io.UnsupportedEncodingException
    Sets the date the job is scheduled to become active.
    Parameters:
    scheduleDate - The date the job is scheduled to become active, in the format CYYMMDD, where C is the century, YY is the year, MM is the month, and DD is the day. A 0 for the century flag indicates years 19xx and a 1 indicates years 20xx.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.SCHEDULE_DATE

    setScheduleTime

    public void setScheduleTime(java.util.Date scheduleTime)
                         throws AS400Exception,
                                AS400SecurityException,
                                ConnectionDroppedException,
                                ErrorCompletingRequestException,
                                java.lang.InterruptedException,
                                java.io.IOException,
                                ObjectDoesNotExistException,
                                java.io.UnsupportedEncodingException
    Sets the date and time the job is scheduled to become active.
    Parameters:
    scheduleDate - The date and time the job is scheduled to become active.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.SCHEDULE_DATE

    setScheduleTime

    public void setScheduleTime(java.lang.String scheduleTime)
                         throws AS400Exception,
                                AS400SecurityException,
                                ConnectionDroppedException,
                                ErrorCompletingRequestException,
                                java.lang.InterruptedException,
                                java.io.IOException,
                                ObjectDoesNotExistException,
                                java.io.UnsupportedEncodingException
    Sets the time the job is scheduled to become active.
    Parameters:
    scheduleTime - The time the job is scheduled to become active, in the format HHMMSS, where HH are the hours, MM are the minutes, and SS are the seconds.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.SCHEDULE_DATE

    setSortSequenceTable

    public void setSortSequenceTable(java.lang.String sortSequenceTable)
                              throws AS400Exception,
                                     AS400SecurityException,
                                     ConnectionDroppedException,
                                     ErrorCompletingRequestException,
                                     java.lang.InterruptedException,
                                     java.io.IOException,
                                     ObjectDoesNotExistException,
                                     java.io.UnsupportedEncodingException
    Sets the sort sequence table.
    Parameters:
    sortSequenceTable - The fully qualified integrated file system path name of the sort sequence table.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.SORT_SEQUENCE_TABLE, QSYSObjectPathName

    setStatusMessageHandling

    public void setStatusMessageHandling(java.lang.String statusMessageHandling)
                                  throws AS400Exception,
                                         AS400SecurityException,
                                         ConnectionDroppedException,
                                         ErrorCompletingRequestException,
                                         java.lang.InterruptedException,
                                         java.io.IOException,
                                         ObjectDoesNotExistException,
                                         java.io.UnsupportedEncodingException
    Sets the value which indicates whether status messages are displayed for this job.
    Parameters:
    statusMessageHandling - The value which indicates whether status messages are displayed for this job. Possible values are:
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.STATUS_MESSAGE_HANDLING

    setSystem

    public void setSystem(AS400 system)
                   throws java.beans.PropertyVetoException
    Sets the system. This cannot be changed if the object has established a connection to the AS/400.
    Parameters:
    system - The system.
    Throws:
    java.beans.PropertyVetoException - If the property change is vetoed.

    setTimeSeparator

    public void setTimeSeparator(java.lang.String timeSeparator)
                          throws AS400Exception,
                                 AS400SecurityException,
                                 ConnectionDroppedException,
                                 ErrorCompletingRequestException,
                                 java.lang.InterruptedException,
                                 java.io.IOException,
                                 ObjectDoesNotExistException,
                                 java.io.UnsupportedEncodingException
    Sets the value used to separate hours, minutes, and seconds when presenting a time.
    Parameters:
    timeSeparator - The value used to separate hours, minutes, and seconds when presenting a time. The following special value can be used:
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.TIME_SEPARATOR

    setTimeSlice

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

    setTimeSliceEndPool

    public void setTimeSliceEndPool(java.lang.String timeSliceEndPool)
                             throws AS400Exception,
                                    AS400SecurityException,
                                    ConnectionDroppedException,
                                    ErrorCompletingRequestException,
                                    java.lang.InterruptedException,
                                    java.io.IOException,
                                    ObjectDoesNotExistException,
                                    java.io.UnsupportedEncodingException
    Sets the value which indicates whether a thread in an interactive job moves to another main storage pool at the end of its time slice.
    Parameters:
    timeSliceEndPool - The value which indicates whether a thread in an interactive job moves to another main storage pool at the end of its time slice. Possible values are:
    • RJob.NONE - A thread in the job does not move to another main storage pool when it reaches the end of its time slice.
    • RJob.TIME_SLICE_END_POOL_BASE - A thread in the job moves to the base pool when it reaches the end of its time slice.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    java.lang.InterruptedException - If this thread is interrupted.
    java.io.IOException - If an error occurs while communicating with the AS/400.
    ObjectDoesNotExistException - If the AS/400 object does not exist.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    RJob.TIME_SLICE_END_POOL

    setUser

    public void setUser(java.lang.String user)
                 throws java.beans.PropertyVetoException
    Sets the user name. This does not change the job on the AS/400. Instead, it changes the job this Job object references. This cannot be changed if the object has established a connection to the AS/400.
    Parameters:
    user - The user name. This must be blank if the job name is "*".
    Throws:
    java.beans.PropertyVetoException - If the property change is vetoed.

    toString

    public java.lang.String toString()
    Returns the string representation in the format "number/user/name".
    Overrides:
    toString in class java.lang.Object
    Returns:
    The string representation.