com.ibm.as400.access
Class Job

java.lang.Object
  extended by com.ibm.as400.access.Job
All Implemented Interfaces:
Serializable

public class Job
extends Object
implements Serializable

Represents a job on the IBM i server. 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 and sufficient combination of these must be set before 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 IBM Toolbox for Java. The complete set of attribute values can be accessed using the public constants.

Note: Most of the 'get' methods will either go to the system to retrieve the job attribute value, or will return a cached value if the attribute was previously retrieved or previously set by setValue() or one of the other 'set' methods. Use loadInformation() to refresh the attribute values from the system.
For example:

  Job job = new Job(system, jobName, userName, jobNumber);
  while (job.getStatus().equals(Job.JOB_STATUS_ACTIVE))
  {
      // Wait a while.
      Thread.sleep(1000);
      // Refresh the attribute values.
      job.loadInformation();
  }
  System.out.println("Job status is: " + job.getStatus());
 

Note: Jobs created by SBMJOB tend to get cleaned-up immediately upon job completion (if no spooled files were created); whereupon getStatus(), getCompletionStatus(), and most other 'get' methods will throw an AS400Exception containing an AS400Message indicating "Internal job identifier no longer valid" (message ID CPF3C52). That exception should be interpreted as an indication that the job has completed.

Note: To obtain information about the job in which a program or command runs, do something like the following:

  AS400 system = new AS400();
  ProgramCall pgm = new ProgramCall(system);
  pgm.setThreadSafe(true);  // Indicates that the program is to be run on-thread.
  String jobNumber = pgm.getServerJob().getNumber();
 
(If the program or command is not to be run on-thread, omit the setThreadSafe() call.)

See Also:
JobList, CommandCall.getServerJob(), ProgramCall.getServerJob(), Serialized Form

Field Summary
static int ACCOUNTING_CODE
          Job attribute representing an identifier assigned to the job by the system to collect resource use information for the job when job accounting is active.
static String ACCOUNTING_CODE_BLANK
          Constant indicating the accounting code is changed to all blanks.
static int ACTIVE_JOB_STATUS
          Job attribute representing the active status of the initial thread of a job.
static String ACTIVE_JOB_STATUS_DISCONNECTED
          Constant indicating that a job was disconnected from a work station display.
static String ACTIVE_JOB_STATUS_ENDED
          Constant indicating that a job has been ended with the *IMMED option, or its delay time has ended with the *CNTRLD option.
static String ACTIVE_JOB_STATUS_ENDING
          Constant indicating that a job is ending for a reason other than running the End Job (ENDJOB) or End Subsystem (ENDSBS) commands, such as a SIGNOFF command, an End Group Job (ENDGRPJOB) command, or an exception that is not handled.
static int ACTIVE_JOB_STATUS_FOR_JOBS_ENDING
          Job attribute representing the status of what the initial thread of a job is currently doing, when the active job status is ACTIVE_JOB_STATUS_ENDED or ACTIVE_JOB_STATUS_ENDING.
static String ACTIVE_JOB_STATUS_HELD
          Constant indicating that a job is held.
static String ACTIVE_JOB_STATUS_HELD_THREAD
          Constant indicating that a job is held due to a suspended thread.
static String ACTIVE_JOB_STATUS_INELIGIBLE
          Constant indicating that a job is ineligible and not currently in a pool activity level.
static String ACTIVE_JOB_STATUS_NONE
          Constant indicating that a job is in transition or is not active.
static String ACTIVE_JOB_STATUS_RUNNING
          Constant indicating that a job is currently running in a pool activity level.
static String ACTIVE_JOB_STATUS_STOPPED
          Constant indicating that a job has stopped as the result of a signal.
static String ACTIVE_JOB_STATUS_SUSPENDED
          Constant indicating that a job is suspended by a Transfer Group Job (TFRGRPJOB) command.
static String ACTIVE_JOB_STATUS_SUSPENDED_SYSTEM_REQUEST
          Constant indicating that a job is the suspended half of a system request job pair.
static String ACTIVE_JOB_STATUS_WAIT_BIN_SYNCH_DEVICE
          Constant indicating that a job is waiting for the completion of an I/O operation to a binary synchronous device.
static String ACTIVE_JOB_STATUS_WAIT_BIN_SYNCH_DEVICE_AND_ACTIVE
          Constant indicating that a job is waiting in a pool activity level for the completion of an I/O operation to a binary synchronous device.
static String ACTIVE_JOB_STATUS_WAIT_CHECKPOINT
          Constant indicating that a job is waiting for the completion of save-while-active checkpoint processing in another job.
static String ACTIVE_JOB_STATUS_WAIT_COMM_DEVICE
          Constant indicating that a job is waiting for the completion of an I/O operation to a communications device.
static String ACTIVE_JOB_STATUS_WAIT_COMM_DEVICE_AND_ACTIVE
          Constant indicating that a job is waiting in a pool activity level for the completion of an I/O operation to a communications device.
static String ACTIVE_JOB_STATUS_WAIT_CONDITION
          Constant indicating that a job is waiting on a handle-based condition.
static String ACTIVE_JOB_STATUS_WAIT_CPI_COMM
          Constant indicating that a job is waiting for the completion of a CPI communications call.
static String ACTIVE_JOB_STATUS_WAIT_DATABASE_EOF
          Constant indicating that a job is waiting to try a read operation again on a database file after the end-of-file (EOF) has been reached.
static String ACTIVE_JOB_STATUS_WAIT_DATABASE_EOF_AND_ACTIVE
          Constant indicating that a job is waiting in a pool activity level to try a read operation again on a database file after the end-of-file (EOF) has been reached.
static String ACTIVE_JOB_STATUS_WAIT_DELAY
          Constant indicating that a job is waiting for a specified time interval to end, or for a specific delay end time, as specified on the Delay Job (DLYJOB) command.
static String ACTIVE_JOB_STATUS_WAIT_DELAYED
          Constant indicating that a job is waiting for a specified time interval to end, or for a specific delay end time, as specified on the Delay Job (DLYJOB) command.
static String ACTIVE_JOB_STATUS_WAIT_DEQUEUE
          Constant indicating that a job is waiting for completion of a dequeue operation.
static String ACTIVE_JOB_STATUS_WAIT_DEQUEUE_AND_ACTIVE
          Constant indicating that a job is waiting in the pool activity level for completion of a dequeue operation.
static String ACTIVE_JOB_STATUS_WAIT_DISKETTE
          Constant indicating that a job is waiting for the completion of an I/O operation to a diskette unit.
static String ACTIVE_JOB_STATUS_WAIT_DISKETTE_AND_ACTIVE
          Constant indicating that a job is waiting in a pool activity level for the completion of an I/O operation to a diskette unit.
static String ACTIVE_JOB_STATUS_WAIT_DISPLAY
          Constant indicating that a job is waiting for input from a work station display.
static String ACTIVE_JOB_STATUS_WAIT_DISPLAY_AND_ACTIVE
          Constant indicating that a job is waiting in a pool activity level for input from a work station display.
static String ACTIVE_JOB_STATUS_WAIT_EVENT
          Constant indicating that a job is waiting for an event.
static String ACTIVE_JOB_STATUS_WAIT_ICF_FILE
          Constant indicating that a job is waiting for the completion of an I/O operation to an intersystem communications function (ICF) file.
static String ACTIVE_JOB_STATUS_WAIT_ICF_FILE_AND_ACTIVE
          Constant indicating that a job is waiting in a pool activity level for the completion of an I/O operation to an intersystem communications function (ICF) file.
static String ACTIVE_JOB_STATUS_WAIT_JAVA
          Constant indicating that a job is waiting for a Java program operation to complete.
static String ACTIVE_JOB_STATUS_WAIT_JAVA_AND_ACTIVE
          Constant indicating that a job is waiting in a pool activity level for a Java program operation to complete.
static String ACTIVE_JOB_STATUS_WAIT_LOCK
          Constant indicating that a job is waiting for a lock.
static String ACTIVE_JOB_STATUS_WAIT_LOCK_SPACE
          Constant indicating that a job is waiting for a lock space to be attached.
static String ACTIVE_JOB_STATUS_WAIT_LOCK_SPACE_AND_ACTIVE
          Constant indicating that a job is waiting in a pool activity level for for a lock space to be attached.
static String ACTIVE_JOB_STATUS_WAIT_MESSAGE
          Constant indicating that a job is waiting for a message from a message queue.
static String ACTIVE_JOB_STATUS_WAIT_MIXED_DEVICE_FILE
          Constant indicating that a job is waiting for the completion of an I/O operation to a mixed device file.
static String ACTIVE_JOB_STATUS_WAIT_MULTIPLE_FILES
          Constant indicating that a job is waiting for the completion of an I/O operation to multiple files.
static String ACTIVE_JOB_STATUS_WAIT_MULTIPLE_FILES_AND_ACTIVE
          Constant indicating that a job is waiting in a pool activity level for the completion of an I/O operation to multiple files.
static String ACTIVE_JOB_STATUS_WAIT_MUTEX
          Constant indicating that a job is waiting for a mutex.
static String ACTIVE_JOB_STATUS_WAIT_OPTICAL_DEVICE
          Constant indicating that a job is waiting for the completion of an I/O operation to an optical device.
static String ACTIVE_JOB_STATUS_WAIT_OPTICAL_DEVICE_AND_ACTIVE
          Constant indicating that a job is waiting in a pool activity level for the completion of an I/O operation to an optical device.
static String ACTIVE_JOB_STATUS_WAIT_OSI
          Constant indicating that a job is waiting for the completion of an OSI Communications Subsystem operation.
static String ACTIVE_JOB_STATUS_WAIT_PRESTART
          Constant indicating that a prestart job is waiting for a program start request.
static String ACTIVE_JOB_STATUS_WAIT_PRINT
          Constant indicating that a job is waiting for output to a printer to complete.
static String ACTIVE_JOB_STATUS_WAIT_PRINT_AND_ACTIVE
          Constant indicating that a job is waiting in a pool activity level for output to a printer to complete.
static String ACTIVE_JOB_STATUS_WAIT_SAVE_FILE
          Constant indicating that a job is waiting for the completion of a save file operation.
static String ACTIVE_JOB_STATUS_WAIT_SAVE_FILE_AND_ACTIVE
          Constant indicating that a job is waiting in a pool activity level for the completion of a save file operation.
static String ACTIVE_JOB_STATUS_WAIT_SELECTION
          Constant indicating that a job is waiting for a selection to complete.
static String ACTIVE_JOB_STATUS_WAIT_SEMAPHORE
          Constant indicating that a job is waiting for a semaphore.
static String ACTIVE_JOB_STATUS_WAIT_SIGNAL
          Constant indicating that a job is waiting for a signal.
static String ACTIVE_JOB_STATUS_WAIT_TAPE_DEVICE
          Constant indicating that a job is waiting for the completion of an I/O operation to a tape device.
static String ACTIVE_JOB_STATUS_WAIT_TAPE_DEVICE_AND_ACTIVE
          Constant indicating that a job is waiting in a pool activity level for the completion of an I/O operation to a tape device.
static String ACTIVE_JOB_STATUS_WAIT_THREAD
          Constant indicating that a job is waiting for another thread to complete an operation.
static String ACTIVE_JOB_STATUS_WAIT_TIME_INTERVAL
          Constant indicating that a job is waiting for a time interval to end.
static String ACTIVE_JOB_STATUS_WAIT_TIME_INTERVAL_AND_ACTIVE
          Constant indicating that a job is waiting in a pool activity level for a time interval to end.
static int ALLOW_MULTIPLE_THREADS
          Job attribute representing whether a job allows multiple user threads.
static String ALLOW_MULTIPLE_THREADS_NO
          Constant indicating that a job does not allow multiple user threads.
static String ALLOW_MULTIPLE_THREADS_YES
          Constant indicating that a job allows multiple user threads.
static int AUXILIARY_IO_REQUESTS
          Job attribute representing the number of auxiliary I/O requests performed by the job across all routing steps.
static int AUXILIARY_IO_REQUESTS_LARGE
          Job attribute representing the number of auxiliary I/O requests performed by the job across all routing steps.
static int BREAK_MESSAGE_HANDLING
          Job attribute representing how a job handles break messages.
static String BREAK_MESSAGE_HANDLING_HOLD
          Constant indicating that the message queue holds break messages until a user or program requests them.
static String BREAK_MESSAGE_HANDLING_NORMAL
          Constant indicating that the message queue status determines break message handling.
static String BREAK_MESSAGE_HANDLING_NOTIFY
          Constant indicating that the system notifies the job's message queue when a message arrives.
static int CCSID
          Job attribute representing the coded character set identifier used for this job.
static int CCSID_INITIAL_USER
          Constant indicating that the CCSID specified in the user profile under which this thread was initially running is used.
static int CCSID_SYSTEM_VALUE
          Constant indicating that the CCSID specified in the system value QCCSID is used.
static int CHARACTER_ID_CONTROL
          Job attribute representing the character identifier control for a job.
static String CHARACTER_ID_CONTROL_DEVICE
          Constant indicating to perform the same function for *DEVD as on the CHRID command parameter for display files, printer files, and panel groups.
static String CHARACTER_ID_CONTROL_INITIAL_USER
          Constant indicating the CHRIDCTL specified in the user profile under which this thread was initially running will be used.
static String CHARACTER_ID_CONTROL_JOB
          Constant indicating to perform the same function for *JOBCCSID as on the CHRID command parameter for display files, printer files, and panel groups.
static String CHARACTER_ID_CONTROL_SYSTEM_VALUE
          Constant indicating the value in the QCHRIDCTL system value will be used.
static int CLIENT_IP_ADDRESS
          Job attribute representing the IPv4 address of the client for which this system is doing work.
static int COMPLETION_STATUS
          Job attribute representing the completion status for a job.
static String COMPLETION_STATUS_COMPLETED_ABNORMALLY
          Constant indicating that the job completed abnormally.
static String COMPLETION_STATUS_COMPLETED_NORMALLY
          Constant indicating that the job completed normally.
static String COMPLETION_STATUS_NOT_COMPLETED
          Constant indicating that the job has not completed.
static int CONTROLLED_END_REQUESTED
          Job attribute representing whether or not the system issued a controlled cancellation.
static int COUNTRY_ID
          Job attribute representing the country or region identifier associated with this job.
static String COUNTRY_ID_INITIAL_USER
          Constant indicating the country or region ID specified in the user profile under which this thread was initially running is used.
static String COUNTRY_ID_SYSTEM_VALUE
          Constant indicating the system value QCNTRYID is used.
static int CPU_TIME_USED
          Job attribute representing the amount of processing unit time (in milliseconds) that the job used.
static int CPU_TIME_USED_FOR_DATABASE
          Job attribute representing the amount of processing unit time (in milliseconds) that the job used for processing data base requests across all routing steps.
static int CPU_TIME_USED_LARGE
          Job attribute representing the amount of processing unit time (in milliseconds) that the job used across all routing steps.
static int CURRENT_LIBRARY
          Job attribute representing the name of the current library for the initial thread of the job.
static int CURRENT_LIBRARY_EXISTENCE
          Job attribute representing whether or not a current library exists for the job.
static int CURRENT_SYSTEM_POOL_ID
          Job attribute representing the identifier of the system-related pool from which main storage is currently being allocated for the job's initial thread.
static int CURRENT_USER
          Job attribute representing the user profile that the initial thread of the job for which information is being retrieved is currently running under.
static int DATE_ENDED
          Job attribute representing the date and time when the job completed running on the system.
static int DATE_ENTERED_SYSTEM
          Job attribute representing the date and time when the job was placed on the system.
static int DATE_FORMAT
          Job attribute representing the format in which dates are presented.
static String DATE_FORMAT_DMY
          Constant indicating a date format of day, month, and year.
static String DATE_FORMAT_JULIAN
          Constant indicating a Julian date format (year and day).
static String DATE_FORMAT_MDY
          Constant indicating a date format of month, day, and year.
static String DATE_FORMAT_SYSTEM_VALUE
          Constant indicating the system value QDATFMT is used.
static String DATE_FORMAT_YMD
          Constant indicating a date format of year, month, and day.
static int DATE_SEPARATOR
          Job attribute representing the value used to separate days, months, and years when presenting a date.
static String DATE_SEPARATOR_BLANK
          Constant indicating a blank is used for the date separator.
static String DATE_SEPARATOR_COMMA
          Constant indicating a comma (,) is used for the date separator.
static String DATE_SEPARATOR_DASH
          Constant indicating a dash (-) is used for the date separator.
static String DATE_SEPARATOR_PERIOD
          Constant indicating a period (.) is used for the date separator.
static String DATE_SEPARATOR_SLASH
          Constant indicating a slash (/) is used for the date separator.
static String DATE_SEPARATOR_SYSTEM_VALUE
          Constant indicating the system value QDATSEP is used for the date separator.
static int DATE_STARTED
          Job attribute representing the date and time when the job began to run on the system.
static int DBCS_CAPABLE
          Job attribute representing whether the job is DBCS-capable or not.
static String DBCS_CAPABLE_NO
          Constant indicating that the job is not DBCS-capable.
static String DBCS_CAPABLE_YES
          Constant indicating that the job is DBCS-capable.
static int DECIMAL_FORMAT
          Job attribute representing the decimal format used for this job.
static String DECIMAL_FORMAT_COMMA_I
          Constant indicating a decimal format that 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.
static String DECIMAL_FORMAT_COMMA_J
          Constant indicating a decimal format that uses a comma for a decimal point and a period for a 3-digit grouping character.
static String DECIMAL_FORMAT_PERIOD
          Constant indicating a decimal format that 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.
static String DECIMAL_FORMAT_SYSTEM_VALUE
          Constant indicating the value in the system value QDECFMT is used as the decimal format for this job.
static int DEFAULT_CCSID
          Job attribute representing the default coded character set identifier (CCSID) used for this job.
static int DEFAULT_WAIT_TIME
          Job attribute representing the default maximum time (in seconds) that a thread in the job waits for a system instruction, such as a LOCK machine interface (MI) instruction, to acquire a resource.
static int DEVICE_RECOVERY_ACTION
          Job attribute representing the action taken for interactive jobs when an I/O error occurs for the job's requesting program device.
static String DEVICE_RECOVERY_ACTION_DISCONNECT_END_REQUEST
          Constant indicating a device recovery action that disconnects the job when an I/O error occurs.
static String DEVICE_RECOVERY_ACTION_DISCONNECT_MESSAGE
          Constant indicating a device recovery action that disconnects the job when an I/O error occurs.
static String DEVICE_RECOVERY_ACTION_END_JOB
          Constant indicating a device recovery action that ends the job when an I/O error occurs.
static String DEVICE_RECOVERY_ACTION_END_JOB_NO_LIST
          Constant indicating a device recovery action that ends the job when an I/O error occurs.
static String DEVICE_RECOVERY_ACTION_MESSAGE
          Constant indicating a device recovery action that signals the I/O error message to the application and lets the application program perform error recovery.
static String DEVICE_RECOVERY_ACTION_SYSTEM_VALUE
          Constant indicating the value in the system value QDEVRCYACN is used as the device recovery action for this job.
static int ELAPSED_CPU_PERCENT_USED
          Job attribute representing the percentage of processing time used during the elapsed time.
static int ELAPSED_CPU_PERCENT_USED_FOR_DATABASE
          Job attribute representing the percentage of processing unit used for database processing during the elapsed time.
static int ELAPSED_CPU_TIME_USED
          Job attribute representing the amount of processing unit time (in milliseconds) used during the elapsed time.
static int ELAPSED_CPU_TIME_USED_FOR_DATABASE
          Job attribute representing the amount of processing unit time (in milliseconds) used for database processing during the elapsed time.
static int ELAPSED_DISK_IO
          Job attribute representing the number of disk I/O operations performed by the job during the elapsed time.
static int ELAPSED_DISK_IO_ASYNCH
          Job attribute representing the number of asynchronous (physical) disk I/O operations performed by the job during the elapsed time.
static int ELAPSED_DISK_IO_SYNCH
          Job attribute representing the number of synchronous (physical) disk I/O operations performed by the job during the elapsed time.
static int ELAPSED_INTERACTIVE_RESPONSE_TIME
          Job attribute representing the total interactive response time for the initial thread (in hundredths of seconds) for the job during the elapsed time.
static int ELAPSED_INTERACTIVE_TRANSACTIONS
          Job attribute representing the number of user interactions, such as pressing the Enter key or a function key, for the job during the elapsed time for the initial thread.
static int ELAPSED_LOCK_WAIT_TIME
          Job attribute representing the amount of time (in milliseconds) that the initial thread has to wait to obtain database, nondatabase, and internal machine locks during the elapsed time.
static int ELAPSED_PAGE_FAULTS
          Job attribute representing the number of times an active program referenced an address that is not in main storage for the current routing step during the elapsed time.
static int ELAPSED_TIME
          Job attribute representing the time (in milliseconds) that has elapsed between the measurement start time and the current system time.
static int ELIGIBLE_FOR_PURGE
          Job attribute representing whether or not the job is eligible to be moved out of main storage and put into auxiliary storage at the end of a time slice or when entering a long wait (such as waiting for a work station user's response).
static String ELIGIBLE_FOR_PURGE_IGNORED
          Constant indicating that whether a job is eligible for purge or not is ignored because the job type is either *JOBQ or *OUTQ, or the job is not valid.
static String ELIGIBLE_FOR_PURGE_NO
          Constant indicating that a job is not eligible to be moved out of main storage and put into auxiliary storage.
static String ELIGIBLE_FOR_PURGE_YES
          Constant indicating that the job is eligible to be moved out of main storage and put into auxiliary storage.
static int END_SEVERITY
          Job attribute representing the message severity level of escape messages that can cause a batch job to end.
static String END_STATUS_CANCELLED
          Constant indicating that the system, the subsystem in which a job is running, or the job itself is cancelled.
static String END_STATUS_JOB_NOT_RUNNING
          Constant indicating that the job is not running.
static String END_STATUS_NOT_CANCELLED
          Constant indicating that the system, the subsystem in which a job is running, or the job itself is not cancelled.
static int FUNCTION_NAME
          Job attribute representing additional information (as described by the FUNCTION_TYPE attribute) about the last high-level function initiated by the initial thread.
static int FUNCTION_TYPE
          Job attribute representing the last high-level function initiated by the initial thread.
static String FUNCTION_TYPE_BLANK
          Constant indicating that the system is not performing a logged function.
static String FUNCTION_TYPE_COMMAND
          Constant indicating that a command is running interactively, or it is in a batch input stream, or it was requested from a system menu.
static String FUNCTION_TYPE_DELAY
          Constant indicating that the initial thread of the job is processing a Delay Job (DLYJOB) command.
static String FUNCTION_TYPE_GROUP
          Constant indicating that the Transfer Group Job (TFRGRPJOB) command suspended the job.
static String FUNCTION_TYPE_INDEX
          Constant indicating that the initial thread of the job is rebuilding an index (access path).
static String FUNCTION_TYPE_IO
          Constant indicating that the job is a subsystem monitor that is performing input/output (I/O) operations to a work station.
static String FUNCTION_TYPE_JAVA
          Constant indicating that the initial thread of the job is running a Java Vertual Machine (JVM).
static String FUNCTION_TYPE_LOG
          Constant indicating that the system logs history information in a database file.
static String FUNCTION_TYPE_MENU
          Constant indicating that the initial thread of the job is currently at a system menu.
static String FUNCTION_TYPE_MRT
          Constant indicating that the job is a multiple requester terminal (MRT) job if the JOB_TYPE is JOB_TYPE_BATCH and the JOB_SUBTYPE is JOB_SUBTYPE_MRT, or it is an interactive job attached to an MRT job if the JOB_TYPE is JOB_TYPE_INTERACTIVE.
static String FUNCTION_TYPE_PROCEDURE
          Constant indicating that the initial thread of the job is running a procedure.
static String FUNCTION_TYPE_PROGRAM
          Constant indicating that the initial thread of the job is running a program.
static String FUNCTION_TYPE_SPECIAL
          Constant indicating that the function type is a special function.
static long INITIAL_THREAD
          Constant indicating that the initial thread of the job should be used when retrieving the call stack.
static int INQUIRY_MESSAGE_REPLY
          Job attribute representing how the job answers inquiry messages.
static String INQUIRY_MESSAGE_REPLY_DEFAULT
          Constant indicating that the system uses the default message reply to answer any inquiry messages issued while this job is running.
static String INQUIRY_MESSAGE_REPLY_REQUIRED
          Constant indicating that the job requires an answer for any inquiry messages that occur while this job is running.
static String INQUIRY_MESSAGE_REPLY_SYSTEM_REPLY_LIST
          Constant indicating that the system reply list is checked to see if there is an entry for an inquiry message issued while this job is running.
static int INSTANCE
          Job attribute representing the instance portion of the unit of work ID.
static int INTERACTIVE_TRANSACTIONS
          Job attribute representing the count of operator interactions, such as pressing the Enter key or a function key.
static int INTERNAL_JOB_ID
          Deprecated. Use INTERNAL_JOB_IDENTIFIER instead. The internal job identifier should be treated as a byte array of 16 bytes.
static int INTERNAL_JOB_IDENTIFIER
          Job attribute representing the value input to other APIs to increase the speed of locating the job on the system.
static int JOB_DATE
          Job attribute representing the date used for the job.
static int JOB_DESCRIPTION
          Job attribute representing a set of job-related attributes used for one or more jobs on the system.
static int JOB_END_REASON
          Job attribute representing the most recent action that caused the job to end.
static int JOB_LOG_OUTPUT
          Job attribute representing how a job log will be produced when the job completes.
static String JOB_LOG_OUTPUT_JOB_END
          Constant indicating that the job log will be produced by the job itself.
static String JOB_LOG_OUTPUT_JOB_LOG_SERVER
          Constant indicating that the job log will be produced by a job log server.
static String JOB_LOG_OUTPUT_PENDING
          Constant indicating that the job log will not be produced.
static String JOB_LOG_OUTPUT_SYSTEM_VALUE
          Constant indicating that the value is specifed by the QLOGOUTPUT system value.
static int JOB_LOG_PENDING
          Job attribute representing whether a job's log has been written or not.
static String JOB_LOG_PENDING_NO
          Constant indicating that the job log is not pending.
static String JOB_LOG_PENDING_YES
          Constant indicating that the job log is pending and waiting to be written.
static int JOB_NAME
          Job attribute representing the name of the job as identified to the system.
static String JOB_NAME_CURRENT
          Constant indicating the job that this program is running in.
static String JOB_NAME_INTERNAL
          Constant indicating that the INTERNAL_JOB_ID locates the job.
static int JOB_NUMBER
          Job attribute representing the system-generated job number.
static String JOB_NUMBER_BLANK
          Constant indicating a blank job number.
static int JOB_QUEUE
          Job attribute representing the name of the job queue that the job is currently on, or that the job was on if it is currently active.
static int JOB_QUEUE_DATE
          Job attribute representing the date and time this job was put on this job queue.
static int JOB_QUEUE_PRIORITY
          Job attribute representing the scheduling priority of the job compared to other jobs on the same job queue.
static int JOB_QUEUE_STATUS
          Job attribute representing the status of this job on the job queue.
static String JOB_QUEUE_STATUS_BLANK
          Constant indicating that this job was not on a job queue.
static String JOB_QUEUE_STATUS_HELD
          Constant indicating that this job is being held on the job queue.
static String JOB_QUEUE_STATUS_READY
          Constant indicating that this job is ready to be selected.
static String JOB_QUEUE_STATUS_SCHEDULED
          Constant indicating that this job will run as scheduled.
static int JOB_STATUS
          Job attribute representing the status of this job.
static String JOB_STATUS_ACTIVE
          Constant indicating this job is an active job.
static String JOB_STATUS_JOBQ
          Constant indicating this job is currently on a job queue.
static String JOB_STATUS_OUTQ
          Constant indicating this job has completed running, but still has output on an output queue.
static int JOB_SUBTYPE
          Job attribute representing additional information about the job type (if any exists).
static String JOB_SUBTYPE_ALTERNATE_SPOOL_USER
          Constant indicating that the job is an alternate spool user job.
static String JOB_SUBTYPE_BLANK
          Constant indicating that the job has no special subtype or is not a valid job.
static String JOB_SUBTYPE_IMMEDIATE
          Constant indicating that the job is an immediate job.
static String JOB_SUBTYPE_MACHINE_SERVER_JOB
          Constant indicating that the job is an AS/400 Advanced 36 machine server job.
static String JOB_SUBTYPE_MRT
          Constant indicating that the job is a System/36 multiple requester terminal (MRT) job.
static String JOB_SUBTYPE_PRESTART
          Constant indicating that the job is a prestart job.
static String JOB_SUBTYPE_PRINT_DRIVER
          Constant indicating that the job is a print driver job.
static String JOB_SUBTYPE_PROCEDURE_START_REQUEST
          Constant indicating that the job started with a procedure start request.
static int JOB_SWITCHES
          Job attribute representing the current setting of the job switches used by this job.
static int JOB_TYPE
          Job attribute representing the type of job.
static String JOB_TYPE_AUTOSTART
          Constant indicating that the job is an autostart job.
static String JOB_TYPE_BATCH
          Constant indicating that the job is a batch job.
static int JOB_TYPE_ENHANCED
          Job attribute representing the type of job.
static Integer JOB_TYPE_ENHANCED_AUTOSTART
          Constant indicating that the job is an autostart job.
static Integer JOB_TYPE_ENHANCED_BATCH
          Constant indicating that the job is a batch job.
static Integer JOB_TYPE_ENHANCED_BATCH_ALTERNATE_SPOOL_USER
          Constant indicating that the job is a batch alternate spool user job.
static Integer JOB_TYPE_ENHANCED_BATCH_IMMEDIATE
          Constant indicating that the job is a batch immediate job.
static Integer JOB_TYPE_ENHANCED_BATCH_MRT
          Constant indicating that the job is a batch System/36 multiple requester terminal (MRT) job.
static Integer JOB_TYPE_ENHANCED_COMM_PROCEDURE_START_REQUEST
          Constant indicating that the job is a communications procedure start request job.
static Integer JOB_TYPE_ENHANCED_INTERACTIVE
          Constant indicating that the job is an interactive job.
static Integer JOB_TYPE_ENHANCED_INTERACTIVE_GROUP
          Constant indicating that the job is an interactive job that is part of a group.
static Integer JOB_TYPE_ENHANCED_INTERACTIVE_SYSREQ
          Constant indicating that the job is an interactive job that is part of a system request pair.
static Integer JOB_TYPE_ENHANCED_INTERACTIVE_SYSREQ_AND_GROUP
          Constant indicating that the job is an interactive job that is part of a system request pair and part of a group.
static Integer JOB_TYPE_ENHANCED_PRESTART
          Constant indicating that the job is a prestart job.
static Integer JOB_TYPE_ENHANCED_PRESTART_BATCH
          Constant indicating that the job is a prestart batch job.
static Integer JOB_TYPE_ENHANCED_PRESTART_COMM
          Constant indicating that the job is a prestart communications job.
static Integer JOB_TYPE_ENHANCED_READER
          Constant indicating that the job is a reader job.
static Integer JOB_TYPE_ENHANCED_SUBSYSTEM
          Constant indicating that the job is a subsystem job.
static Integer JOB_TYPE_ENHANCED_SYSTEM
          Constant indicating that the job is a system job (all system jobs including SCPF).
static Integer JOB_TYPE_ENHANCED_WRITER
          Constant indicating that the job is a writer job (including both spool writers and print drivers).
static String JOB_TYPE_INTERACTIVE
          Constant indicating that the job is an interactive job.
static String JOB_TYPE_NOT_VALID
          Constant indicating that the job is not a valid job.
static String JOB_TYPE_SCPF_SYSTEM
          Constant indicating that the job is the SCPF system job.
static String JOB_TYPE_SPOOLED_READER
          Constant indicating that the job is a spooled reader job.
static String JOB_TYPE_SPOOLED_WRITER
          Constant indicating that the job is a spooled writer job.
static String JOB_TYPE_SUBSYSTEM_MONITOR
          Constant indicating that the job is a subsystem monitor job.
static String JOB_TYPE_SYSTEM
          Constant indicating that the job is a system job.
static int JOB_USER_IDENTITY
          Job attribute representing the user profile name by which the job is known to other jobs on the system.
static int JOB_USER_IDENTITY_SETTING
          Job attribute representing the method by which the job user identity was set.
static String JOB_USER_IDENTITY_SETTING_APPLICATION
          Constant indicating that the job user identity was explicitly set by an application using one of the Set Job User Identity APIs, QWTSJUID or QwtSetJuid().
static String JOB_USER_IDENTITY_SETTING_DEFAULT
          Constant indicating that the job is currently running single threaded and the job user identity is the name of the user profile under which the job is currently running.
static String JOB_USER_IDENTITY_SETTING_SYSTEM
          Constant indicating that the job is currently running multithreaded and the job user identity was implicitly set by the system when the job became multithreaded.
static int KEEP_DDM_CONNECTIONS_ACTIVE
          Job attribute representing whether connections using distributed data management (DDM) protocols remain active when they are not being used.
static String KEEP_DDM_CONNECTIONS_ACTIVE_DROP
          Constant indicating that the system ends a DDM connection when there are no users.
static String KEEP_DDM_CONNECTIONS_ACTIVE_KEEP
          Constant indicating that the system keeps DDM connections active when there are no users, except for the following: The routing step ends on the source system.
static int LANGUAGE_ID
          Job attribute representing the language identifier associated with this job.
static String LANGUAGE_ID_INITIAL_USER
          Constant indicating the language ID specified in the user profile under which this thread was initially running is used.
static String LANGUAGE_ID_SYSTEM_VALUE
          Constant indicating the system value QLANGID is used.
static int LOCATION_NAME
          Job attribute representing the location name portion of the unit of work ID.
static int LOG_CL_PROGRAMS
          Job attribute representing whether or not commands are logged for CL programs that are run.
static String LOG_CL_PROGRAMS_NO
          Constant indicating that commands are not logged for CL programs that are run.
static String LOG_CL_PROGRAMS_YES
          Constant indicating that commands are logged for CL programs that are run.
static int LOGGING_LEVEL
          Job attribute representing what type of information is logged.
static String LOGGING_LEVEL_ALL_REQUESTS_AND_ASSOCIATED_MESSAGES
          Constant indicating that the following information is logged: Logging level 1 and 2 information is logged.
static String LOGGING_LEVEL_ALL_REQUESTS_AND_MESSAGES
          Constant indicating that the following information is logged: All request messages and all messages with a severity greater than or equal to the message logging severity, including trace messages.
static String LOGGING_LEVEL_MESSAGES_BY_SEVERITY
          Constant indicating that all messages sent to the job's external message queue with a severity greater than or equal to the message logging severity are logged.
static String LOGGING_LEVEL_NONE
          Constant indicating that no messages are logged.
static String LOGGING_LEVEL_REQUESTS_BY_SEVERITY_AND_ASSOCIATED_MESSAGES
          Constant indicating that the following information is logged: Logging level 1 information.
static int LOGGING_SEVERITY
          Job attribute representing the severity level that is used in conjunction with the logging level to determine which error messages are logged in the job log.
static int LOGGING_TEXT
          Job attribute representing the level of message text that is written in the job log when a message is logged according to the LOGGING_LEVEL and LOGGING_SEVERITY.
static String LOGGING_TEXT_MESSAGE
          Constant indicating that only the message text is written to the job log.
static String LOGGING_TEXT_NO_LIST
          Constant indicating that if the job ends normally, no job log is produced.
static String LOGGING_TEXT_SECLVL
          Constant indicating that both the message text and the message help (cause and recovery) of the error message are written to the job log.
static int MAX_CPU_TIME
          Job attribute representing the maximum processing unit time (in milliseconds) that the job can use.
static int MAX_TEMP_STORAGE
          Job attribute representing the maximum amount of auxiliary storage (in kilobytes) that the job can use.
static int MAX_TEMP_STORAGE_LARGE
          Job attribute representing the maximum amount of auxiliary storage (in megabytes) that the job can use.
static int MAX_THREADS
          Job attribute representing the maximum number of threads that a job can run with at any time.
static int MEMORY_POOL
          Job attribute representing the name of the memory pool in which the job started running.
static String MEMORY_POOL_BASE
          Constant indicating that this job is running in the base system pool, which can be shared with other subsystems.
static String MEMORY_POOL_INTERACTIVE
          Constant indicating that this job is running in the shared pool used for interactive work.
static String MEMORY_POOL_MACHINE
          Constant indicating that this job is running in the machine pool.
static String MEMORY_POOL_SPOOL
          Constant indicating that this job is running in the shared pool for spooled writers.
static int MESSAGE_QUEUE_ACTION
          Job attribute representing the action to take when the message queue is full.
static String MESSAGE_QUEUE_ACTION_NO_WRAP
          Constant indicating that when the job message queue is full, do not wrap.
static String MESSAGE_QUEUE_ACTION_PRINT_WRAP
          Constant indicating that when the job message queue is full, wrap the message queue and print the messages that are being overlaid because of the wrapping.
static String MESSAGE_QUEUE_ACTION_SYSTEM_VALUE
          Constant indicating the value specified for the QJOBMSGQFL system value is used.
static String MESSAGE_QUEUE_ACTION_WRAP
          Constant indicating that when the job message queue is full, wrap to the beginning and start filling again.
static int MESSAGE_QUEUE_MAX_SIZE
          Job attribute representing the maximum size (in megabytes) that the job message queue can become.
static int MESSAGE_REPLY
          Job attribute representing whether the job is waiting for a reply to a specific message.
static String MESSAGE_REPLY_NOT_IN_MESSAGE_WAIT
          Constant indicating that the job currently is not in message wait status.
static String MESSAGE_REPLY_NOT_WAITING
          Constant indicating that the job is not waiting for a reply to a message.
static String MESSAGE_REPLY_WAITING
          Constant indicating that the job is waiting for a reply to a message.
static int MODE
          Job attribute representing the mode name of the advanced program-to-program communications (APPC) device that started the job.
static int NETWORK_ID
          Job attribute representing the network ID portion of the unit of work ID.
static int OUTPUT_QUEUE
          Job attribute representing the name of the default output queue that is used for spooled output produced by this job.
static String OUTPUT_QUEUE_DEVICE
          Constant indicating the device specified on the Create Printer File (CRTPRTF), Change Printer File (CHGPRTF), or Override with Printer File (OVRPRTF) commands is used.
static String OUTPUT_QUEUE_INITIAL_USER
          Constant indicating the output queue name specified in the user profile under which this thread was initially running is used.
static int OUTPUT_QUEUE_PRIORITY
          Job attribute representing the output priority for spooled output files that this job produces.
static String OUTPUT_QUEUE_WORK_STATION
          Constant indicating the default output queue that is used with this job is the output queue that is assigned to the work station associated with the job at the time the job is started.
static int PRINT_KEY_FORMAT
          Job attribute representing whether border and header information is provided when the Print key is pressed.
static String PRINT_KEY_FORMAT_ALL
          Constant indicating that the border and header information is included with output from the Print key.
static String PRINT_KEY_FORMAT_BORDER
          Constant indicating that the border information is included with output from the Print key.
static String PRINT_KEY_FORMAT_HEADER
          Constant indicating that the header information is included with output from the Print key.
static String PRINT_KEY_FORMAT_NONE
          Constant indicating that the border and header information is not included with output from the Print key.
static String PRINT_KEY_FORMAT_SYSTEM_VALUE
          Constant indicating that the value specified on the system value QPRTKEYFMT determines whether header or border information is printed.
static int PRINT_TEXT
          Job attribute representing the line of text (if any) that is printed at the bottom of each page of printed output for the job.
static String PRINT_TEXT_BLANK
          Constant indicating that no text is printed on printed output.
static String PRINT_TEXT_SYSTEM_VALUE
          Constant indicating the system value QPRTTXT is used.
static int PRINTER_DEVICE_NAME
          Job attribute representing the printer device used for printing output from this job.
static String PRINTER_DEVICE_NAME_INITIAL_USER
          Constant indicating that the printer device name specified in the user profile under which this thread was initially running is used.
static String PRINTER_DEVICE_NAME_SYSTEM_VALUE
          Constant indicating the value in the system value QPRTDEV is used as the printer device.
static String PRINTER_DEVICE_NAME_WORK_STATION
          Constant indicating that the default printer device used with this job is the printer device assigned to the work station that is associated with the job.
static int PRODUCT_LIBRARIES
          Job attribute representing the libraries that contain product information for the initial thread of the job.
static int PRODUCT_RETURN_CODE
          Job attribute representing the return code set by the compiler for Integrated Language Environment (ILE) languages.
static int PROGRAM_RETURN_CODE
          Job attribute representing the completion status of the last program that has finished running, if the job contains any RPG, COBOL, data file utility (DFU), or sort utility programs.
static int ROUTING_DATA
          Job attribute representing the routing data that is used to determine the routing entry that identifies the program to start for the routing step.
static int RUN_PRIORITY
          Job attribute representing the priority at which the job is currently running, relative to other jobs on the system.
static int SCHEDULE_DATE
          Job attribute representing the date on which the submitted job becomes eligible to run.
static String SCHEDULE_DATE_CURRENT
          Constant indicating the submitted job becomes eligible to run on the current date.
static String SCHEDULE_DATE_FRIDAY
          Constant indicating the job becomes eligible to run on Friday.
static String SCHEDULE_DATE_MONDAY
          Constant indicating the job becomes eligible to run on Monday.
static String SCHEDULE_DATE_MONTH_END
          Constant indicating the submitted job becomes eligible to run on the last day of the month.
static String SCHEDULE_DATE_MONTH_START
          Constant indicating the submitted job becomes eligible to run on the first day of the month.
static String SCHEDULE_DATE_SATURDAY
          Constant indicating the job becomes eligible to run on Saturday.
static String SCHEDULE_DATE_SUNDAY
          Constant indicating the job becomes eligible to run on Sunday.
static String SCHEDULE_DATE_THURSDAY
          Constant indicating the job becomes eligible to run on Thursday.
static String SCHEDULE_DATE_TUESDAY
          Constant indicating the job becomes eligible to run on Tuesday.
static String SCHEDULE_DATE_WEDNESDAY
          Constant indicating the job becomes eligible to run on Wednesday.
static int SCHEDULE_TIME
          Job attribute representing the time on the scheduled date at which the job becomes eligible to run.
static String SCHEDULE_TIME_CURRENT
          Constant indicating the job is submitted on the current time.
static int SEQUENCE_NUMBER
          Job attribute representing the sequence number portion of the unit of work ID.
static int SERVER_TYPE
          Job attribute representing the type of server represented by the job.
static int SIGNED_ON_JOB
          Job attribute representing whether the job is to be treated like a signed-on user on the system.
static String SIGNED_ON_JOB_FALSE
          Constant indicating that the job should not be treated like a signed-on user.
static String SIGNED_ON_JOB_TRUE
          Constant indicating that the job should be treated like a signed-on user.
static int SORT_SEQUENCE_TABLE
          Job attribute representing the sort sequence table associated with this job.
static String SORT_SEQUENCE_TABLE_INITIAL_USER
          Constant indicating the sort sequence table specified in the user profile under which this thread was initially running is used.
static String SORT_SEQUENCE_TABLE_LANGUAGE_SHARED_WEIGHT
          Constant indicating that the sort sequence table used can contain the same weight for multiple characters, and it is the shared weight sort table associated with the language specified in the LANGUAGE_ID attribute.
static String SORT_SEQUENCE_TABLE_LANGUAGE_UNIQUE_WEIGHT
          Constant indicating that the sort sequence table used must contain a unique weight for each character in the code page, and it is the unique weight sort table associated with the language specified in the LANGUAGE_ID parameter.
static String SORT_SEQUENCE_TABLE_NONE
          Constant indicating that no sort sequence table is used.
static String SORT_SEQUENCE_TABLE_SYSTEM_VALUE
          Constant indicating the system value QSRTSEQ is used.
static int SPECIAL_ENVIRONMENT
          Job attribute representing whether a job is running in a particular environment.
static String SPECIAL_ENVIRONMENT_NONE
          Constant indicating that the job is not running in any special environment.
static String SPECIAL_ENVIRONMENT_NOT_ACTIVE
          Constant indicating that the special environment is ignored because the job is not currently active.
static String SPECIAL_ENVIRONMENT_SYSTEM_36
          Constant indicating that the job is running in the System/36 environment.
static int SPOOLED_FILE_ACTION
          Job attribute representing whether spooled files can be accessed through job interfaces once a job has completed its normal activity.
static String SPOOLED_FILE_ACTION_DETACH
          Constant indicating that spooled files are detached from the job when the job completes its activity.
static String SPOOLED_FILE_ACTION_KEEP
          Constant indicating that when the job completes its activity, as long as at least one spooled file for the job exists in the system auxiliary storage pool (ASP 1) or in a basic user ASP (ASPs 2-32), the spooled files are kept with the job and the status of the job is updated to indicate that the job has completed.
static String SPOOLED_FILE_ACTION_SYSTEM_VALUE
          Constant indicating the job will take the spooled file action specified by the QSPLFACN system value.
static int STATUS_MESSAGE_HANDLING
          Job attribute representing whether status messages are displayed for this job.
static String STATUS_MESSAGE_HANDLING_INITIAL_USER
          Constant indicating the status message handling that is specified in the user profile under which this thread was initially running is used.
static String STATUS_MESSAGE_HANDLING_NONE
          Constant indicating that this job does not display status messages.
static String STATUS_MESSAGE_HANDLING_NORMAL
          Constant indicating that this job displays status messages.
static String STATUS_MESSAGE_HANDLING_SYSTEM_VALUE
          Constant indicating the system value QSTSMSG is used.
static int SUBMITTED_BY_JOB_NAME
          Job attribute representing the job name of the submitter's job.
static int SUBMITTED_BY_JOB_NUMBER
          Job attribute representing the job number of the submitter's job.
static int SUBMITTED_BY_USER
          Job attribute representing the user name of the submitter.
static int SUBSYSTEM
          Job attribute representing the subsystem description in which an active job is running.
static int SYSTEM_LIBRARY_LIST
          Job attribute representing the system portion of the library list of the initial thread of the job.
static int SYSTEM_POOL_ID
          Job attribute representing the identifier of the system-related pool from which the job's main storage is allocated.
static int TEMP_STORAGE_USED
          Job attribute representing the amount of auxiliary storage (in kilobytes) that is currently allocated to this job.
static int TEMP_STORAGE_USED_LARGE
          Job attribute representing the amount of auxiliary storage (in megabytes) that is currently allocated to this job.
static int THREAD_COUNT
          Job attribute representing the count of the current number of active threads in the process at the time of the materialization.
static int TIME_SEPARATOR
          Job attribute representing the value used to separate hours, minutes, and seconds when presenting a time.
static String TIME_SEPARATOR_BLANK
          Constant indicating a blank is used for the time separator.
static String TIME_SEPARATOR_COLON
          Constant indicating a colon (:) is used for the time separator.
static String TIME_SEPARATOR_COMMA
          Constant indicating a comma (,) is used for the time separator.
static String TIME_SEPARATOR_PERIOD
          Constant indicating a period (.) is used for the time separator.
static String TIME_SEPARATOR_SYSTEM_VALUE
          Constant indicating the time separator specified in the system value QTIMSEP is used.
static int TIME_SLICE
          Job attribute representing 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.
static int TIME_SLICE_END_POOL
          Job attribute representing whether a thread in an interactive job moves to another main storage pool at the end of its time slice.
static String TIME_SLICE_END_POOL_BASE
          Constant indicating that a thread in the job moves to the base pool when it reaches the end of its time slice.
static String TIME_SLICE_END_POOL_NONE
          Constant indicating that a thread in the job does not move to another main storage pool when it reaches the end of its time slice.
static String TIME_SLICE_END_POOL_SYSTEM_VALUE
          Constant indicating the value in the system value QTSEPPOOL is used.
static int TOTAL_RESPONSE_TIME
          Job attribute representing the total amount of response time for the initial thread, in milliseconds.
static int UNIT_OF_WORK_ID
          Job attribute representing the unit of work ID used to track jobs across multiple systems.
static int USER_LIBRARY_LIST
          Job attribute representing the user portion of the library list for the initial thread of the job.
static int USER_NAME
          Job attribute representing the user name of the job, which is the same as the name of the user profile under which the job was started.
static String USER_NAME_BLANK
          Constant indicating a blank user name.
static int USER_RETURN_CODE
          Job attribute representing the user-defined return code set by ILE high-level language constructs.
 
Constructor Summary
Job()
          Constructs a Job object.
Job(AS400 system)
          Constructs a Job object.
Job(AS400 system, byte[] internalJobID)
          Constructs a Job object.
Job(AS400 system, String internalJobID)
          Deprecated. Use Job(AS400,byte[]) instead. The internal job ID should be treated as a byte array of 16 bytes.
Job(AS400 system, String jobName, String userName, String jobNumber)
          Constructs a Job object.
 
Method Summary
 void addPropertyChangeListener(PropertyChangeListener listener)
          Adds a PropertyChangeListener.
 void addVetoableChangeListener(VetoableChangeListener listener)
          Adds a VetoableChangeListener.
 void commitChanges()
          Commits all uncommitted attribute changes.
 void commitChanges(boolean callOnThread)
          Commits all uncommitted attribute changes.
 void end(int delay)
          Ends this job.
 int getAuxiliaryIORequests()
          Returns the number of auxiliary I/O requests performed by the job across all routing steps.
 String getBreakMessageHandling()
          Returns a value which represents how this job handles break messages.
 boolean getCacheChanges()
          Indicates if the attribute value changes are cached.
 CallStackEntry[] getCallStack(long threadID)
          Returns the call stack for the specified thread in this job.
 int getCodedCharacterSetID()
          Returns the coded character set identifier (CCSID) used for this job.
 String getCompletionStatus()
          Returns the completion status of the job.
 String getCountryID()
          Returns the country or region identifier associated with this job.
 int getCPUUsed()
          Returns the amount of processing unit time (in milliseconds) that the job used.
 String getCurrentLibrary()
          Returns the name of the current library for the initial thread of the job.
 boolean getCurrentLibraryExistence()
          Indicates if a current library exists.
 Date getDate()
          Returns the date and time when the job was placed on the system.
 String getDateFormat()
          Returns the format in which dates are presented.
 String getDateSeparator()
          Returns the value used to separate days, months, and years when presenting a date.
 String getDDMConversationHandling()
          Returns whether connections using distributed data management (DDM) protocols remain active when they are not being used.
 String getDecimalFormat()
          Returns the decimal format used for this job.
 int getDefaultCodedCharacterSetIdentifier()
          Returns the default coded character set identifier (CCSID) used for this job.
 int getDefaultWait()
          Returns the default maximum time (in seconds) that a thread in the job waits for a system instruction, such as a LOCK machine interface (MI) instruction, to acquire a resource.
 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.
 String getFunctionName()
          Returns additional information (as described by the FUNCTION_TYPE attribute) about the last high-level function initiated by the initial thread.
 String getFunctionType()
          Returns the last high-level function initiated by the initial thread.
 String getInquiryMessageReply()
          Returns how the job answers inquiry messages.
 int getInteractiveTransactions()
          Returns the count of operator interactions, such as pressing the Enter key or a function key.
 String getInternalJobID()
          Deprecated. Use getInternalJobIdentifier() instead. The internal job identifier should be treated as a byte array of 16 bytes.
 byte[] getInternalJobIdentifier()
          Returns the internal job identifier.
 String getJobAccountingCode()
          Returns an identifier assigned to the job by the system to collect resource use information for the job when job accounting is active.
 Date getJobActiveDate()
          Returns the date and time when the job began to run on the system.
 Date getJobDate()
          Returns the date to be used for the job.
 String getJobDescription()
          Returns the fully qualified integrated file system path name for the job description.
 Date getJobEndedDate()
          Returns the date and time when the job completed running on the system.
 Date getJobEnterSystemDate()
          Returns the date and time when the job was placed on the system.
 JobLog getJobLog()
          Returns the job log.
 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.
 Date getJobPutOnJobQueueDate()
          Returns the date and time this job was put on this job queue.
 String getJobStatusInJobQueue()
          Returns the status of this job on the job queue.
 String getJobSwitches()
          Returns the current setting of the job switches used by this job.
 String getLanguageID()
          Returns the language identifier associated with this job.
 String getLoggingCLPrograms()
          Returns a value indicating whether or not commands are logged for CL programs that are run.
 int getLoggingLevel()
          Returns what type of information is logged.
 int getLoggingSeverity()
          Returns the severity level that is used in conjunction with the logging level to determine which error messages are logged in the job log.
 String getLoggingText()
          Returns the level of message text that is written in the job log when a message is logged according to the LOGGING_LEVEL and LOGGING_SEVERITY.
 String getModeName()
          Returns the mode name of the advanced program-to-program communications (APPC) device that started the job.
 String getName()
          Returns the job name.
 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 of the job.
 int getNumberOfLibrariesInUSRLIBL()
          Returns the number of libraries in the user portion of the library list for the initial thread of the job.
 int getNumberOfProductLibraries()
          Returns the number of libraries that contain product information for the initial thread of the job.
 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 output files that this job produces.
 int getPoolIdentifier()
          Returns the identifier of the system-related pool from which the job's main storage is allocated.
 String getPrinterDeviceName()
          Returns the printer device used for printing output from this job.
 String getPrintKeyFormat()
          Returns a value indicating whether border and header information is provided when the Print key is pressed.
 String getPrintText()
          Returns the line of text (if any) that is printed at the bottom of each page of printed output for the job.
 String[] getProductLibraries()
          Returns the libraries that contain product information for the initial thread of the job.
 boolean getPurge()
          Indicates whether or not the job is eligible to be moved out of main storage and put into auxiliary storage at the end of a time slice or when entering a long wait (such as waiting for a work station user's response).
 String getQueue()
          Returns the fully qualified integrated file system path name of the job queue that the job is currently on, or that the job was on if it is currently active.
 int getQueuePriority()
          Returns the scheduling priority of the job compared to other jobs on the same job queue.
 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.
 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.
 String getSortSequenceTable()
          Returns the name of the sort sequence table associated with this job.
 String getStatus()
          Returns the status of this job.
 String getStatusMessageHandling()
          Returns whether status messages are displayed for this job.
 String getStringValue(int attribute)
          Returns the value for the specified job attribute, as a String.
 String getSubsystem()
          Returns the fully qualified integrated file system path name of the subsystem description for the subsystem in which the job is running.
 String getSubtype()
          Returns additional information about the job type (if any exists).
 AS400 getSystem()
          Returns the system.
 String[] getSystemLibraryList()
          Returns the system portion of the library list of the initial thread of the job.
 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.
 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 for the initial thread, in milliseconds.
 String getType()
          Returns the type of job.
 String getUser()
          Returns the user name.
 String[] getUserLibraryList()
          Returns the user portion of the library list for the initial thread of the job.
 Object getValue(int attribute)
          Returns the value for the specified job attribute.
 String getWorkIDUnit()
          Returns the unit of work identifier.
 void hold(boolean holdSpooledFiles)
          Holds this job.
 void loadInformation()
          Refreshes the values for all attributes.
 void loadInformation(int[] attributes)
          Refreshes the values for specific attributes.
 void loadStatistics()
          Refreshes just the values for the elapsed statistics.
 void release()
          Releases this job.
 void removePropertyChangeListener(PropertyChangeListener listener)
          Removes a PropertyChangeListener.
 void removeVetoableChangeListener(VetoableChangeListener listener)
          Removes a VetoableChangeListener.
 void resetStatistics()
          Resets the measurement start time used for computing elapsed statistics.
 void setBreakMessageHandling(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) used for this job.
 void setCountryID(String countryID)
          Sets the country or region identifier associated with this job.
 void setDateFormat(String dateFormat)
          Sets the format in which dates are presented.
 void setDateSeparator(String dateSeparator)
          Sets the value used to separate days, months, and years when presenting a date.
 void setDDMConversationHandling(String ddmConversationHandling)
          Sets whether connections using distributed data management (DDM) protocols remain active when they are not being used.
 void setDecimalFormat(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, such as a LOCK machine interface (MI) instruction, to acquire a resource.
 void setDeviceRecoveryAction(String deviceRecoveryAction)
          Sets the action taken for interactive jobs when an I/O error occurs for the job's requesting program device.
 void setInquiryMessageReply(String inquiryMessageReply)
          Sets how the job answers inquiry messages.
 void setInternalJobID(String internalJobID)
          Deprecated. Use setInternalJobIdentifier(byte[]) instead. The internal job identifier should be treated as a byte array of 16 bytes.
 void setInternalJobIdentifier(byte[] internalJobID)
          Sets the internal job identifier.
 void setJobAccountingCode(String jobAccountingCode)
          Sets an identifier assigned to the job by the system to collect resource use information for the job when job accounting is active.
 void setJobDate(Date jobDate)
          Sets the date that is assigned to the job.
 void setJobMessageQueueFullAction(String jobMessageQueueFullAction)
          Sets the action to take when the message queue is full.
 void setJobSwitches(String jobSwitches)
          Sets the current setting of the job switches that are used by this job.
 void setLanguageID(String languageID)
          Sets the language identifier associated with this job.
 void setLoggingCLPrograms(String loggingCLPrograms)
          Sets whether or not commands are logged for CL programs that are run.
 void setLoggingLevel(int loggingLevel)
          Sets what type of information is logged.
 void setLoggingSeverity(int loggingSeverity)
          Sets the severity level that is used in conjunction with the logging level to determine which error messages are logged in the job log.
 void setLoggingText(String loggingText)
          Sets the level of message text that is written in the job log when a message is logged according to the LOGGING_LEVEL and LOGGING_SEVERITY.
 void setName(String name)
          Sets the job name.
 void setNumber(String number)
          Sets the job number.
 void setOutputQueue(String outputQueue)
          Sets the fully qualified integrated file system path 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(String printerDeviceName)
          Sets the printer device used for printing output from this job.
 void setPrintKeyFormat(String printKeyFormat)
          Sets whether border and header information is provided when the Print key is pressed.
 void setPrintText(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 or not the job is eligible to be moved out of main storage and put into auxiliary storage at the end of a time slice or when entering a long wait (such as waiting for a work station user's response).
 void setQueue(String jobQueue)
          Sets the fully qualified integrated file system path name of the job queue that the job is to be 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 competes for the processing unit relative to the other jobs that are active at the same time.
 void setScheduleDate(Date scheduleDate)
          Sets the date and time the job is scheduled to become active.
 void setScheduleDate(String scheduleDate)
          Sets the date the job is scheduled to become active.
 void setScheduleTime(Date scheduleTime)
          Sets the date and time the job is scheduled to become active.
 void setScheduleTime(String scheduleTime)
          Sets the time the job is scheduled to become active.
 void setSortSequenceTable(String sortSequenceTable)
          Sets the name of the sort sequence table associated with this job..
 void setStatusMessageHandling(String statusMessageHandling)
          Sets the value which indicates whether status messages are displayed for this job.
 void setSystem(AS400 system)
          Sets the system.
 void setTimeSeparator(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(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(String user)
          Sets the user name.
 void setValue(int attribute, Object value)
          Sets a value for a job attribute.
 String toString()
          Returns the string representation of this Job in the format "number/user/name", or "" if any of these attributes is null.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ACCOUNTING_CODE

public static final int ACCOUNTING_CODE
Job attribute representing an identifier assigned to the job by the system to collect resource use information for the job when job accounting is active. The user who is changing this field must have authority to the CHGACGCDE CL command. If the user does not have the proper authority, this field is ignored and processing continues. Possible values are:

Type: String

See Also:
getJobAccountingCode(), setJobAccountingCode(java.lang.String), Constant Field Values

ACCOUNTING_CODE_BLANK

public static final String ACCOUNTING_CODE_BLANK
Constant indicating the accounting code is changed to all blanks.

See Also:
ACCOUNTING_CODE, Constant Field Values

ACTIVE_JOB_STATUS

public static final int ACTIVE_JOB_STATUS
Job attribute representing the active status of the initial thread of a job. Only one status is returned. Possible values are:

Read-only: true

Type: String

See Also:
Constant Field Values

ACTIVE_JOB_STATUS_NONE

public static final String ACTIVE_JOB_STATUS_NONE
Constant indicating that a job is in transition or is not active.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_BIN_SYNCH_DEVICE_AND_ACTIVE

public static final String ACTIVE_JOB_STATUS_WAIT_BIN_SYNCH_DEVICE_AND_ACTIVE
Constant indicating that a job is waiting in a pool activity level for the completion of an I/O operation to a binary synchronous device.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_BIN_SYNCH_DEVICE

public static final String ACTIVE_JOB_STATUS_WAIT_BIN_SYNCH_DEVICE
Constant indicating that a job is waiting for the completion of an I/O operation to a binary synchronous device.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_COMM_DEVICE_AND_ACTIVE

public static final String ACTIVE_JOB_STATUS_WAIT_COMM_DEVICE_AND_ACTIVE
Constant indicating that a job is waiting in a pool activity level for the completion of an I/O operation to a communications device.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_COMM_DEVICE

public static final String ACTIVE_JOB_STATUS_WAIT_COMM_DEVICE
Constant indicating that a job is waiting for the completion of an I/O operation to a communications device.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_CHECKPOINT

public static final String ACTIVE_JOB_STATUS_WAIT_CHECKPOINT
Constant indicating that a job is waiting for the completion of save-while-active checkpoint processing in another job.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_CONDITION

public static final String ACTIVE_JOB_STATUS_WAIT_CONDITION
Constant indicating that a job is waiting on a handle-based condition.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_CPI_COMM

public static final String ACTIVE_JOB_STATUS_WAIT_CPI_COMM
Constant indicating that a job is waiting for the completion of a CPI communications call.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_DEQUEUE_AND_ACTIVE

public static final String ACTIVE_JOB_STATUS_WAIT_DEQUEUE_AND_ACTIVE
Constant indicating that a job is waiting in the pool activity level for completion of a dequeue operation.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_DEQUEUE

public static final String ACTIVE_JOB_STATUS_WAIT_DEQUEUE
Constant indicating that a job is waiting for completion of a dequeue operation. For example, QSYSARB and subsystem monitors generally wait for work by waiting for a dequeue operation.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_DISKETTE_AND_ACTIVE

public static final String ACTIVE_JOB_STATUS_WAIT_DISKETTE_AND_ACTIVE
Constant indicating that a job is waiting in a pool activity level for the completion of an I/O operation to a diskette unit.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_DISKETTE

public static final String ACTIVE_JOB_STATUS_WAIT_DISKETTE
Constant indicating that a job is waiting for the completion of an I/O operation to a diskette unit.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_DELAYED

public static final String ACTIVE_JOB_STATUS_WAIT_DELAYED
Constant indicating that a job is waiting for a specified time interval to end, or for a specific delay end time, as specified on the Delay Job (DLYJOB) command. The FUNCTION_NAME attribute shows either the number of seconds the job is to delay (999999), or the specific time when the job is to resume running.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_DELAY

public static final String ACTIVE_JOB_STATUS_WAIT_DELAY
Constant indicating that a job is waiting for a specified time interval to end, or for a specific delay end time, as specified on the Delay Job (DLYJOB) command. The FUNCTION_NAME attribute shows either the number of seconds the job is to delay (999999), or the specific time when the job is to resume running.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_DISCONNECTED

public static final String ACTIVE_JOB_STATUS_DISCONNECTED
Constant indicating that a job was disconnected from a work station display.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_DISPLAY_AND_ACTIVE

public static final String ACTIVE_JOB_STATUS_WAIT_DISPLAY_AND_ACTIVE
Constant indicating that a job is waiting in a pool activity level for input from a work station display.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_DISPLAY

public static final String ACTIVE_JOB_STATUS_WAIT_DISPLAY
Constant indicating that a job is waiting for input from a work station display.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_ENDED

public static final String ACTIVE_JOB_STATUS_ENDED
Constant indicating that a job has been ended with the *IMMED option, or its delay time has ended with the *CNTRLD option.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_DATABASE_EOF_AND_ACTIVE

public static final String ACTIVE_JOB_STATUS_WAIT_DATABASE_EOF_AND_ACTIVE
Constant indicating that a job is waiting in a pool activity level to try a read operation again on a database file after the end-of-file (EOF) has been reached.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_DATABASE_EOF

public static final String ACTIVE_JOB_STATUS_WAIT_DATABASE_EOF
Constant indicating that a job is waiting to try a read operation again on a database file after the end-of-file (EOF) has been reached.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_ENDING

public static final String ACTIVE_JOB_STATUS_ENDING
Constant indicating that a job is ending for a reason other than running the End Job (ENDJOB) or End Subsystem (ENDSBS) commands, such as a SIGNOFF command, an End Group Job (ENDGRPJOB) command, or an exception that is not handled.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_EVENT

public static final String ACTIVE_JOB_STATUS_WAIT_EVENT
Constant indicating that a job is waiting for an event. For example, QLUS and SCPF generally wait for work by waiting for an event.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_SUSPENDED

public static final String ACTIVE_JOB_STATUS_SUSPENDED
Constant indicating that a job is suspended by a Transfer Group Job (TFRGRPJOB) command.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_HELD

public static final String ACTIVE_JOB_STATUS_HELD
Constant indicating that a job is held.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_HELD_THREAD

public static final String ACTIVE_JOB_STATUS_HELD_THREAD
Constant indicating that a job is held due to a suspended thread.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_ICF_FILE_AND_ACTIVE

public static final String ACTIVE_JOB_STATUS_WAIT_ICF_FILE_AND_ACTIVE
Constant indicating that a job is waiting in a pool activity level for the completion of an I/O operation to an intersystem communications function (ICF) file.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_ICF_FILE

public static final String ACTIVE_JOB_STATUS_WAIT_ICF_FILE
Constant indicating that a job is waiting for the completion of an I/O operation to an intersystem communications function (ICF) file.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_INELIGIBLE

public static final String ACTIVE_JOB_STATUS_INELIGIBLE
Constant indicating that a job is ineligible and not currently in a pool activity level.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_JAVA_AND_ACTIVE

public static final String ACTIVE_JOB_STATUS_WAIT_JAVA_AND_ACTIVE
Constant indicating that a job is waiting in a pool activity level for a Java program operation to complete.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_JAVA

public static final String ACTIVE_JOB_STATUS_WAIT_JAVA
Constant indicating that a job is waiting for a Java program operation to complete.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_LOCK

public static final String ACTIVE_JOB_STATUS_WAIT_LOCK
Constant indicating that a job is waiting for a lock.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_LOCK_SPACE_AND_ACTIVE

public static final String ACTIVE_JOB_STATUS_WAIT_LOCK_SPACE_AND_ACTIVE
Constant indicating that a job is waiting in a pool activity level for for a lock space to be attached.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_LOCK_SPACE

public static final String ACTIVE_JOB_STATUS_WAIT_LOCK_SPACE
Constant indicating that a job is waiting for a lock space to be attached.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_MULTIPLE_FILES_AND_ACTIVE

public static final String ACTIVE_JOB_STATUS_WAIT_MULTIPLE_FILES_AND_ACTIVE
Constant indicating that a job is waiting in a pool activity level for the completion of an I/O operation to multiple files.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_MULTIPLE_FILES

public static final String ACTIVE_JOB_STATUS_WAIT_MULTIPLE_FILES
Constant indicating that a job is waiting for the completion of an I/O operation to multiple files.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_MESSAGE

public static final String ACTIVE_JOB_STATUS_WAIT_MESSAGE
Constant indicating that a job is waiting for a message from a message queue.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_MUTEX

public static final String ACTIVE_JOB_STATUS_WAIT_MUTEX
Constant indicating that a job is waiting for a mutex. A mutex is a synchronization function that is used to allow multiple jobs or threads to serialize their access to shared data.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_MIXED_DEVICE_FILE

public static final String ACTIVE_JOB_STATUS_WAIT_MIXED_DEVICE_FILE
Constant indicating that a job is waiting for the completion of an I/O operation to a mixed device file.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_OPTICAL_DEVICE_AND_ACTIVE

public static final String ACTIVE_JOB_STATUS_WAIT_OPTICAL_DEVICE_AND_ACTIVE
Constant indicating that a job is waiting in a pool activity level for the completion of an I/O operation to an optical device.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_OPTICAL_DEVICE

public static final String ACTIVE_JOB_STATUS_WAIT_OPTICAL_DEVICE
Constant indicating that a job is waiting for the completion of an I/O operation to an optical device.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_OSI

public static final String ACTIVE_JOB_STATUS_WAIT_OSI
Constant indicating that a job is waiting for the completion of an OSI Communications Subsystem operation.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_PRINT_AND_ACTIVE

public static final String ACTIVE_JOB_STATUS_WAIT_PRINT_AND_ACTIVE
Constant indicating that a job is waiting in a pool activity level for output to a printer to complete.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_PRINT

public static final String ACTIVE_JOB_STATUS_WAIT_PRINT
Constant indicating that a job is waiting for output to a printer to complete.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_PRESTART

public static final String ACTIVE_JOB_STATUS_WAIT_PRESTART
Constant indicating that a prestart job is waiting for a program start request.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_RUNNING

public static final String ACTIVE_JOB_STATUS_RUNNING
Constant indicating that a job is currently running in a pool activity level.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_SELECTION

public static final String ACTIVE_JOB_STATUS_WAIT_SELECTION
Constant indicating that a job is waiting for a selection to complete.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_SEMAPHORE

public static final String ACTIVE_JOB_STATUS_WAIT_SEMAPHORE
Constant indicating that a job is waiting for a semaphore. A semaphore is a synchronization function that is used to allow multiple jobs or threads to serialize their access to shared data.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_STOPPED

public static final String ACTIVE_JOB_STATUS_STOPPED
Constant indicating that a job has stopped as the result of a signal.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_SIGNAL

public static final String ACTIVE_JOB_STATUS_WAIT_SIGNAL
Constant indicating that a job is waiting for a signal.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_SUSPENDED_SYSTEM_REQUEST

public static final String ACTIVE_JOB_STATUS_SUSPENDED_SYSTEM_REQUEST
Constant indicating that a job is the suspended half of a system request job pair.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_SAVE_FILE_AND_ACTIVE

public static final String ACTIVE_JOB_STATUS_WAIT_SAVE_FILE_AND_ACTIVE
Constant indicating that a job is waiting in a pool activity level for the completion of a save file operation.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_SAVE_FILE

public static final String ACTIVE_JOB_STATUS_WAIT_SAVE_FILE
Constant indicating that a job is waiting for the completion of a save file operation.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_TAPE_DEVICE_AND_ACTIVE

public static final String ACTIVE_JOB_STATUS_WAIT_TAPE_DEVICE_AND_ACTIVE
Constant indicating that a job is waiting in a pool activity level for the completion of an I/O operation to a tape device.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_TAPE_DEVICE

public static final String ACTIVE_JOB_STATUS_WAIT_TAPE_DEVICE
Constant indicating that a job is waiting for the completion of an I/O operation to a tape device.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_THREAD

public static final String ACTIVE_JOB_STATUS_WAIT_THREAD
Constant indicating that a job is waiting for another thread to complete an operation.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_TIME_INTERVAL_AND_ACTIVE

public static final String ACTIVE_JOB_STATUS_WAIT_TIME_INTERVAL_AND_ACTIVE
Constant indicating that a job is waiting in a pool activity level for a time interval to end.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_WAIT_TIME_INTERVAL

public static final String ACTIVE_JOB_STATUS_WAIT_TIME_INTERVAL
Constant indicating that a job is waiting for a time interval to end.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ACTIVE_JOB_STATUS_FOR_JOBS_ENDING

public static final int ACTIVE_JOB_STATUS_FOR_JOBS_ENDING
Job attribute representing the status of what the initial thread of a job is currently doing, when the active job status is ACTIVE_JOB_STATUS_ENDED or ACTIVE_JOB_STATUS_ENDING. This field is blank if the job is not ending currently. See ACTIVE_JOB_STATUS for a list of the possible values. For example, the active job status would be ACTIVE_JOB_STATUS_ENDING, but the job could be waiting on a lock that could keep the job from ending. This field would then be ACTIVE_JOB_STATUS_WAIT_LOCK.

Read-only: true

Type: String

Only valid on V5R1 systems and higher.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ALLOW_MULTIPLE_THREADS

public static final int ALLOW_MULTIPLE_THREADS
Job attribute representing whether a job allows multiple user threads. This attribute does not prevent the operating system from creating system threads in the job. Possible values are:

Read-only: true

Type: String

Only valid on V5R1 systems and higher.

See Also:
Constant Field Values

ALLOW_MULTIPLE_THREADS_NO

public static final String ALLOW_MULTIPLE_THREADS_NO
Constant indicating that a job does not allow multiple user threads.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

ALLOW_MULTIPLE_THREADS_YES

public static final String ALLOW_MULTIPLE_THREADS_YES
Constant indicating that a job allows multiple user threads.

See Also:
ACTIVE_JOB_STATUS, Constant Field Values

AUXILIARY_IO_REQUESTS

public static final int AUXILIARY_IO_REQUESTS
Job attribute representing the number of auxiliary I/O requests performed by the job across all routing steps. This includes both database and nondatabase paging. If the number of auxiliary I/O requests is greater than or equal to 2,147,483,647, a value of -1 is returned. Use the AUXILIARY_IO_REQUESTS_LARGE attribute to retrieve values that are greater than or equal to 2,147,483,647.

Read-only: true

Type: Integer

See Also:
getAuxiliaryIORequests(), Constant Field Values

AUXILIARY_IO_REQUESTS_LARGE

public static final int AUXILIARY_IO_REQUESTS_LARGE
Job attribute representing the number of auxiliary I/O requests performed by the job across all routing steps. This includes both database and nondatabase paging.

Read-only: true

Type: Long

Only valid on V5R1 systems and higher.

See Also:
getAuxiliaryIORequests(), Constant Field Values

BREAK_MESSAGE_HANDLING

public static final int BREAK_MESSAGE_HANDLING
Job attribute representing how a job handles break messages. Possible values are:

Type: String

See Also:
getBreakMessageHandling(), setBreakMessageHandling(java.lang.String), Constant Field Values

BREAK_MESSAGE_HANDLING_NORMAL

public static final String BREAK_MESSAGE_HANDLING_NORMAL
Constant indicating that the message queue status determines break message handling.

See Also:
BREAK_MESSAGE_HANDLING, Constant Field Values

BREAK_MESSAGE_HANDLING_HOLD

public static final String BREAK_MESSAGE_HANDLING_HOLD
Constant indicating that the message queue holds break messages until a user or program requests them. The work station user uses the Display Message (DPSMSG) command to display the messages; a program must issue a Receive Message (RCVMSG) command to receive a message and handle it.

See Also:
BREAK_MESSAGE_HANDLING, Constant Field Values

BREAK_MESSAGE_HANDLING_NOTIFY

public static final String BREAK_MESSAGE_HANDLING_NOTIFY
Constant indicating that the system notifies the job's message queue when a message arrives. For interactive jobs, the audible alarm sounds if there is one, and the message-waiting light comes on.

See Also:
BREAK_MESSAGE_HANDLING, Constant Field Values

CCSID

public static final int CCSID
Job attribute representing the coded character set identifier used for this job. Possible values are:

Type: Integer

See Also:
getCodedCharacterSetID(), setCodedCharacterSetID(int), Constant Field Values

CCSID_SYSTEM_VALUE

public static final int CCSID_SYSTEM_VALUE
Constant indicating that the CCSID specified in the system value QCCSID is used.

See Also:
CCSID, Constant Field Values

CCSID_INITIAL_USER

public static final int CCSID_INITIAL_USER
Constant indicating that the CCSID specified in the user profile under which this thread was initially running is used.

See Also:
CCSID, Constant Field Values

CHARACTER_ID_CONTROL

public static final int CHARACTER_ID_CONTROL
Job attribute representing the character identifier control for a job. This attribute controls the type of CCSID conversion that occurs for display files, printer files, and panel groups. The *CHRIDCTL special value must be specified on the CHRID command parameter on the create, change, or override command for display files, printer files, and panel groups before this attribute will be used. Possible values are:

Type: String

See Also:
Constant Field Values

CHARACTER_ID_CONTROL_DEVICE

public static final String CHARACTER_ID_CONTROL_DEVICE
Constant indicating to perform the same function for *DEVD as on the CHRID command parameter for display files, printer files, and panel groups.

See Also:
CHARACTER_ID_CONTROL, Constant Field Values

CHARACTER_ID_CONTROL_JOB

public static final String CHARACTER_ID_CONTROL_JOB
Constant indicating to perform the same function for *JOBCCSID as on the CHRID command parameter for display files, printer files, and panel groups.

See Also:
CHARACTER_ID_CONTROL, Constant Field Values

CHARACTER_ID_CONTROL_SYSTEM_VALUE

public static final String CHARACTER_ID_CONTROL_SYSTEM_VALUE
Constant indicating the value in the QCHRIDCTL system value will be used.

See Also:
CHARACTER_ID_CONTROL, Constant Field Values

CHARACTER_ID_CONTROL_INITIAL_USER

public static final String CHARACTER_ID_CONTROL_INITIAL_USER
Constant indicating the CHRIDCTL specified in the user profile under which this thread was initially running will be used.

See Also:
CHARACTER_ID_CONTROL, Constant Field Values

CLIENT_IP_ADDRESS

public static final int CLIENT_IP_ADDRESS
Job attribute representing the IPv4 address of the client for which this system is doing work. An address is expressed in standard IPv4 dotted-decimal form www.xxx.yyy.zzz (for example, 130.99.128.1). This field is not guaranteed to be an IP address. This field will be blank if the address is not explicitly set to a value by the Change Job (QWTCHGJB) API.

Read-only: true

Type: String

See Also:
Constant Field Values

COMPLETION_STATUS

public static final int COMPLETION_STATUS
Job attribute representing the completion status for a job. Possible values are:

Read-only: true

Type: String

See Also:
getCompletionStatus(), Constant Field Values

COMPLETION_STATUS_NOT_COMPLETED

public static final String COMPLETION_STATUS_NOT_COMPLETED
Constant indicating that the job has not completed.

See Also:
COMPLETION_STATUS, Constant Field Values

COMPLETION_STATUS_COMPLETED_NORMALLY

public static final String COMPLETION_STATUS_COMPLETED_NORMALLY
Constant indicating that the job completed normally.

See Also:
COMPLETION_STATUS, Constant Field Values

COMPLETION_STATUS_COMPLETED_ABNORMALLY

public static final String COMPLETION_STATUS_COMPLETED_ABNORMALLY
Constant indicating that the job completed abnormally.

See Also:
COMPLETION_STATUS, Constant Field Values

CONTROLLED_END_REQUESTED

public static final int CONTROLLED_END_REQUESTED
Job attribute representing whether or not the system issued a controlled cancellation. Possible values are:

Read-only: true

Type: String

See Also:
Constant Field Values

END_STATUS_CANCELLED

public static final String END_STATUS_CANCELLED
Constant indicating that the system, the subsystem in which a job is running, or the job itself is cancelled.

See Also:
CONTROLLED_END_REQUESTED, Constant Field Values

END_STATUS_NOT_CANCELLED

public static final String END_STATUS_NOT_CANCELLED
Constant indicating that the system, the subsystem in which a job is running, or the job itself is not cancelled.

See Also:
CONTROLLED_END_REQUESTED, Constant Field Values

END_STATUS_JOB_NOT_RUNNING

public static final String END_STATUS_JOB_NOT_RUNNING
Constant indicating that the job is not running.

See Also:
CONTROLLED_END_REQUESTED, Constant Field Values

ELAPSED_CPU_PERCENT_USED

public static final int ELAPSED_CPU_PERCENT_USED
Job attribute representing the percentage of processing time used during the elapsed time. For multiple-processor systems, this is the average across processors.

Read-only: true

Type: Integer

See Also:
resetStatistics(), Constant Field Values

ELAPSED_CPU_PERCENT_USED_FOR_DATABASE

public static final int ELAPSED_CPU_PERCENT_USED_FOR_DATABASE
Job attribute representing the percentage of processing unit used for database processing during the elapsed time. For multiple-processor systems, this is the average across processors.

Read-only: true

Type: Integer

See Also:
resetStatistics(), Constant Field Values

ELAPSED_CPU_TIME_USED

public static final int ELAPSED_CPU_TIME_USED
Job attribute representing the amount of processing unit time (in milliseconds) used during the elapsed time.

Read-only: true

Type: Long

See Also:
resetStatistics(), Constant Field Values

ELAPSED_CPU_TIME_USED_FOR_DATABASE

public static final int ELAPSED_CPU_TIME_USED_FOR_DATABASE
Job attribute representing the amount of processing unit time (in milliseconds) used for database processing during the elapsed time.

Read-only: true

Type: Long

See Also:
resetStatistics(), Constant Field Values

ELAPSED_DISK_IO

public static final int ELAPSED_DISK_IO
Job attribute representing the number of disk I/O operations performed by the job during the elapsed time. This is the sum of the asynchronous and synchronous disk I/O.

Read-only: true

Type: Long

See Also:
resetStatistics(), Constant Field Values

ELAPSED_DISK_IO_ASYNCH

public static final int ELAPSED_DISK_IO_ASYNCH
Job attribute representing the number of asynchronous (physical) disk I/O operations performed by the job during the elapsed time. This is the sum of the asynchronous database and nondatabase reads and writes.

Read-only: true

Type: Long

See Also:
resetStatistics(), Constant Field Values

ELAPSED_DISK_IO_SYNCH

public static final int ELAPSED_DISK_IO_SYNCH
Job attribute representing the number of synchronous (physical) disk I/O operations performed by the job during the elapsed time. This is the sum of the synchronous database and nondatabase reads and writes.

Read-only: true

Type: Long

See Also:
resetStatistics(), Constant Field Values

ELAPSED_INTERACTIVE_RESPONSE_TIME

public static final int ELAPSED_INTERACTIVE_RESPONSE_TIME
Job attribute representing the total interactive response time for the initial thread (in hundredths of seconds) for the job during the elapsed time. This does not include the time used by the machine, by the attached input/output (I/O) hardware, and by the transmission lines for sending and receiving data. This field is 0 for noninteractive jobs.

Read-only: true

Type: Integer

See Also:
resetStatistics(), Constant Field Values

ELAPSED_INTERACTIVE_TRANSACTIONS

public static final int ELAPSED_INTERACTIVE_TRANSACTIONS
Job attribute representing the number of user interactions, such as pressing the Enter key or a function key, for the job during the elapsed time for the initial thread. This field is 0 for noninteractive jobs.

Read-only: true

Type: Integer

See Also:
resetStatistics(), Constant Field Values

ELAPSED_LOCK_WAIT_TIME

public static final int ELAPSED_LOCK_WAIT_TIME
Job attribute representing the amount of time (in milliseconds) that the initial thread has to wait to obtain database, nondatabase, and internal machine locks during the elapsed time.

Read-only: true

Type: Long

Can be loaded by JobList: false

See Also:
resetStatistics(), Constant Field Values

ELAPSED_PAGE_FAULTS

public static final int ELAPSED_PAGE_FAULTS
Job attribute representing the number of times an active program referenced an address that is not in main storage for the current routing step during the elapsed time.

Read-only: true

Type: Long

See Also:
resetStatistics(), Constant Field Values

ELAPSED_TIME

public static final int ELAPSED_TIME
Job attribute representing the time (in milliseconds) that has elapsed between the measurement start time and the current system time. The measurement start time is reset when the resetStatistics() method is called.

Read-only: true

Type: Long

Can be loaded by JobList: false

See Also:
resetStatistics(), Constant Field Values

COUNTRY_ID

public static final int COUNTRY_ID
Job attribute representing the country or region identifier associated with this job. Possible values are:

Type: String

See Also:
getCountryID(), setCountryID(java.lang.String), Constant Field Values

COUNTRY_ID_SYSTEM_VALUE

public static final String COUNTRY_ID_SYSTEM_VALUE
Constant indicating the system value QCNTRYID is used.

See Also:
COUNTRY_ID, Constant Field Values

COUNTRY_ID_INITIAL_USER

public static final String COUNTRY_ID_INITIAL_USER
Constant indicating the country or region ID specified in the user profile under which this thread was initially running is used.

See Also:
COUNTRY_ID, Constant Field Values

CPU_TIME_USED

public static final int CPU_TIME_USED
Job attribute representing the amount of processing unit time (in milliseconds) that the job used. If the processing unit time used is greater than or equal to 2,147,483,647 milliseconds, a value of -1 is returned. Use the CPU_TIME_USED_LARGE attribute to retrieve values that are greater than or equal to 2,147,483,647.

Read-only: true

Type: Integer

See Also:
getCPUUsed(), Constant Field Values

CPU_TIME_USED_LARGE

public static final int CPU_TIME_USED_LARGE
Job attribute representing the amount of processing unit time (in milliseconds) that the job used across all routing steps.

Read-only: true

Type: Long

See Also:
getCPUUsed(), Constant Field Values

CPU_TIME_USED_FOR_DATABASE

public static final int CPU_TIME_USED_FOR_DATABASE
Job attribute representing the amount of processing unit time (in milliseconds) that the job used for processing data base requests across all routing steps.

Read-only: true

Type: Long

Only valid on V5R1 systems and higher.

See Also:
Constant Field Values

CURRENT_LIBRARY

public static final int CURRENT_LIBRARY
Job attribute representing the name of the current library for the initial thread of the job. If no current library exists, the CURRENT_LIBRARY_EXISTENCE attribute returns 0 and this attribute returns an empty string ("").

Read-only: true

Type: String

Can be loaded by JobList: false

See Also:
getCurrentLibrary(), Constant Field Values

CURRENT_LIBRARY_EXISTENCE

public static final int CURRENT_LIBRARY_EXISTENCE
Job attribute representing whether or not a current library exists for the job. Returns 0 if no current library exists; 1 if a current library exists.

Read-only: true

Type: Integer

Can be loaded by JobList: false

See Also:
getCurrentLibraryExistence(), Constant Field Values

CURRENT_SYSTEM_POOL_ID

public static final int CURRENT_SYSTEM_POOL_ID
Job attribute representing the identifier of the system-related pool from which main storage is currently being allocated for the job's initial thread. These identifiers are not the same as those specified in the subsystem description, but are the same as the system pool identifiers shown on the system status display. If a thread reaches its time-slice end, the pool the thread is running in can be swiched based on the job's time-slice end pool value. The current system pool identifier returned will be the actual pool in which the initial thread of the job is running.

Read-only: true

Type: Integer

See Also:
Constant Field Values

CURRENT_USER

public static final int CURRENT_USER
Job attribute representing the user profile that the initial thread of the job for which information is being retrieved is currently running under. This name may differ from the user portion of the job name.

Read-only: true

Type: String

See Also:
Constant Field Values

DATE_ENDED

public static final int DATE_ENDED
Job attribute representing the date and time when the job completed running on the system.

Read-only: true

Type: String in the format CYYMMDDHHMMSS

See Also:
Constant Field Values

DATE_ENTERED_SYSTEM

public static final int DATE_ENTERED_SYSTEM
Job attribute representing the date and time when the job was placed on the system.

Read-only: true

Type: String in the format CYYMMDDHHMMSS

See Also:
getDate(), getJobEnterSystemDate(), Constant Field Values

DATE_FORMAT

public static final int DATE_FORMAT
Job attribute representing the format in which dates are presented. Possible values are:

Type: String

See Also:
getDateFormat(), setDateFormat(java.lang.String), Constant Field Values

DATE_FORMAT_SYSTEM_VALUE

public static final String DATE_FORMAT_SYSTEM_VALUE
Constant indicating the system value QDATFMT is used.

See Also:
DATE_FORMAT, Constant Field Values

DATE_FORMAT_YMD

public static final String DATE_FORMAT_YMD
Constant indicating a date format of year, month, and day.

See Also:
DATE_FORMAT, Constant Field Values

DATE_FORMAT_MDY

public static final String DATE_FORMAT_MDY
Constant indicating a date format of month, day, and year.

See Also:
DATE_FORMAT, Constant Field Values

DATE_FORMAT_DMY

public static final String DATE_FORMAT_DMY
Constant indicating a date format of day, month, and year.

See Also:
DATE_FORMAT, Constant Field Values

DATE_FORMAT_JULIAN

public static final String DATE_FORMAT_JULIAN
Constant indicating a Julian date format (year and day).

See Also:
DATE_FORMAT, Constant Field Values

DATE_SEPARATOR

public static final int DATE_SEPARATOR
Job attribute representing the value used to separate days, months, and years when presenting a date. Possible values are:

Type: String

See Also:
getDateSeparator(), setDateSeparator(java.lang.String), Constant Field Values

DATE_SEPARATOR_SYSTEM_VALUE

public static final String DATE_SEPARATOR_SYSTEM_VALUE
Constant indicating the system value QDATSEP is used for the date separator.

See Also:
DATE_SEPARATOR, Constant Field Values

DATE_SEPARATOR_SLASH

public static final String DATE_SEPARATOR_SLASH
Constant indicating a slash (/) is used for the date separator.

See Also:
DATE_SEPARATOR, Constant Field Values

DATE_SEPARATOR_DASH

public static final String DATE_SEPARATOR_DASH
Constant indicating a dash (-) is used for the date separator.

See Also:
DATE_SEPARATOR, Constant Field Values

DATE_SEPARATOR_PERIOD

public static final String DATE_SEPARATOR_PERIOD
Constant indicating a period (.) is used for the date separator.

See Also:
DATE_SEPARATOR, Constant Field Values

DATE_SEPARATOR_BLANK

public static final String DATE_SEPARATOR_BLANK
Constant indicating a blank is used for the date separator.

See Also:
DATE_SEPARATOR, Constant Field Values

DATE_SEPARATOR_COMMA

public static final String DATE_SEPARATOR_COMMA
Constant indicating a comma (,) is used for the date separator.

See Also:
DATE_SEPARATOR, Constant Field Values

DATE_STARTED

public static final int DATE_STARTED
Job attribute representing the date and time when the job began to run on the system. This is blank if the job did not become active.

Read-only: true

Type: String in the format CYYMMDDHHMMSS

See Also:
getJobActiveDate(), Constant Field Values

DBCS_CAPABLE

public static final int DBCS_CAPABLE
Job attribute representing whether the job is DBCS-capable or not. Possible values are:

Read-only: true

Type: String

See Also:
Constant Field Values

DBCS_CAPABLE_NO

public static final String DBCS_CAPABLE_NO
Constant indicating that the job is not DBCS-capable.

See Also:
DBCS_CAPABLE, Constant Field Values

DBCS_CAPABLE_YES

public static final String DBCS_CAPABLE_YES
Constant indicating that the job is DBCS-capable.

See Also:
DBCS_CAPABLE, Constant Field Values

DECIMAL_FORMAT

public static final int DECIMAL_FORMAT
Job attribute representing the decimal format used for this job. Possible values are:

Type: String

See Also:
getDecimalFormat(), setDecimalFormat(java.lang.String), Constant Field Values

DECIMAL_FORMAT_SYSTEM_VALUE

public static final String DECIMAL_FORMAT_SYSTEM_VALUE
Constant indicating the value in the system value QDECFMT is used as the decimal format for this job.

See Also:
DECIMAL_FORMAT, Constant Field Values

DECIMAL_FORMAT_PERIOD

public static final String DECIMAL_FORMAT_PERIOD
Constant indicating a decimal format that 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.

See Also:
DECIMAL_FORMAT, Constant Field Values

DECIMAL_FORMAT_COMMA_J

public static final String DECIMAL_FORMAT_COMMA_J
Constant indicating a decimal format that uses a comma for a decimal point and a period for a 3-digit grouping character. The zero-suppression character is in the second position (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 (0,04). This constant also overrides any edit codes that might suppress the leading zero.

See Also:
DECIMAL_FORMAT, Constant Field Values

DECIMAL_FORMAT_COMMA_I

public static final String DECIMAL_FORMAT_COMMA_I
Constant indicating a decimal format that 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.

See Also:
DECIMAL_FORMAT, Constant Field Values

DEFAULT_CCSID

public static final int DEFAULT_CCSID
Job attribute representing the default coded character set identifier (CCSID) used for this job. This attribute returns zero if the job is not an active job.

Read-only: true

Type: Integer

See Also:
getDefaultCodedCharacterSetIdentifier(), Constant Field Values

DEFAULT_WAIT_TIME

public static final int DEFAULT_WAIT_TIME
Job attribute representing the default maximum time (in seconds) that a thread in the job waits for a system instruction, such as a LOCK machine interface (MI) instruction, to acquire a resource. This default wait time is used when a wait time is not otherwise specified for a given situation. Normally, this is the amount of time the user is willing to wait for the system before the request is ended. If the job consists of multiple routing steps, a change to this attribute during a routing step does not appy to subsequent routing steps. The valid range is 1 through 9999999. A value of -1 represents no maximum wait time (*NOMAX).

Type: Integer

See Also:
getDefaultWait(), setDefaultWait(int), Constant Field Values

DEVICE_RECOVERY_ACTION

public static final int DEVICE_RECOVERY_ACTION
Job attribute representing the action taken for interactive jobs when an I/O error occurs for the job's requesting program device. Possible values are:

Type: String

See Also:
getDeviceRecoveryAction(), setDeviceRecoveryAction(java.lang.String), Constant Field Values

DEVICE_RECOVERY_ACTION_SYSTEM_VALUE

public static final String DEVICE_RECOVERY_ACTION_SYSTEM_VALUE
Constant indicating the value in the system value QDEVRCYACN is used as the device recovery action for this job.

See Also:
DEVICE_RECOVERY_ACTION, Constant Field Values

DEVICE_RECOVERY_ACTION_MESSAGE

public static final String DEVICE_RECOVERY_ACTION_MESSAGE
Constant indicating a device recovery action that signals the I/O error message to the application and lets the application program perform error recovery.

See Also:
DEVICE_RECOVERY_ACTION, Constant Field Values

DEVICE_RECOVERY_ACTION_DISCONNECT_MESSAGE

public static final String DEVICE_RECOVERY_ACTION_DISCONNECT_MESSAGE
Constant indicating a device recovery action that disconnects the job when an I/O error occurs. When the job reconnects, the system sends an error message to the application program, indicating the job has reconnected and that the work station device has recovered.

See Also:
DEVICE_RECOVERY_ACTION, Constant Field Values

DEVICE_RECOVERY_ACTION_DISCONNECT_END_REQUEST

public static final String DEVICE_RECOVERY_ACTION_DISCONNECT_END_REQUEST
Constant indicating a device recovery action that 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.

See Also:
DEVICE_RECOVERY_ACTION, Constant Field Values

DEVICE_RECOVERY_ACTION_END_JOB

public static final String DEVICE_RECOVERY_ACTION_END_JOB
Constant indicating a device recovery action that 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.

See Also:
DEVICE_RECOVERY_ACTION, Constant Field Values

DEVICE_RECOVERY_ACTION_END_JOB_NO_LIST

public static final String DEVICE_RECOVERY_ACTION_END_JOB_NO_LIST
Constant indicating a device recovery action that 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.

See Also:
DEVICE_RECOVERY_ACTION, Constant Field Values

ELIGIBLE_FOR_PURGE

public static final int ELIGIBLE_FOR_PURGE
Job attribute representing whether or not the job is eligible to be moved out of main storage and put into auxiliary storage at the end of a time slice or when entering a long wait (such as waiting for a work station user's response). This attribute is ignored when more than one thread is active within the job. If the job consists of multiple routing steps, a change to this attribute during a routing step does not apply to subsequent routing steps. Possible values are:

Type: String

See Also:
getPurge(), setPurge(boolean), Constant Field Values

ELIGIBLE_FOR_PURGE_YES

public static final String ELIGIBLE_FOR_PURGE_YES
Constant indicating that the job is eligible to be moved out of main storage and put into auxiliary storage. A job with multiple threads, however, is never purged from main storage.

See Also:
ELIGIBLE_FOR_PURGE, Constant Field Values

ELIGIBLE_FOR_PURGE_NO

public static final String ELIGIBLE_FOR_PURGE_NO
Constant indicating that a job is not eligible to be moved out of main storage and put into auxiliary storage. When main storage is needed, however, pages belonging to a thread in the job may be moved to auxiliary storage. Then, when a thread in the job runs again, its pages are returned to main storage as they are needed.

See Also:
ELIGIBLE_FOR_PURGE, Constant Field Values

ELIGIBLE_FOR_PURGE_IGNORED

public static final String ELIGIBLE_FOR_PURGE_IGNORED
Constant indicating that whether a job is eligible for purge or not is ignored because the job type is either *JOBQ or *OUTQ, or the job is not valid.

See Also:
ELIGIBLE_FOR_PURGE, Constant Field Values

END_SEVERITY

public static final int END_SEVERITY
Job attribute representing 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.

Read-only: true

Type: Integer

See Also:
getEndSeverity(), Constant Field Values

FUNCTION_NAME

public static final int FUNCTION_NAME
Job attribute representing additional information (as described by the FUNCTION_TYPE attribute) about the last high-level function initiated by the initial thread.

Read-only: true

Type: String

See Also:
getFunctionName(), Constant Field Values

FUNCTION_TYPE

public static final int FUNCTION_TYPE
Job attribute representing the last high-level function initiated by the initial thread. This field may not be cleared when a function is completed. Possible values are:

Read-only: true

Type: String

See Also:
getFunctionType(), Constant Field Values

FUNCTION_TYPE_BLANK

public static final String FUNCTION_TYPE_BLANK
Constant indicating that the system is not performing a logged function.

See Also:
FUNCTION_TYPE, Constant Field Values

FUNCTION_TYPE_COMMAND

public static final String FUNCTION_TYPE_COMMAND
Constant indicating that a command is running interactively, or it is in a batch input stream, or it was requested from a system menu. Commands in CL programs or REXX procedures are not logged. The FUNCTION_NAME attribute contains the name of the command and is only updated when a command is processed.

See Also:
FUNCTION_TYPE, Constant Field Values

FUNCTION_TYPE_DELAY

public static final String FUNCTION_TYPE_DELAY
Constant indicating that the initial thread of the job is processing a Delay Job (DLYJOB) command. The FUNCTION_NAME attribute contains the number of seconds the job is delayed (up to 999999 seconds), or the time when the job is to resume processing (HH:MM:SS), depending on how you specified the command.

See Also:
FUNCTION_TYPE, Constant Field Values

FUNCTION_TYPE_GROUP

public static final String FUNCTION_TYPE_GROUP
Constant indicating that the Transfer Group Job (TFRGRPJOB) command suspended the job. The FUNCTION_NAME attribute contains the group job name for that job.

See Also:
FUNCTION_TYPE, Constant Field Values

FUNCTION_TYPE_INDEX

public static final String FUNCTION_TYPE_INDEX
Constant indicating that the initial thread of the job is rebuilding an index (access path). The FUNCTION_NAME attribute contains the name of the logical file whose index is rebuilt.

See Also:
FUNCTION_TYPE, Constant Field Values

FUNCTION_TYPE_JAVA

public static final String FUNCTION_TYPE_JAVA
Constant indicating that the initial thread of the job is running a Java Vertual Machine (JVM). The FUNCTION_NAME attribute contains the name of the java class.

See Also:
FUNCTION_TYPE, Constant Field Values

FUNCTION_TYPE_LOG

public static final String FUNCTION_TYPE_LOG
Constant indicating that the system logs history information in a database file. The FUNCTION_NAME attribute contains the name of the log (QHST is the only log currently supported).

See Also:
FUNCTION_TYPE, Constant Field Values

FUNCTION_TYPE_MRT

public static final String FUNCTION_TYPE_MRT
Constant indicating that the job is a multiple requester terminal (MRT) job if the JOB_TYPE is JOB_TYPE_BATCH and the JOB_SUBTYPE is JOB_SUBTYPE_MRT, or it is an interactive job attached to an MRT job if the JOB_TYPE is JOB_TYPE_INTERACTIVE.

For MRT jobs, the FUNCTION_NAME attribute contains information in the following format:

For interactive jobs attached to an MRT, the FUNCTION_NAME attribute contains the name of the MRT procedure.

See Also:
FUNCTION_TYPE, Constant Field Values

FUNCTION_TYPE_MENU

public static final String FUNCTION_TYPE_MENU
Constant indicating that the initial thread of the job is currently at a system menu. The FUNCTION_NAME field contains the name of the menu.

See Also:
FUNCTION_TYPE, Constant Field Values

FUNCTION_TYPE_IO

public static final String FUNCTION_TYPE_IO
Constant indicating that the job is a subsystem monitor that is performing input/output (I/O) operations to a work station. The FUNCTION_NAME attribute contains the name of the work station device to which the subsystem is performing an input/output operation.

See Also:
FUNCTION_TYPE, Constant Field Values

FUNCTION_TYPE_PROCEDURE

public static final String FUNCTION_TYPE_PROCEDURE
Constant indicating that the initial thread of the job is running a procedure. The FUNCTION_NAME attribute contains the name of the procedure.

See Also:
FUNCTION_TYPE, Constant Field Values

FUNCTION_TYPE_PROGRAM

public static final String FUNCTION_TYPE_PROGRAM
Constant indicating that the initial thread of the job is running a program. The FUNCTION_NAME attribute contains the name of the program.

See Also:
FUNCTION_TYPE, Constant Field Values

FUNCTION_TYPE_SPECIAL

public static final String FUNCTION_TYPE_SPECIAL
Constant indicating that the function type is a special function. For this value, the FUNCTION_NAME attribute contains one of the following values:

See Also:
FUNCTION_TYPE, Constant Field Values

INITIAL_THREAD

public static final long INITIAL_THREAD
Constant indicating that the initial thread of the job should be used when retrieving the call stack.

See Also:
getCallStack(long), Constant Field Values

INQUIRY_MESSAGE_REPLY

public static final int INQUIRY_MESSAGE_REPLY
Job attribute representing how the job answers inquiry messages. Possible values are:

Type: String

See Also:
getInquiryMessageReply(), setInquiryMessageReply(java.lang.String), Constant Field Values

INQUIRY_MESSAGE_REPLY_REQUIRED

public static final String INQUIRY_MESSAGE_REPLY_REQUIRED
Constant indicating that the job requires an answer for any inquiry messages that occur while this job is running.

See Also:
INQUIRY_MESSAGE_REPLY, Constant Field Values

INQUIRY_MESSAGE_REPLY_DEFAULT

public static final String INQUIRY_MESSAGE_REPLY_DEFAULT
Constant indicating that 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.

See Also:
INQUIRY_MESSAGE_REPLY, Constant Field Values

INQUIRY_MESSAGE_REPLY_SYSTEM_REPLY_LIST

public static final String INQUIRY_MESSAGE_REPLY_SYSTEM_REPLY_LIST
Constant indicating that 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.

See Also:
INQUIRY_MESSAGE_REPLY, Constant Field Values

INTERACTIVE_TRANSACTIONS

public static final int INTERACTIVE_TRANSACTIONS
Job attribute representing the count of operator interactions, such as pressing the Enter key or a function key. This field is zero for jobs that have no interactions.

Read-only: true

Type: Integer

See Also:
getInteractiveTransactions(), Constant Field Values

INTERNAL_JOB_ID

public static final int INTERNAL_JOB_ID
Deprecated. Use INTERNAL_JOB_IDENTIFIER instead. The internal job identifier should be treated as a byte array of 16 bytes.
Job attribute representing the value input to other APIs to increase the speed of locating the job on the system. The identifier is not valid following an initial program load (IPL). If you attempt to use it after an IPL, an exception occurs.

Read-only: true

Type: String

Can be loaded by JobList: false

See Also:
getInternalJobID(), Constant Field Values

INTERNAL_JOB_IDENTIFIER

public static final int INTERNAL_JOB_IDENTIFIER
Job attribute representing the value input to other APIs to increase the speed of locating the job on the system. The identifier is not valid following an initial program load (IPL). If you attempt to use it after an IPL, an exception occurs.

Read-only: true

Type: byte array

Can be loaded by JobList: false

See Also:
getInternalJobIdentifier(), Constant Field Values

JOB_DATE

public static final int JOB_DATE
Job attribute representing the date used for the job. This value is for jobs whose status is *JOBQ or *ACTIVE. For jobs with a status of *OUTQ, the value for this field is blank.

Type: String in the format CYYMMDD

See Also:
getJobDate(), setJobDate(java.util.Date), Constant Field Values

JOB_DESCRIPTION

public static final int JOB_DESCRIPTION
Job attribute representing a set of job-related attributes used for one or more jobs on the system. These attributes determine how the job is run on the system. Multiple jobs can also use the same job description.

Read-only: true

Type: String

See Also:
getJobDescription(), Constant Field Values

JOB_END_REASON

public static final int JOB_END_REASON
Job attribute representing the most recent action that caused the job to end. Possible values are:

Read-only: true

Type: Integer

Only valid on V5R1 systems and higher.

See Also:
Constant Field Values

JOB_LOG_OUTPUT

public static final int JOB_LOG_OUTPUT
Job attribute representing how a job log will be produced when the job completes. This does not affect job logs produced when the message queue is full and the job message queue full action specifies *PRTWRAP. Messages in the job messages queue are written to a spooled file, from which the job log can be printed, unless the Control Job Log Output (QMHCTLJL) API was used in the job to specify that the messages in the job log are to be written to a database file.

The job log output value can be changed at any time until the job log has been produced or removed. To change the job log output value for a job, use the Change Job (QWTCHGJB) API or the Change Job (CHGJOB) command.

The job log can be displayed at any time until the job log has been produced or removed. To display a job's job log, use the Display Job Log (DSPJOBLOG) command.

The job log can be removed when the job has completed and the job log has not yet been produced or removed. To remove the job log, use the Remove Pending Job Log (QWTRMVJL) API or the End Job (ENDJOB) command.

Possible values are:

Type: String

Only valid on V5R4 systems and higher.

See Also:
Constant Field Values

JOB_LOG_OUTPUT_SYSTEM_VALUE

public static final String JOB_LOG_OUTPUT_SYSTEM_VALUE
Constant indicating that the value is specifed by the QLOGOUTPUT system value.

See Also:
JOB_LOG_OUTPUT, Constant Field Values

JOB_LOG_OUTPUT_JOB_LOG_SERVER

public static final String JOB_LOG_OUTPUT_JOB_LOG_SERVER
Constant indicating that the job log will be produced by a job log server. For more information about job log servers, refer to the Start Job Log Server (STRLOGSVR) command.

See Also:
JOB_LOG_OUTPUT, Constant Field Values

JOB_LOG_OUTPUT_JOB_END

public static final String JOB_LOG_OUTPUT_JOB_END
Constant indicating that the job log will be produced by the job itself. If the job cannot produce its own job log, the job log will be produced by a job log server. For example, a job does not produce its own job log when the system is processing a Power Down System (PWRDWNSYS) command.

See Also:
JOB_LOG_OUTPUT, Constant Field Values

JOB_LOG_OUTPUT_PENDING

public static final String JOB_LOG_OUTPUT_PENDING
Constant indicating that the job log will not be produced. The job log remains pending until removed.

See Also:
JOB_LOG_OUTPUT, Constant Field Values

JOB_LOG_PENDING

public static final int JOB_LOG_PENDING
Job attribute representing whether a job's log has been written or not. If the system fails while the job was active or the job ends abnormally, the job log may not be written yet. This flag remains on until the job log has been written. Possible values are:

Read-only: true

Type: String

Only valid on V5R1 systems and higher.

See Also:
Constant Field Values

JOB_LOG_PENDING_NO

public static final String JOB_LOG_PENDING_NO
Constant indicating that the job log is not pending.

See Also:
JOB_LOG_PENDING, Constant Field Values

JOB_LOG_PENDING_YES

public static final String JOB_LOG_PENDING_YES
Constant indicating that the job log is pending and waiting to be written.

See Also:
JOB_LOG_PENDING, Constant Field Values

JOB_NAME

public static final int JOB_NAME
Job attribute representing the name of the job as identified to the system. For an interactive job, the system assigns the job name of the work station where the job started; for a batch job, you specify the name in the command when you submit the job. Possible values are:

Type: String

See Also:
getName(), setName(java.lang.String), Constant Field Values

JOB_NAME_INTERNAL

public static final String JOB_NAME_INTERNAL
Constant indicating that the INTERNAL_JOB_ID locates the job. The user name and job number must be blank.

See Also:
JOB_NAME, Constant Field Values

JOB_NAME_CURRENT

public static final String JOB_NAME_CURRENT
Constant indicating the job that this program is running in. The user name and job number must be blank.

See Also:
JOB_NAME, Constant Field Values

JOB_NUMBER

public static final int JOB_NUMBER
Job attribute representing the system-generated job number. Possible values are:

Type: String

See Also:
getNumber(), setNumber(java.lang.String), Constant Field Values

JOB_NUMBER_BLANK

public static final String JOB_NUMBER_BLANK
Constant indicating a blank job number. This must be used if JOB_NAME_INTERNAL or JOB_NAME_CURRENT is specified for the JOB_NAME.

See Also:
JOB_NUMBER, Constant Field Values

JOB_QUEUE

public static final int JOB_QUEUE
Job attribute representing the name of the job queue that the job is currently on, or that the job was on if it is currently active. This attribute is valid to be set for jobs whose status is *JOBQ. Attempting to set this attribute for jobs with a status of *OUTQ or *ACTIVE will cause an error to be signaled. This attribute is valid to be retrieved for jobs whose status is *JOBQ or *ACTIVE. Retrieving this attribute for jobs with a status of *OUTQ will return a value of blanks.

Type: String

See Also:
getQueue(), setQueue(java.lang.String), Constant Field Values

JOB_QUEUE_DATE

public static final int JOB_QUEUE_DATE
Job attribute representing the date and time this job was put on this job queue. This field will contain blanks if the job was not on a job queue.

Read-only: true

Type: String in the system timestamp format

See Also:
getJobPutOnJobQueueDate(), Constant Field Values

JOB_QUEUE_PRIORITY

public static final int JOB_QUEUE_PRIORITY
Job attribute representing the scheduling priority of the job compared to other jobs on the same job queue. The highest priority is 0 and the lowest is 9. This value is valid for jobs whose status is *JOBQ or *ACTIVE. For jobs with a status of *OUTQ, attempting to set this attribute will cause an error to be signaled and Retrieving this attribute will return a value of blanks.

Type: String

See Also:
getQueuePriority(), setQueuePriority(int), Constant Field Values

JOB_QUEUE_STATUS

public static final int JOB_QUEUE_STATUS
Job attribute representing the status of this job on the job queue. Possible values are:

Read-only: true

Type: String

See Also:
getJobStatusInJobQueue(), Constant Field Values

JOB_QUEUE_STATUS_BLANK

public static final String JOB_QUEUE_STATUS_BLANK
Constant indicating that this job was not on a job queue.

See Also:
JOB_QUEUE_STATUS, Constant Field Values

JOB_QUEUE_STATUS_SCHEDULED

public static final String JOB_QUEUE_STATUS_SCHEDULED
Constant indicating that this job will run as scheduled.

See Also:
JOB_QUEUE_STATUS, Constant Field Values

JOB_QUEUE_STATUS_HELD

public static final String JOB_QUEUE_STATUS_HELD
Constant indicating that this job is being held on the job queue.

See Also:
JOB_QUEUE_STATUS, Constant Field Values

JOB_QUEUE_STATUS_READY

public static final String JOB_QUEUE_STATUS_READY
Constant indicating that this job is ready to be selected.

See Also:
JOB_QUEUE_STATUS, Constant Field Values

JOB_STATUS

public static final int JOB_STATUS
Job attribute representing the status of this job. Possible values are:

Read-only: true

Type: String

See Also:
getStatus(), Constant Field Values

JOB_STATUS_ACTIVE

public static final String JOB_STATUS_ACTIVE
Constant indicating this job is an active job. This includes group jobs, system request jobs, and disconnected jobs.

See Also:
JOB_STATUS, Constant Field Values

JOB_STATUS_JOBQ

public static final String JOB_STATUS_JOBQ
Constant indicating this job is currently on a job queue.

See Also:
JOB_STATUS, Constant Field Values

JOB_STATUS_OUTQ

public static final String JOB_STATUS_OUTQ
Constant indicating this job has completed running, but still has output on an output queue.

See Also:
JOB_STATUS, Constant Field Values

JOB_SUBTYPE

public static final int JOB_SUBTYPE
Job attribute representing additional information about the job type (if any exists). Possible values are:

Read-only: true

Type: String

See Also:
getSubtype(), Constant Field Values

JOB_SUBTYPE_BLANK

public static final String JOB_SUBTYPE_BLANK
Constant indicating that the job has no special subtype or is not a valid job.

See Also:
JOB_SUBTYPE, Constant Field Values

JOB_SUBTYPE_IMMEDIATE

public static final String JOB_SUBTYPE_IMMEDIATE
Constant indicating that the job is an immediate job.

See Also:
JOB_SUBTYPE, Constant Field Values

JOB_SUBTYPE_PROCEDURE_START_REQUEST

public static final String JOB_SUBTYPE_PROCEDURE_START_REQUEST
Constant indicating that the job started with a procedure start request.

See Also:
JOB_SUBTYPE, Constant Field Values

JOB_SUBTYPE_MACHINE_SERVER_JOB

public static final String JOB_SUBTYPE_MACHINE_SERVER_JOB
Constant indicating that the job is an AS/400 Advanced 36 machine server job.

See Also:
JOB_SUBTYPE, Constant Field Values

JOB_SUBTYPE_PRESTART

public static final String JOB_SUBTYPE_PRESTART
Constant indicating that the job is a prestart job.

See Also:
JOB_SUBTYPE, Constant Field Values

JOB_SUBTYPE_PRINT_DRIVER

public static final String JOB_SUBTYPE_PRINT_DRIVER
Constant indicating that the job is a print driver job.

See Also:
JOB_SUBTYPE, Constant Field Values

JOB_SUBTYPE_MRT

public static final String JOB_SUBTYPE_MRT
Constant indicating that the job is a System/36 multiple requester terminal (MRT) job.

See Also:
JOB_SUBTYPE, Constant Field Values

JOB_SUBTYPE_ALTERNATE_SPOOL_USER

public static final String JOB_SUBTYPE_ALTERNATE_SPOOL_USER
Constant indicating that the job is an alternate spool user job.

See Also:
JOB_SUBTYPE, Constant Field Values

JOB_SWITCHES

public static final int JOB_SWITCHES
Job attribute representing the current setting of the job switches used by this job. This value is valid for all job types.

Type: String

See Also:
getJobSwitches(), setJobSwitches(java.lang.String), Constant Field Values

JOB_TYPE

public static final int JOB_TYPE
Job attribute representing the type of job. Possible values are:

Read-only: true

Type: String

See Also:
getType(), Constant Field Values

JOB_TYPE_NOT_VALID

public static final String JOB_TYPE_NOT_VALID
Constant indicating that the job is not a valid job.

See Also:
JOB_TYPE, Constant Field Values

JOB_TYPE_AUTOSTART

public static final String JOB_TYPE_AUTOSTART
Constant indicating that the job is an autostart job.

See Also:
JOB_TYPE, Constant Field Values

JOB_TYPE_BATCH

public static final String JOB_TYPE_BATCH
Constant indicating that the job is a batch job.

See Also:
JOB_TYPE, Constant Field Values

JOB_TYPE_INTERACTIVE

public static final String JOB_TYPE_INTERACTIVE
Constant indicating that the job is an interactive job.

See Also:
JOB_TYPE, Constant Field Values

JOB_TYPE_SUBSYSTEM_MONITOR

public static final String JOB_TYPE_SUBSYSTEM_MONITOR
Constant indicating that the job is a subsystem monitor job.

See Also:
JOB_TYPE, Constant Field Values

JOB_TYPE_SPOOLED_READER

public static final String JOB_TYPE_SPOOLED_READER
Constant indicating that the job is a spooled reader job.

See Also:
JOB_TYPE, Constant Field Values

JOB_TYPE_SYSTEM

public static final String JOB_TYPE_SYSTEM
Constant indicating that the job is a system job.

See Also:
JOB_TYPE, Constant Field Values

JOB_TYPE_SPOOLED_WRITER

public static final String JOB_TYPE_SPOOLED_WRITER
Constant indicating that the job is a spooled writer job.

See Also:
JOB_TYPE, Constant Field Values

JOB_TYPE_SCPF_SYSTEM

public static final String JOB_TYPE_SCPF_SYSTEM
Constant indicating that the job is the SCPF system job.

See Also:
JOB_TYPE, Constant Field Values

JOB_TYPE_ENHANCED

public static final int JOB_TYPE_ENHANCED
Job attribute representing the type of job. This attribute combines the JOB_TYPE and JOB_SUBTYPE attributes. Possible values are:

Read-only: true

Type: Integer

Only valid on V5R1 systems and higher.

See Also:
Constant Field Values

JOB_TYPE_ENHANCED_AUTOSTART

public static final Integer JOB_TYPE_ENHANCED_AUTOSTART
Constant indicating that the job is an autostart job.

See Also:
JOB_TYPE_ENHANCED

JOB_TYPE_ENHANCED_BATCH

public static final Integer JOB_TYPE_ENHANCED_BATCH
Constant indicating that the job is a batch job.

See Also:
JOB_TYPE_ENHANCED

JOB_TYPE_ENHANCED_BATCH_IMMEDIATE

public static final Integer JOB_TYPE_ENHANCED_BATCH_IMMEDIATE
Constant indicating that the job is a batch immediate job.

See Also:
JOB_TYPE_ENHANCED

JOB_TYPE_ENHANCED_BATCH_MRT

public static final Integer JOB_TYPE_ENHANCED_BATCH_MRT
Constant indicating that the job is a batch System/36 multiple requester terminal (MRT) job.

See Also:
JOB_TYPE_ENHANCED

JOB_TYPE_ENHANCED_BATCH_ALTERNATE_SPOOL_USER

public static final Integer JOB_TYPE_ENHANCED_BATCH_ALTERNATE_SPOOL_USER
Constant indicating that the job is a batch alternate spool user job.

See Also:
JOB_TYPE_ENHANCED

JOB_TYPE_ENHANCED_COMM_PROCEDURE_START_REQUEST

public static final Integer JOB_TYPE_ENHANCED_COMM_PROCEDURE_START_REQUEST
Constant indicating that the job is a communications procedure start request job.

See Also:
JOB_TYPE_ENHANCED

JOB_TYPE_ENHANCED_INTERACTIVE

public static final Integer JOB_TYPE_ENHANCED_INTERACTIVE
Constant indicating that the job is an interactive job.

See Also:
JOB_TYPE_ENHANCED

JOB_TYPE_ENHANCED_INTERACTIVE_GROUP

public static final Integer JOB_TYPE_ENHANCED_INTERACTIVE_GROUP
Constant indicating that the job is an interactive job that is part of a group.

See Also:
JOB_TYPE_ENHANCED

JOB_TYPE_ENHANCED_INTERACTIVE_SYSREQ

public static final Integer JOB_TYPE_ENHANCED_INTERACTIVE_SYSREQ
Constant indicating that the job is an interactive job that is part of a system request pair.

See Also:
JOB_TYPE_ENHANCED

JOB_TYPE_ENHANCED_INTERACTIVE_SYSREQ_AND_GROUP

public static final Integer JOB_TYPE_ENHANCED_INTERACTIVE_SYSREQ_AND_GROUP
Constant indicating that the job is an interactive job that is part of a system request pair and part of a group.

See Also:
JOB_TYPE_ENHANCED

JOB_TYPE_ENHANCED_PRESTART

public static final Integer JOB_TYPE_ENHANCED_PRESTART
Constant indicating that the job is a prestart job.

See Also:
JOB_TYPE_ENHANCED

JOB_TYPE_ENHANCED_PRESTART_BATCH

public static final Integer JOB_TYPE_ENHANCED_PRESTART_BATCH
Constant indicating that the job is a prestart batch job.

See Also:
JOB_TYPE_ENHANCED

JOB_TYPE_ENHANCED_PRESTART_COMM

public static final Integer JOB_TYPE_ENHANCED_PRESTART_COMM
Constant indicating that the job is a prestart communications job.

See Also:
JOB_TYPE_ENHANCED

JOB_TYPE_ENHANCED_READER

public static final Integer JOB_TYPE_ENHANCED_READER
Constant indicating that the job is a reader job.

See Also:
JOB_TYPE_ENHANCED

JOB_TYPE_ENHANCED_SUBSYSTEM

public static final Integer JOB_TYPE_ENHANCED_SUBSYSTEM
Constant indicating that the job is a subsystem job.

See Also:
JOB_TYPE_ENHANCED

JOB_TYPE_ENHANCED_SYSTEM

public static final Integer JOB_TYPE_ENHANCED_SYSTEM
Constant indicating that the job is a system job (all system jobs including SCPF).

See Also:
JOB_TYPE_ENHANCED

JOB_TYPE_ENHANCED_WRITER

public static final Integer JOB_TYPE_ENHANCED_WRITER
Constant indicating that the job is a writer job (including both spool writers and print drivers).

See Also:
JOB_TYPE_ENHANCED

JOB_USER_IDENTITY

public static final int JOB_USER_IDENTITY
Job attribute representing the user profile name by which the job is known to other jobs on the system. The job user identity is used for authorization checks when other jobs on the system attempt to operate against the job. For more detail on how the job user identity is set and used, refer to the Set Job User Identity (QWTSJUID) API. For jobs that are on a job queue or have completed running, the job user identity is same as the user name from the qualified job name. This attribute will return blanks for these jobs. A value of *N is returned if the job user identity is set, but the user profile to which it is set no longer exists.

Read-only: true

Type: String

See Also:
Constant Field Values

JOB_USER_IDENTITY_SETTING

public static final int JOB_USER_IDENTITY_SETTING
Job attribute representing the method by which the job user identity was set. Possible values are:

Read-only: true

Type: String

See Also:
Constant Field Values

JOB_USER_IDENTITY_SETTING_DEFAULT

public static final String JOB_USER_IDENTITY_SETTING_DEFAULT
Constant indicating that the job is currently running single threaded and the job user identity is the name of the user profile under which the job is currently running. This value is also returned for jobs that are on a job queue or have completed running. This has the same meaning as a value of *DEFAULT on the Display Job Status Attributes display.

See Also:
JOB_USER_IDENTITY_SETTING, Constant Field Values

JOB_USER_IDENTITY_SETTING_APPLICATION

public static final String JOB_USER_IDENTITY_SETTING_APPLICATION
Constant indicating that the job user identity was explicitly set by an application using one of the Set Job User Identity APIs, QWTSJUID or QwtSetJuid(). The job may be running either single threaded or multithreaded. This has the same meaning as a value of *APPLICATION on the Display Job Status Attributes display.

See Also:
JOB_USER_IDENTITY_SETTING, Constant Field Values

JOB_USER_IDENTITY_SETTING_SYSTEM

public static final String JOB_USER_IDENTITY_SETTING_SYSTEM
Constant indicating that the job is currently running multithreaded and the job user identity was implicitly set by the system when the job became multithreaded. It was set to the name of the user profile that the job was running under when it became multithreaded. This has the same meaning as a value of *SYSTEM on the Display Job Status Attributes display.

See Also:
JOB_USER_IDENTITY_SETTING, Constant Field Values

KEEP_DDM_CONNECTIONS_ACTIVE

public static final int KEEP_DDM_CONNECTIONS_ACTIVE
Job attribute representing whether connections using distributed data management (DDM) protocols remain active when they are not being used. The connections include APPC conversations, active TCP/IP connections, or Opti-Connect connections. The DDM protocols are used in Distributed Relational Database Architecture (DRDA) applications, DDM applications, or DB2 Multisystem applications. Possible values are:

Type: String

See Also:
getDDMConversationHandling(), setDDMConversationHandling(java.lang.String), Constant Field Values

KEEP_DDM_CONNECTIONS_ACTIVE_KEEP

public static final String KEEP_DDM_CONNECTIONS_ACTIVE_KEEP
Constant indicating that the system keeps DDM connections active when there are no users, except for the following:

See Also:
KEEP_DDM_CONNECTIONS_ACTIVE, Constant Field Values

KEEP_DDM_CONNECTIONS_ACTIVE_DROP

public static final String KEEP_DDM_CONNECTIONS_ACTIVE_DROP
Constant indicating that the system ends a DDM connection when there are no users. Examples include when an application closes a DDM file, or when a DRDA application runs an SQL DISCONNECT statement.

See Also:
KEEP_DDM_CONNECTIONS_ACTIVE, Constant Field Values

LANGUAGE_ID

public static final int LANGUAGE_ID
Job attribute representing the language identifier associated with this job. The language identifier is used when *LANGIDUNQ or *LANGIDSHR is specified on the sort sequence parameter. If the job CCSID is 65535, this parameter is also used to determine the value of the job default CCSID. Possible values are:

Type: String

See Also:
getLanguageID(), setLanguageID(java.lang.String), Constant Field Values

LANGUAGE_ID_SYSTEM_VALUE

public static final String LANGUAGE_ID_SYSTEM_VALUE
Constant indicating the system value QLANGID is used.

See Also:
LANGUAGE_ID, Constant Field Values

LANGUAGE_ID_INITIAL_USER

public static final String LANGUAGE_ID_INITIAL_USER
Constant indicating the language ID specified in the user profile under which this thread was initially running is used.

See Also:
LANGUAGE_ID, Constant Field Values

LOG_CL_PROGRAMS

public static final int LOG_CL_PROGRAMS
Job attribute representing whether or not commands are logged for CL programs that are run. Possible values are:

Type: String

See Also:
getLoggingCLPrograms(), setLoggingCLPrograms(java.lang.String), Constant Field Values

LOG_CL_PROGRAMS_YES

public static final String LOG_CL_PROGRAMS_YES
Constant indicating that commands are logged for CL programs that are run.

See Also:
LOG_CL_PROGRAMS, Constant Field Values

LOG_CL_PROGRAMS_NO

public static final String LOG_CL_PROGRAMS_NO
Constant indicating that commands are not logged for CL programs that are run.

See Also:
LOG_CL_PROGRAMS, Constant Field Values

LOGGING_LEVEL

public static final int LOGGING_LEVEL
Job attribute representing what type of information is logged. Possible values are:

Type: String

See Also:
getLoggingLevel(), setLoggingLevel(int), Constant Field Values

LOGGING_LEVEL_NONE

public static final String LOGGING_LEVEL_NONE
Constant indicating that no messages are logged.

See Also:
LOGGING_LEVEL, Constant Field Values

LOGGING_LEVEL_MESSAGES_BY_SEVERITY

public static final String LOGGING_LEVEL_MESSAGES_BY_SEVERITY
Constant indicating that all messages sent to the job's external message queue with a severity greater than or equal to the message logging severity are logged. This includes the indication of job start, job end, and job completion status.

See Also:
LOGGING_LEVEL, Constant Field Values

LOGGING_LEVEL_REQUESTS_BY_SEVERITY_AND_ASSOCIATED_MESSAGES

public static final String LOGGING_LEVEL_REQUESTS_BY_SEVERITY_AND_ASSOCIATED_MESSAGES
Constant indicating that the following information is logged:

See Also:
LOGGING_LEVEL, Constant Field Values

LOGGING_LEVEL_ALL_REQUESTS_AND_ASSOCIATED_MESSAGES

public static final String LOGGING_LEVEL_ALL_REQUESTS_AND_ASSOCIATED_MESSAGES
Constant indicating that the following information is logged:

See Also:
LOGGING_LEVEL, Constant Field Values

LOGGING_LEVEL_ALL_REQUESTS_AND_MESSAGES

public static final String LOGGING_LEVEL_ALL_REQUESTS_AND_MESSAGES
Constant indicating that the following information is logged:

See Also:
LOGGING_LEVEL, Constant Field Values

LOGGING_SEVERITY

public static final int LOGGING_SEVERITY
Job attribute representing the severity level that is used in conjunction with the logging level to determine which error messages are logged in the job log. The values range from 00 through 99.

Type: Integer

See Also:
getLoggingSeverity(), setLoggingSeverity(int), Constant Field Values

LOGGING_TEXT

public static final int LOGGING_TEXT
Job attribute representing the level of message text that is written in the job log when a message is logged according to the LOGGING_LEVEL and LOGGING_SEVERITY. Possible values are:

Type: String

See Also:
getLoggingText(), setLoggingText(java.lang.String), Constant Field Values

LOGGING_TEXT_MESSAGE

public static final String LOGGING_TEXT_MESSAGE
Constant indicating that only the message text is written to the job log.

See Also:
LOGGING_TEXT, Constant Field Values

LOGGING_TEXT_SECLVL

public static final String LOGGING_TEXT_SECLVL
Constant indicating that both the message text and the message help (cause and recovery) of the error message are written to the job log.

See Also:
LOGGING_TEXT, Constant Field Values

LOGGING_TEXT_NO_LIST

public static final String LOGGING_TEXT_NO_LIST
Constant indicating that if the job ends normally, no job log is produced. If the job ends abnormally (the job end code is 20 or higher), a job log is produced. The messages that appear in the job log contain both the message text and the message. help.

See Also:
LOGGING_TEXT, Constant Field Values

MAX_CPU_TIME

public static final int MAX_CPU_TIME
Job attribute representing the maximum processing unit time (in milliseconds) that the job can use. If the job consists of multiple routing steps, this is the maximum processing unit time that the current routing step can use. If the maximum time is exceeded, the job is ended. A value of -1 is returned if there is no maximum (*NOMAX). A value of zero is returned if the job is not active.

Read-only: true

Type: Integer

See Also:
Constant Field Values

MAX_TEMP_STORAGE

public static final int MAX_TEMP_STORAGE
Job attribute representing the maximum amount of auxiliary storage (in kilobytes) that the job can use. If the job consists of multiple routing steps, this is the maximum temporary storage that the routing step can use. This temporary storage is used for storage required by the program itself and by implicitly created internal system objects used to support the routing step. (It does not include storage in the QTEMP library.) If the maximum temporary storage is exceeded, the job is ended. This does not apply to the use of permanent storage, which is controlled through the user profile. A value of -1 is returned if there is no maximum (*NOMAX).

Read-only: true

Type: Integer

See Also:
Constant Field Values

MAX_TEMP_STORAGE_LARGE

public static final int MAX_TEMP_STORAGE_LARGE
Job attribute representing the maximum amount of auxiliary storage (in megabytes) that the job can use. If the job consists of multiple routing steps, this is the maximum temporary storage that the routing step can use. This temporary storage is used for storage required by the program itself and by implicitly created internal system objects used to support the routing step. (It does not include storage in the QTEMP library.) If the maximum temporary storage is exceeded, the job is ended. This does not apply to the use of permanent storage, which is controlled through the user profile. A value of -1 is returned if there is no maximum (*NOMAX).

Read-only: true

Type: Long

See Also:
Constant Field Values

MAX_THREADS

public static final int MAX_THREADS
Job attribute representing the maximum number of threads that a job can run with at any time. If multiple threads are initiated simultaneously, this value may be exceeded. If this maximum value is exceeded, the excess threads will be allowed to run to their normal completion. Initiation of additional threads will be inhibited until the maximum number of threads in the job drops below this maximum value. A value of -1 is returned if there is no maximum (*NOMAX). Depending upon the resources used by the threads and the resources available to the system, the initiation of additional threads may be inhibited before this maximum value is reached.

Read-only: true

Type: Integer

See Also:
Constant Field Values

MEMORY_POOL

public static final int MEMORY_POOL
Job attribute representing the name of the memory pool in which the job started running. The name may be a number, in which case it is a private pool associated with a subsystem. Possible values are:

Read-only: true

Type: String

Only valid on V5R1 systems and higher.

See Also:
Constant Field Values

MEMORY_POOL_MACHINE

public static final String MEMORY_POOL_MACHINE
Constant indicating that this job is running in the machine pool.

See Also:
MEMORY_POOL, Constant Field Values

MEMORY_POOL_BASE

public static final String MEMORY_POOL_BASE
Constant indicating that this job is running in the base system pool, which can be shared with other subsystems.

See Also:
MEMORY_POOL, Constant Field Values

MEMORY_POOL_INTERACTIVE

public static final String MEMORY_POOL_INTERACTIVE
Constant indicating that this job is running in the shared pool used for interactive work.

See Also:
MEMORY_POOL, Constant Field Values

MEMORY_POOL_SPOOL

public static final String MEMORY_POOL_SPOOL
Constant indicating that this job is running in the shared pool for spooled writers.

See Also:
MEMORY_POOL, Constant Field Values

MESSAGE_REPLY

public static final int MESSAGE_REPLY
Job attribute representing whether the job is waiting for a reply to a specific message. This value applies only when either the ACTIVE_JOB_STATUS or ACTIVE_JOB_STATUS_FOR_JOBS_ENDING attributes are set to ACTIVE_JOB_STATUS_WAIT_MESSAGE. Possible values are:

Read-only: true

Type: String

Only valid on V5R1 systems and higher.

See Also:
Constant Field Values

MESSAGE_REPLY_NOT_IN_MESSAGE_WAIT

public static final String MESSAGE_REPLY_NOT_IN_MESSAGE_WAIT
Constant indicating that the job currently is not in message wait status.

See Also:
MESSAGE_REPLY, Constant Field Values

MESSAGE_REPLY_WAITING

public static final String MESSAGE_REPLY_WAITING
Constant indicating that the job is waiting for a reply to a message.

See Also:
MESSAGE_REPLY, Constant Field Values

MESSAGE_REPLY_NOT_WAITING

public static final String MESSAGE_REPLY_NOT_WAITING
Constant indicating that the job is not waiting for a reply to a message.

See Also:
MESSAGE_REPLY, Constant Field Values

MESSAGE_QUEUE_ACTION

public static final int MESSAGE_QUEUE_ACTION
Job attribute representing the action to take when the message queue is full. Possible values are:

Type: String

See Also:
getJobMessageQueueFullAction(), setJobMessageQueueFullAction(java.lang.String), Constant Field Values

MESSAGE_QUEUE_ACTION_SYSTEM_VALUE

public static final String MESSAGE_QUEUE_ACTION_SYSTEM_VALUE
Constant indicating the value specified for the QJOBMSGQFL system value is used.

See Also:
MESSAGE_QUEUE_ACTION, Constant Field Values

MESSAGE_QUEUE_ACTION_NO_WRAP

public static final String MESSAGE_QUEUE_ACTION_NO_WRAP
Constant indicating that when the job message queue is full, do not wrap. This action causes the job to end.

See Also:
MESSAGE_QUEUE_ACTION, Constant Field Values

MESSAGE_QUEUE_ACTION_WRAP

public static final String MESSAGE_QUEUE_ACTION_WRAP
Constant indicating that when the job message queue is full, wrap to the beginning and start filling again.

See Also:
MESSAGE_QUEUE_ACTION, Constant Field Values

MESSAGE_QUEUE_ACTION_PRINT_WRAP

public static final String MESSAGE_QUEUE_ACTION_PRINT_WRAP
Constant indicating that when the job message queue is full, wrap the message queue and print the messages that are being overlaid because of the wrapping.

See Also:
MESSAGE_QUEUE_ACTION, Constant Field Values

MESSAGE_QUEUE_MAX_SIZE

public static final int MESSAGE_QUEUE_MAX_SIZE
Job attribute representing the maximum size (in megabytes) that the job message queue can become. The range is 2 to 64.

Read-only: true

Type: Integer

See Also:
getJobMessageQueueMaximumSize(), Constant Field Values

MODE

public static final int MODE
Job attribute representing the mode name of the advanced program-to-program communications (APPC) device that started the job. Possible values are:

Read-only: true

Type: String

See Also:
Constant Field Values

OUTPUT_QUEUE

public static final int OUTPUT_QUEUE
Job attribute representing the name of the default output queue that is used for spooled output produced by this job. The default output queue is only for spooled printer files that specify *JOB for the output queue. Possible values are:

Type: String

See Also:
getOutputQueue(), setOutputQueue(java.lang.String), Constant Field Values

OUTPUT_QUEUE_DEVICE

public static final String OUTPUT_QUEUE_DEVICE
Constant indicating the device specified on the Create Printer File (CRTPRTF), Change Printer File (CHGPRTF), or Override with Printer File (OVRPRTF) commands is used.

See Also:
OUTPUT_QUEUE, Constant Field Values

OUTPUT_QUEUE_WORK_STATION

public static final String OUTPUT_QUEUE_WORK_STATION
Constant indicating the default output queue that is used with this job is the output queue that is assigned to the work station associated with the job at the time the job is started.

See Also:
OUTPUT_QUEUE, Constant Field Values

OUTPUT_QUEUE_INITIAL_USER

public static final String OUTPUT_QUEUE_INITIAL_USER
Constant indicating the output queue name specified in the user profile under which this thread was initially running is used.

See Also:
OUTPUT_QUEUE, Constant Field Values

OUTPUT_QUEUE_PRIORITY

public static final int OUTPUT_QUEUE_PRIORITY
Job attribute representing the output priority for spooled output files that this job produces. The highest priority is 0, and the lowest is 9.

Type: String

See Also:
getOutputQueuePriority(), setOutputQueuePriority(int), Constant Field Values

PRINT_KEY_FORMAT

public static final int PRINT_KEY_FORMAT
Job attribute representing whether border and header information is provided when the Print key is pressed. Possible values are:

Type: String

See Also:
getPrintKeyFormat(), setPrintKeyFormat(java.lang.String), Constant Field Values

PRINT_KEY_FORMAT_SYSTEM_VALUE

public static final String PRINT_KEY_FORMAT_SYSTEM_VALUE
Constant indicating that the value specified on the system value QPRTKEYFMT determines whether header or border information is printed.

See Also:
PRINT_KEY_FORMAT, Constant Field Values

PRINT_KEY_FORMAT_NONE

public static final String PRINT_KEY_FORMAT_NONE
Constant indicating that the border and header information is not included with output from the Print key.

See Also:
PRINT_KEY_FORMAT, Constant Field Values

PRINT_KEY_FORMAT_BORDER

public static final String PRINT_KEY_FORMAT_BORDER
Constant indicating that the border information is included with output from the Print key.

See Also:
PRINT_KEY_FORMAT, Constant Field Values

PRINT_KEY_FORMAT_HEADER

public static final String PRINT_KEY_FORMAT_HEADER
Constant indicating that the header information is included with output from the Print key.

See Also:
PRINT_KEY_FORMAT, Constant Field Values

PRINT_KEY_FORMAT_ALL

public static final String PRINT_KEY_FORMAT_ALL
Constant indicating that the border and header information is included with output from the Print key.

See Also:
PRINT_KEY_FORMAT, Constant Field Values

PRINT_TEXT

public static final int PRINT_TEXT
Job attribute representing the line of text (if any) that is printed at the bottom of each page of printed output for the job. Possible values are:

Type: String

See Also:
getPrintText(), setPrintText(java.lang.String), Constant Field Values

PRINT_TEXT_SYSTEM_VALUE

public static final String PRINT_TEXT_SYSTEM_VALUE
Constant indicating the system value QPRTTXT is used.

See Also:
PRINT_TEXT, Constant Field Values

PRINT_TEXT_BLANK

public static final String PRINT_TEXT_BLANK
Constant indicating that no text is printed on printed output.

See Also:
PRINT_TEXT, Constant Field Values

PRINTER_DEVICE_NAME

public static final int PRINTER_DEVICE_NAME
Job attribute representing the printer device used for printing output from this job. Possible values are:

Type: String

See Also:
getPrinterDeviceName(), setPrinterDeviceName(java.lang.String), Constant Field Values

PRINTER_DEVICE_NAME_SYSTEM_VALUE

public static final String PRINTER_DEVICE_NAME_SYSTEM_VALUE
Constant indicating the value in the system value QPRTDEV is used as the printer device.

See Also:
PRINTER_DEVICE_NAME, Constant Field Values

PRINTER_DEVICE_NAME_WORK_STATION

public static final String PRINTER_DEVICE_NAME_WORK_STATION
Constant indicating that the default printer device used with this job is the printer device assigned to the work station that is associated with the job.

See Also:
PRINTER_DEVICE_NAME, Constant Field Values

PRINTER_DEVICE_NAME_INITIAL_USER

public static final String PRINTER_DEVICE_NAME_INITIAL_USER
Constant indicating that the printer device name specified in the user profile under which this thread was initially running is used.

See Also:
PRINTER_DEVICE_NAME, Constant Field Values

PRODUCT_LIBRARIES

public static final int PRODUCT_LIBRARIES
Job attribute representing the libraries that contain product information for the initial thread of the job.

Read-only: true

Type: String

Can be loaded by JobList: false

See Also:
getNumberOfProductLibraries(), getProductLibraries(), Constant Field Values

PRODUCT_RETURN_CODE

public static final int PRODUCT_RETURN_CODE
Job attribute representing the return code set by the compiler for Integrated Language Environment (ILE) languages. Refer to the appropriate ILE-conforming language manual for possible values. This attribute is scoped to the job and represents the most recent return code set by any thread within the job.

Read-only: true

Type: Integer

See Also:
Constant Field Values

PROGRAM_RETURN_CODE

public static final int PROGRAM_RETURN_CODE
Job attribute representing the completion status of the last program that has finished running, if the job contains any RPG, COBOL, data file utility (DFU), or sort utility programs. If not, a value of 0 is returned.

Read-only: true

Type: Integer

See Also:
Constant Field Values

ROUTING_DATA

public static final int ROUTING_DATA
Job attribute representing the routing data that is used to determine the routing entry that identifies the program to start for the routing step.

Read-only: true

Type: String

See Also:
getRoutingData(), Constant Field Values

RUN_PRIORITY

public static final int RUN_PRIORITY
Job attribute representing the priority at which the job is currently running, relative to other jobs on the system. The run priority ranges from 0 (highest priority) to 99 (lowest priority).

Type: Integer

See Also:
getRunPriority(), setRunPriority(int), Constant Field Values

SCHEDULE_DATE

public static final int SCHEDULE_DATE
Job attribute representing the date on which the submitted job becomes eligible to run. If your system or your job is configured to use the Julian date format, *MONTHSTR and *MONTHEND are calculated as if the system or job did not use the Julian date format. Possible values that can be used on setValue() are:

Type: String on setValue(); java.util.Date on getValue().

See Also:
getScheduleDate(), setScheduleDate(java.util.Date), Constant Field Values

SCHEDULE_DATE_CURRENT

public static final String SCHEDULE_DATE_CURRENT
Constant indicating the submitted job becomes eligible to run on the current date.

See Also:
SCHEDULE_DATE, Constant Field Values

SCHEDULE_DATE_MONTH_START

public static final String SCHEDULE_DATE_MONTH_START
Constant indicating the submitted job becomes eligible to run on the first day of the month. If you specify this value and if today is the first day of the month and the time you specify on the SCHEDULE_TIME attribute has not passed, the job becomes eligible to run today. Otherwise, the job becomes eligible on the first day of the next month.

See Also:
SCHEDULE_DATE, Constant Field Values

SCHEDULE_DATE_MONTH_END

public static final String SCHEDULE_DATE_MONTH_END
Constant indicating the submitted job becomes eligible to run on the last day of the month. If you specify this value and if today is the last day of the month and the time you specify on the SCHEDULE_TIME attribute has not passed, the job becomes eligible to run today. Otherwise, the job becomes eligible on the last day of the next month.

See Also:
SCHEDULE_DATE, Constant Field Values

SCHEDULE_DATE_MONDAY

public static final String SCHEDULE_DATE_MONDAY
Constant indicating the job becomes eligible to run on Monday.

See Also:
SCHEDULE_DATE, Constant Field Values

SCHEDULE_DATE_TUESDAY

public static final String SCHEDULE_DATE_TUESDAY
Constant indicating the job becomes eligible to run on Tuesday.

See Also:
SCHEDULE_DATE, Constant Field Values

SCHEDULE_DATE_WEDNESDAY

public static final String SCHEDULE_DATE_WEDNESDAY
Constant indicating the job becomes eligible to run on Wednesday.

See Also:
SCHEDULE_DATE, Constant Field Values

SCHEDULE_DATE_THURSDAY

public static final String SCHEDULE_DATE_THURSDAY
Constant indicating the job becomes eligible to run on Thursday.

See Also:
SCHEDULE_DATE, Constant Field Values

SCHEDULE_DATE_FRIDAY

public static final String SCHEDULE_DATE_FRIDAY
Constant indicating the job becomes eligible to run on Friday.

See Also:
SCHEDULE_DATE, Constant Field Values

SCHEDULE_DATE_SATURDAY

public static final String SCHEDULE_DATE_SATURDAY
Constant indicating the job becomes eligible to run on Saturday.

See Also:
SCHEDULE_DATE, Constant Field Values

SCHEDULE_DATE_SUNDAY

public static final String SCHEDULE_DATE_SUNDAY
Constant indicating the job becomes eligible to run on Sunday.

See Also:
SCHEDULE_DATE, Constant Field Values

SCHEDULE_TIME

public static final int SCHEDULE_TIME
Job attribute representing the time on the scheduled date at which the job becomes eligible to run. Although the time can be specified to the second, the load on the system may affect the exact time at which the job becomes eligible to run. Possible values that can be used on setValue() are:

Type: String on setValue(); java.util.Date on getValue().

See Also:
getScheduleDate(), setScheduleTime(java.util.Date), Constant Field Values

SCHEDULE_TIME_CURRENT

public static final String SCHEDULE_TIME_CURRENT
Constant indicating the job is submitted on the current time.

See Also:
SCHEDULE_TIME, Constant Field Values

SERVER_TYPE

public static final int SERVER_TYPE
Job attribute representing the type of server represented by the job. A value of blanks indicates that the job is not part of a server.

Read-only: true

Type: String

See Also:
Constant Field Values

SIGNED_ON_JOB

public static final int SIGNED_ON_JOB
Job attribute representing whether the job is to be treated like a signed-on user on the system. Possible values are:

Read-only: true

Type: String

See Also:
getSignedOnJob(), Constant Field Values

SIGNED_ON_JOB_TRUE

public static final String SIGNED_ON_JOB_TRUE
Constant indicating that the job should be treated like a signed-on user.

See Also:
SIGNED_ON_JOB, Constant Field Values

SIGNED_ON_JOB_FALSE

public static final String SIGNED_ON_JOB_FALSE
Constant indicating that the job should not be treated like a signed-on user.

See Also:
SIGNED_ON_JOB, Constant Field Values

SORT_SEQUENCE_TABLE

public static final int SORT_SEQUENCE_TABLE
Job attribute representing the sort sequence table associated with this job. Possible values are:

Type: String

See Also:
getSortSequenceTable(), setSortSequenceTable(java.lang.String), Constant Field Values

SORT_SEQUENCE_TABLE_SYSTEM_VALUE

public static final String SORT_SEQUENCE_TABLE_SYSTEM_VALUE
Constant indicating the system value QSRTSEQ is used.

See Also:
SORT_SEQUENCE_TABLE, Constant Field Values

SORT_SEQUENCE_TABLE_INITIAL_USER

public static final String SORT_SEQUENCE_TABLE_INITIAL_USER
Constant indicating the sort sequence table specified in the user profile under which this thread was initially running is used.

See Also:
SORT_SEQUENCE_TABLE, Constant Field Values

SORT_SEQUENCE_TABLE_NONE

public static final String SORT_SEQUENCE_TABLE_NONE
Constant indicating that no sort sequence table is used. The hexadecimal values of the characters are used to determine the sort sequence.

See Also:
SORT_SEQUENCE_TABLE, Constant Field Values

SORT_SEQUENCE_TABLE_LANGUAGE_SHARED_WEIGHT

public static final String SORT_SEQUENCE_TABLE_LANGUAGE_SHARED_WEIGHT
Constant indicating that the sort sequence table used can contain the same weight for multiple characters, and it is the shared weight sort table associated with the language specified in the LANGUAGE_ID attribute.

See Also:
SORT_SEQUENCE_TABLE, Constant Field Values

SORT_SEQUENCE_TABLE_LANGUAGE_UNIQUE_WEIGHT

public static final String SORT_SEQUENCE_TABLE_LANGUAGE_UNIQUE_WEIGHT
Constant indicating that the sort sequence table used must contain a unique weight for each character in the code page, and it is the unique weight sort table associated with the language specified in the LANGUAGE_ID parameter.

See Also:
SORT_SEQUENCE_TABLE, Constant Field Values

SPECIAL_ENVIRONMENT

public static final int SPECIAL_ENVIRONMENT
Job attribute representing whether a job is running in a particular environment. Possible values are:

Read-only: true

Type: String

See Also:
Constant Field Values

SPECIAL_ENVIRONMENT_NONE

public static final String SPECIAL_ENVIRONMENT_NONE
Constant indicating that the job is not running in any special environment.

See Also:
SPECIAL_ENVIRONMENT, Constant Field Values

SPECIAL_ENVIRONMENT_SYSTEM_36

public static final String SPECIAL_ENVIRONMENT_SYSTEM_36
Constant indicating that the job is running in the System/36 environment.

See Also:
SPECIAL_ENVIRONMENT, Constant Field Values

SPECIAL_ENVIRONMENT_NOT_ACTIVE

public static final String SPECIAL_ENVIRONMENT_NOT_ACTIVE
Constant indicating that the special environment is ignored because the job is not currently active.

See Also:
SPECIAL_ENVIRONMENT, Constant Field Values

SPOOLED_FILE_ACTION

public static final int SPOOLED_FILE_ACTION
Job attribute representing whether spooled files can be accessed through job interfaces once a job has completed its normal activity. Possible values are:

Type: String

See Also:
Constant Field Values

SPOOLED_FILE_ACTION_KEEP

public static final String SPOOLED_FILE_ACTION_KEEP
Constant indicating that when the job completes its activity, as long as at least one spooled file for the job exists in the system auxiliary storage pool (ASP 1) or in a basic user ASP (ASPs 2-32), the spooled files are kept with the job and the status of the job is updated to indicate that the job has completed. If all remaining spooled files for the job are in independent ASPs (ASPs 33-255), the spooled files will be detached from the job and the job will be removed from the system.

See Also:
SPOOLED_FILE_ACTION, Constant Field Values

SPOOLED_FILE_ACTION_DETACH

public static final String SPOOLED_FILE_ACTION_DETACH
Constant indicating that spooled files are detached from the job when the job completes its activity.

See Also:
SPOOLED_FILE_ACTION, Constant Field Values

SPOOLED_FILE_ACTION_SYSTEM_VALUE

public static final String SPOOLED_FILE_ACTION_SYSTEM_VALUE
Constant indicating the job will take the spooled file action specified by the QSPLFACN system value.

See Also:
SPOOLED_FILE_ACTION, Constant Field Values

STATUS_MESSAGE_HANDLING

public static final int STATUS_MESSAGE_HANDLING
Job attribute representing whether status messages are displayed for this job. Possible values are:

Type: String

See Also:
getStatusMessageHandling(), setStatusMessageHandling(java.lang.String), Constant Field Values

STATUS_MESSAGE_HANDLING_SYSTEM_VALUE

public static final String STATUS_MESSAGE_HANDLING_SYSTEM_VALUE
Constant indicating the system value QSTSMSG is used.

See Also:
STATUS_MESSAGE_HANDLING, Constant Field Values

STATUS_MESSAGE_HANDLING_INITIAL_USER

public static final String STATUS_MESSAGE_HANDLING_INITIAL_USER
Constant indicating the status message handling that is specified in the user profile under which this thread was initially running is used.

See Also:
STATUS_MESSAGE_HANDLING, Constant Field Values

STATUS_MESSAGE_HANDLING_NONE

public static final String STATUS_MESSAGE_HANDLING_NONE
Constant indicating that this job does not display status messages.

See Also:
STATUS_MESSAGE_HANDLING, Constant Field Values

STATUS_MESSAGE_HANDLING_NORMAL

public static final String STATUS_MESSAGE_HANDLING_NORMAL
Constant indicating that this job displays status messages.

See Also:
STATUS_MESSAGE_HANDLING, Constant Field Values

SUBMITTED_BY_JOB_NAME

public static final int SUBMITTED_BY_JOB_NAME
Job attribute representing the job name of the submitter's job. If the job has no submitter, this value is blank.

Read-only: true

Type: String

See Also:
Constant Field Values

SUBMITTED_BY_USER

public static final int SUBMITTED_BY_USER
Job attribute representing the user name of the submitter. If the job has no submitter, this value is blank.

Read-only: true

Type: String

Can be loaded by JobList: false

See Also:
Constant Field Values

SUBMITTED_BY_JOB_NUMBER

public static final int SUBMITTED_BY_JOB_NUMBER
Job attribute representing the job number of the submitter's job. If the job has no submitter, this value is blank.

Read-only: true

Type: String

Can be loaded by JobList: false

See Also:
Constant Field Values

SUBSYSTEM

public static final int SUBSYSTEM
Job attribute representing the subsystem description in which an active job is running. This value is only for jobs whose status is *ACTIVE. For jobs with status of *OUTQ or *JOBQ, this value is blank.

Read-only: true

Type: String

See Also:
getSubsystem(), Constant Field Values

SYSTEM_POOL_ID

public static final int SYSTEM_POOL_ID
Job attribute representing the identifier of the system-related pool from which the job's main storage is allocated. These identifiers are not the same as those specified in the subsystem description, but are the same as the system pool identifiers shown on the system status display. This is the pool that the threads in the job start in. Also see the CURRENT_SYSTEM_POOL_ID for more information.

Read-only: true

Type: Integer

See Also:
CURRENT_SYSTEM_POOL_ID, getPoolIdentifier(), Constant Field Values

SYSTEM_LIBRARY_LIST

public static final int SYSTEM_LIBRARY_LIST
Job attribute representing the system portion of the library list of the initial thread of the job.

Read-only: true

Type: String

Can be loaded by JobList: false

See Also:
getNumberOfLibrariesInSYSLIBL(), getSystemLibraryList(), Constant Field Values

TEMP_STORAGE_USED

public static final int TEMP_STORAGE_USED
Job attribute representing the amount of auxiliary storage (in kilobytes) that is currently allocated to this job. This value will reach a maximum of 2,147,483,647 kilobytes. If the actual temporary storage used is larger than that value, this attribute will return 2,147,483,647 kilobytes. It is recomended that the TEMP_STORAGE_USED_LARGE attribute be used to get over the limit.

Read-only: true

Type: Integer

See Also:
Constant Field Values

TEMP_STORAGE_USED_LARGE

public static final int TEMP_STORAGE_USED_LARGE
Job attribute representing the amount of auxiliary storage (in megabytes) that is currently allocated to this job.

Read-only: true

Type: Long

See Also:
Constant Field Values

THREAD_COUNT

public static final int THREAD_COUNT
Job attribute representing the count of the current number of active threads in the process at the time of the materialization. An active thread may be either actively running, suspended, or waiting for a resource.

Read-only: true

Type: Integer

See Also:
Constant Field Values

TIME_SEPARATOR

public static final int TIME_SEPARATOR
Job attribute representing the value used to separate hours, minutes, and seconds when presenting a time. Possible values are:

Type: String

See Also:
getTimeSeparator(), setTimeSeparator(java.lang.String), Constant Field Values

TIME_SEPARATOR_SYSTEM_VALUE

public static final String TIME_SEPARATOR_SYSTEM_VALUE
Constant indicating the time separator specified in the system value QTIMSEP is used.

See Also:
TIME_SEPARATOR, Constant Field Values

TIME_SEPARATOR_COLON

public static final String TIME_SEPARATOR_COLON
Constant indicating a colon (:) is used for the time separator.

See Also:
TIME_SEPARATOR, Constant Field Values

TIME_SEPARATOR_PERIOD

public static final String TIME_SEPARATOR_PERIOD
Constant indicating a period (.) is used for the time separator.

See Also:
TIME_SEPARATOR, Constant Field Values

TIME_SEPARATOR_BLANK

public static final String TIME_SEPARATOR_BLANK
Constant indicating a blank is used for the time separator.

See Also:
TIME_SEPARATOR, Constant Field Values

TIME_SEPARATOR_COMMA

public static final String TIME_SEPARATOR_COMMA
Constant indicating a comma (,) is used for the time separator.

See Also:
TIME_SEPARATOR, Constant Field Values

TIME_SLICE

public static final int TIME_SLICE
Job attribute representing 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. The time slice establishes the amount of time needed by a thread in this job to accomplish a meaningful amount of processing. At the end of the time slice, the thread might be put in an inactive state so that other threads can become active in the storage pool. If the job consists of multiple routing steps, a change to this attribute during a routing step does not apply to subsequent routing steps. Values retrieved range from 8 through 9,999,999 milliseconds (that is, 9999.999 seconds). Although you can specify a value of less than 8, the system takes a minimum of 8 milliseconds to run a process.

Type: Integer

See Also:
getTimeSlice(), setTimeSlice(int), Constant Field Values

TIME_SLICE_END_POOL

public static final int TIME_SLICE_END_POOL
Job attribute representing whether a thread in an interactive job moves to another main storage pool at the end of its time slice. Possible values are:

Type: String

See Also:
getTimeSliceEndPool(), setTimeSliceEndPool(java.lang.String), Constant Field Values

TIME_SLICE_END_POOL_SYSTEM_VALUE

public static final String TIME_SLICE_END_POOL_SYSTEM_VALUE
Constant indicating the value in the system value QTSEPPOOL is used.

See Also:
TIME_SLICE_END_POOL, Constant Field Values

TIME_SLICE_END_POOL_NONE

public static final String TIME_SLICE_END_POOL_NONE
Constant indicating that a thread in the job does not move to another main storage pool when it reaches the end of its time slice.

See Also:
TIME_SLICE_END_POOL, Constant Field Values

TIME_SLICE_END_POOL_BASE

public static final String TIME_SLICE_END_POOL_BASE
Constant indicating that a thread in the job moves to the base pool when it reaches the end of its time slice.

See Also:
TIME_SLICE_END_POOL, Constant Field Values

TOTAL_RESPONSE_TIME

public static final int TOTAL_RESPONSE_TIME
Job attribute representing the total amount of response time for the initial thread, in milliseconds. This value does not include the time used by the machine, by the attached input/output (I/O) hardware, and by the transmission lines for sending and receiving data. This value is zero for jobs that have no interactions. A value of -1 is returned if this field is not large enough to hold the actual result.

Read-only: true

Type: Integer

See Also:
getTotalResponseTime(), Constant Field Values

UNIT_OF_WORK_ID

public static final int UNIT_OF_WORK_ID
Job attribute representing the unit of work ID 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 ID. The unit-of-work identifier is made up of:
  1. LOCATION_NAME
  2. NETWORK_ID
  3. INSTANCE
  4. SEQUENCE_NUMBER

Read-only: true

Type: String

See Also:
getWorkIDUnit(), Constant Field Values

LOCATION_NAME

public static final int LOCATION_NAME
Job attribute representing the location name portion of the unit of work ID. This portion of the unit-of-work identifier is the name of the source system that originated the APPC job.

Read-only: true

Type: String

See Also:
UNIT_OF_WORK_ID, getWorkIDUnit(), Constant Field Values

NETWORK_ID

public static final int NETWORK_ID
Job attribute representing the network ID portion of the unit of work ID. This portion of the unit-of-work identifier is the network name associated with the unit of work.

Read-only: true

Type: String

See Also:
UNIT_OF_WORK_ID, getWorkIDUnit(), Constant Field Values

INSTANCE

public static final int INSTANCE
Job attribute representing the instance portion of the unit of work ID. This portion of the unit-of-work identifier is the value that further identifies the source of the job. This is shown as hexadecimal data.

Read-only: true

Type: String

See Also:
UNIT_OF_WORK_ID, getWorkIDUnit(), Constant Field Values

SEQUENCE_NUMBER

public static final int SEQUENCE_NUMBER
Job attribute representing the sequence number portion of the unit of work ID. This portion of the unit-of-work identifier is a value that identifies a checkpoint within the application program.

Read-only: true

Type: String

See Also:
UNIT_OF_WORK_ID, getWorkIDUnit(), Constant Field Values

USER_LIBRARY_LIST

public static final int USER_LIBRARY_LIST
Job attribute representing the user portion of the library list for the initial thread of the job.

Read-only: true

Type: String

Can be loaded by JobList: false

See Also:
getNumberOfLibrariesInUSRLIBL(), getUserLibraryList(), Constant Field Values

USER_NAME

public static final int USER_NAME
Job attribute representing the user name of the job, which is the same as the name of the user profile under which the job was started. It can come from several different sources, depending on the type of job. This may be different than the user profile under which the job is currently running. See the CURRENT_USER attribute for more information. Possible values are:

Type: String

See Also:
CURRENT_USER, getUser(), setUser(java.lang.String), Constant Field Values

USER_NAME_BLANK

public static final String USER_NAME_BLANK
Constant indicating a blank user name. This must be used when JOB_NAME_INTERNAL or JOB_NAME_CURRENT is specified for the JOB_NAME.

See Also:
USER_NAME, Constant Field Values

USER_RETURN_CODE

public static final int USER_RETURN_CODE
Job attribute representing the user-defined return code set by ILE high-level language constructs. An example is the program return code in the C language. This field is scoped to the job and represents the most recent return code set by any thread within the job.

Read-only: true

Type: Integer

See Also:
Constant Field Values
Constructor Detail

Job

public Job()
Constructs a Job object. The system and basic job information must be set before connecting to the system.

See Also:
setName(java.lang.String), setNumber(java.lang.String), setSystem(com.ibm.as400.access.AS400), setUser(java.lang.String)

Job

public Job(AS400 system)
Constructs a Job object. The job name, user name, and job number of the job that this program is running in will be used. Typically, that will be the job information for the remote command host server job associated with the specified system object.

Parameters:
system - The system object representing the system on which the job exists.
See Also:
setName(java.lang.String), setNumber(java.lang.String), setUser(java.lang.String)

Job

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

Parameters:
system - The system object representing the system on which the job exists.
jobName - The job name. Specify JOB_NAME_CURRENT to indicate the job that this program is running in.
userName - The user name. This must be USER_NAME_BLANK if the job name is JOB_NAME_CURRENT.
jobNumber - The job number. This must be JOB_NUMBER_BLANK if job name is JOB_NAME_CURRENT.

Job

public Job(AS400 system,
           String internalJobID)
Deprecated. Use Job(AS400,byte[]) instead. The internal job ID should be treated as a byte array of 16 bytes.

Constructs a Job object. This sets the job name to JOB_NAME_INTERNAL, the user name to USER_NAME_BLANK, and the job number to JOB_NUMBER_BLANK.

Parameters:
system - The system object representing the system on which the job exists.
internalJobID - The internal job identifier.

Job

public Job(AS400 system,
           byte[] internalJobID)
Constructs a Job object. This sets the job name to JOB_NAME_INTERNAL, the user name to USER_NAME_BLANK, and the job number to JOB_NUMBER_BLANK.

Parameters:
system - The system.
internalJobID - The 16-byte internal job identifier.
Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(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.
See Also:
removePropertyChangeListener(java.beans.PropertyChangeListener)

addVetoableChangeListener

public void addVetoableChangeListener(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.
See Also:
removeVetoableChangeListener(java.beans.VetoableChangeListener)

commitChanges

public void commitChanges()
                   throws AS400SecurityException,
                          ErrorCompletingRequestException,
                          InterruptedException,
                          IOException,
                          ObjectDoesNotExistException
Commits all uncommitted attribute changes. Calling this method will set all uncommitted attribute changes to the job on the system.
Note: To commit the changes, the Toolbox by default calls system API (QWTCHGJB) off-thread, that is, via the Remote Command Host Server.

Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
commitChanges(boolean)

commitChanges

public void commitChanges(boolean callOnThread)
                   throws AS400SecurityException,
                          ErrorCompletingRequestException,
                          InterruptedException,
                          IOException,
                          ObjectDoesNotExistException
Commits all uncommitted attribute changes. Calling this method will set all uncommitted attribute changes to the job on the system.
When running on an IBM i system: If callOnThread is true, then the system API (QWTCHGJB) will be called on-thread, that is, in the same thread as the JVM. If callOnThread is false, then the system API will be called off-thread, that is, in the thread of the Remote Command Host Server job.
Caution: The QWTCHGJB API is specified as "conditionally threadsafe". Please refer to the IBM i Programmer's Guide for details on the threadsafety of specific attribute changes. Note that this method specifies format name JOBC0100 when calling QWTCHGJB.
Note: This method behaves identically to commitChanges() if the Java application is running remotely, that is, is not running "natively" on an IBM i system. When running remotely, the Toolbox submits all program calls through the Remote Command Host Server.

Parameters:
callOnThread - Whether to call the system API on-thread or off-thread.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.

end

public void end(int delay)
         throws AS400SecurityException,
                ErrorCompletingRequestException,
                InterruptedException,
                IOException,
                ObjectDoesNotExistException
Ends this job. To end the job controlled, specify -1 for the delay. To end the job immediately, specify 0 for the delay. Specify any other amount of delay time (in seconds) allowed for the job to cleanup.

Parameters:
delay - The delay time in seconds.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
hold(boolean), release()

getAuxiliaryIORequests

public int getAuxiliaryIORequests()
                           throws AS400SecurityException,
                                  ErrorCompletingRequestException,
                                  InterruptedException,
                                  IOException,
                                  ObjectDoesNotExistException
Returns the number of auxiliary I/O requests performed by the job across all routing steps. This includes both database and nondatabase paging. If the number of auxiliary I/O requests is greater than or equal to 2,147,483,647, a value of -1 is returned. Use the AUXILIARY_IO_REQUESTS_LARGE attribute to retrieve values that are greater than or equal to 2,147,483,647.

Returns:
The number of auxiliary I/O requests performed by the job across all routing steps.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
AUXILIARY_IO_REQUESTS

getBreakMessageHandling

public String getBreakMessageHandling()
                               throws AS400SecurityException,
                                      ErrorCompletingRequestException,
                                      InterruptedException,
                                      IOException,
                                      ObjectDoesNotExistException
Returns a value which represents how this job handles break messages.

Returns:
How this job handles break messages. Possible values are:
  • BREAK_MESSAGE_HANDLING_NORMAL - The message queue status determines break message handling.
  • BREAK_MESSAGE_HANDLING_HOLD - The message queue holds break messages until a user or program requests them. The work station user uses the Display Message (DPSMSG) command to display the messages; a program must issue a Receive Message (RCVMSG) command to receive a message and handle it.
  • BREAK_MESSAGE_HANDLING_NOTIFY - The system notifies the job's message queue when a message arrives. For interactive jobs, the audible alarm sounds if there is one, and the message-waiting light comes on.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
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. The default is true.
See Also:
commitChanges(), getValue(int), setCacheChanges(boolean), setValue(int, java.lang.Object)

getCallStack

public CallStackEntry[] getCallStack(long threadID)
                              throws AS400SecurityException,
                                     ErrorCompletingRequestException,
                                     InterruptedException,
                                     IOException,
                                     ObjectDoesNotExistException
Returns the call stack for the specified thread in this job. This method does not cache any information and always retrieves its data from the system every time it is called.

Parameters:
threadID - The thread identifier, or Job.INITIAL_THREAD for the initial thread of this job.
Returns:
The array of call stack entries in this job's call stack. The element at index 0 is the oldest entry in the stack, and the last element in the array is the newest, or highest, entry in the stack.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.

getCodedCharacterSetID

public int getCodedCharacterSetID()
                           throws AS400SecurityException,
                                  ErrorCompletingRequestException,
                                  InterruptedException,
                                  IOException,
                                  ObjectDoesNotExistException
Returns the coded character set identifier (CCSID) used for this job.

Returns:
The coded character set identifier (CCSID) used for this job.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
CCSID

getCompletionStatus

public String getCompletionStatus()
                           throws AS400SecurityException,
                                  ErrorCompletingRequestException,
                                  InterruptedException,
                                  IOException,
                                  ObjectDoesNotExistException
Returns the completion status of the job.

Returns:
The completion status of the job. Possible values are:
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed, or if the job can no longer be found (AS400Exception)..
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
COMPLETION_STATUS

getCountryID

public String getCountryID()
                    throws AS400SecurityException,
                           ErrorCompletingRequestException,
                           InterruptedException,
                           IOException,
                           ObjectDoesNotExistException
Returns the country or region identifier associated with this job.

Returns:
The country or region identifier associated with this job.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
COUNTRY_ID

getCPUUsed

public int getCPUUsed()
               throws AS400SecurityException,
                      ErrorCompletingRequestException,
                      InterruptedException,
                      IOException,
                      ObjectDoesNotExistException
Returns the amount of processing unit time (in milliseconds) that the job used. If the processing unit time used is greater than or equal to 2,147,483,647 milliseconds, a value of -1 is returned. Use the CPU_TIME_USED_LARGE attribute to retrieve values that are greater than or equal to 2,147,483,647.

Returns:
The amount of processing unit time (in milliseconds) that the job used.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
CPU_TIME_USED

getCurrentLibrary

public String getCurrentLibrary()
                         throws AS400SecurityException,
                                ErrorCompletingRequestException,
                                InterruptedException,
                                IOException,
                                ObjectDoesNotExistException
Returns the name of the current library for the initial thread of the job. If no current library exists, the CURRENT_LIBRARY_EXISTENCE attribute returns 0 and this attribute returns an empty string ("").

Returns:
The name of the current library for the initial thread of the job.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
CURRENT_LIBRARY

getCurrentLibraryExistence

public boolean getCurrentLibraryExistence()
                                   throws AS400SecurityException,
                                          ErrorCompletingRequestException,
                                          InterruptedException,
                                          IOException,
                                          ObjectDoesNotExistException
Indicates if a current library exists.

Returns:
true if a current library exists, false otherwise.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
CURRENT_LIBRARY_EXISTENCE

getDate

public Date getDate()
             throws AS400SecurityException,
                    ErrorCompletingRequestException,
                    InterruptedException,
                    IOException,
                    ObjectDoesNotExistException
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:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
DATE_ENTERED_SYSTEM

getDateFormat

public String getDateFormat()
                     throws AS400SecurityException,
                            ErrorCompletingRequestException,
                            InterruptedException,
                            IOException,
                            ObjectDoesNotExistException
Returns the format in which dates are presented.

Returns:
The format in which dates are presented. Possible values are:
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
DATE_FORMAT

getDateSeparator

public String getDateSeparator()
                        throws AS400SecurityException,
                               ErrorCompletingRequestException,
                               InterruptedException,
                               IOException,
                               ObjectDoesNotExistException
Returns the value used to separate days, months, and years when presenting a date.

Returns:
The value used to separate days, months, and years when presenting a date. Possible values are:
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
DATE_SEPARATOR

getDDMConversationHandling

public String getDDMConversationHandling()
                                  throws AS400SecurityException,
                                         ErrorCompletingRequestException,
                                         InterruptedException,
                                         IOException,
                                         ObjectDoesNotExistException
Returns whether connections using distributed data management (DDM) protocols remain active when they are not being used. The connections include APPC conversations, active TCP/IP connections, or Opti-Connect connections. The DDM protocols are used in Distributed Relational Database Architecture (DRDA) applications, DDM applications, or DB2 Multisystem applications.

Returns:
Whether connections using distributed data management (DDM) protocols remain active when they are not being used. Possible values are:
  • KEEP_DDM_CONNECTIONS_ACTIVE_KEEP - The system keeps DDM connections active when there are no users, except for the following:
    • The routing step ends on the source system. The routing step ends when the job ends or when the job is rerouted to another routing step.
    • The Reclaim Distributed Data Management Conversation (RCLDDMCNV) command or the Reclaim Resources (RCLRSC) command runs.
    • A communications failure or an internal failure occurs.
    • A DRDA connection to an application server not running on an IBM i system ends.
  • KEEP_DDM_CONNECTIONS_ACTIVE_DROP - The system ends a DDM connection when there are no users. Examples include when an application closes a DDM file, or when a DRDA application runs an SQL DISCONNECT statement.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
KEEP_DDM_CONNECTIONS_ACTIVE

getDecimalFormat

public String getDecimalFormat()
                        throws AS400SecurityException,
                               ErrorCompletingRequestException,
                               InterruptedException,
                               IOException,
                               ObjectDoesNotExistException
Returns the decimal format used for this job.

Returns:
The decimal format used for this job. Possible values are:
  • 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.
  • 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.
  • 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 position (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 (0,04). This constant also overrides any edit codes that might suppress the leading zero.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
DECIMAL_FORMAT

getDefaultCodedCharacterSetIdentifier

public int getDefaultCodedCharacterSetIdentifier()
                                          throws AS400SecurityException,
                                                 ErrorCompletingRequestException,
                                                 InterruptedException,
                                                 IOException,
                                                 ObjectDoesNotExistException
Returns the default coded character set identifier (CCSID) used for this job.

Returns:
The default coded character set identifier (CCSID) used for this job. The value will be 0 if the job is not active.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
DEFAULT_CCSID

getDefaultWait

public int getDefaultWait()
                   throws AS400SecurityException,
                          ErrorCompletingRequestException,
                          InterruptedException,
                          IOException,
                          ObjectDoesNotExistException
Returns the default maximum time (in seconds) that a thread in the job waits for a system instruction, such as a LOCK machine interface (MI) instruction, to acquire a resource. This default wait time is used when a wait time is not otherwise specified for a given situation. Normally, this is the amount of time the user is willing to wait for the system before the request is ended. If the job consists of multiple routing steps, a change to this attribute during a routing step does not appy to subsequent routing steps. The valid range is 1 through 9999999. A value of -1 represents no maximum wait time (*NOMAX).

Returns:
The default maximum time (in seconds) that a thread in the job waits for a system instruction to acquire a resource. The value -1 means there is no maximum (*NOMAX).
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
DEFAULT_WAIT_TIME

getDeviceRecoveryAction

public String getDeviceRecoveryAction()
                               throws AS400SecurityException,
                                      ErrorCompletingRequestException,
                                      InterruptedException,
                                      IOException,
                                      ObjectDoesNotExistException
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:
  • DEVICE_RECOVERY_ACTION_MESSAGE - Signals the I/O error message to the application and lets the application program perform error recovery.
  • 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 work station device has recovered.
  • 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.
  • 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.
  • 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:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
DEVICE_RECOVERY_ACTION

getEndSeverity

public int getEndSeverity()
                   throws AS400SecurityException,
                          ErrorCompletingRequestException,
                          InterruptedException,
                          IOException,
                          ObjectDoesNotExistException
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:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
END_SEVERITY

getFunctionName

public String getFunctionName()
                       throws AS400SecurityException,
                              ErrorCompletingRequestException,
                              InterruptedException,
                              IOException,
                              ObjectDoesNotExistException
Returns additional information (as described by the FUNCTION_TYPE attribute) about the last high-level function initiated by the initial thread.

Returns:
The additional information (as described by the FUNCTION_TYPE attribute) about the last high-level function initiated by the initial thread.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
FUNCTION_NAME

getFunctionType

public String getFunctionType()
                       throws AS400SecurityException,
                              ErrorCompletingRequestException,
                              InterruptedException,
                              IOException,
                              ObjectDoesNotExistException
Returns the last high-level function initiated by the initial thread. This field may not be cleared when a function is completed.

Returns:
The last high-level function initiated by the initial thread. Possible values are:
  • FUNCTION_TYPE_BLANK - The system is not performing a logged function.
  • FUNCTION_TYPE_COMMAND - A command is running interactively, or it is in a batch input stream, or it was requested from a system menu. Commands in CL programs or REXX procedures are not logged. The FUNCTION_NAME attribute contains the name of the command and is only updated when a command is processed.
  • FUNCTION_TYPE_DELAY - The initial thread of the job is processing a Delay Job (DLYJOB) command. The FUNCTION_NAME attribute contains the number of seconds the job is delayed (up to 999999 seconds), or the time when the job is to resume processing (HH:MM:SS), depending on how you specified the command.
  • FUNCTION_TYPE_GROUP - The Transfer Group Job (TFRGRPJOB) command suspended the job. The FUNCTION_NAME attribute contains the group job name for that job.
  • FUNCTION_TYPE_INDEX - The initial thread of the job is rebuilding an index (access path). The FUNCTION_NAME attribute contains the name of the logical file whose index is rebuilt.
  • FUNCTION_TYPE_JAVA - The initial thread of the job is running a Java Vertual Machine (JVM). The FUNCTION_NAME attribute contains the name of the java class.
  • FUNCTION_TYPE_LOG - The system logs history information in a database file. The FUNCTION_NAME attribute contains the name of the log (QHST is the only log currently supported).
  • FUNCTION_TYPE_MRT - The job is a multiple requester terminal (MRT) job if the JOB_TYPE is JOB_TYPE_BATCH and the JOB_SUBTYPE is JOB_SUBTYPE_MRT, or it is an interactive job attached to an MRT job if the JOB_TYPE is JOB_TYPE_INTERACTIVE.

    For MRT jobs, the FUNCTION_NAME attribute contains information in the following format:

    • CHAR(2): The number of requesters currently attached to the MRT job.
    • CHAR(1): The field is reserved for a / (slash).
    • CHAR(2): The maximum number (MRTMAX) of requesters.
    • CHAR(1): Reserved.
    • CHAR(3): The never-ending program (NEP) indicator. If an MRT is also an NEP, the MRT stays active even if there are no requesters of the MRT. A value of NEP indicates a never-ending program. A value of blanks indicates that it is not a never-ending program.
    • CHAR(1): Reserved.

    For interactive jobs attached to an MRT, the FUNCTION_NAME attribute contains the name of the MRT procedure.

  • FUNCTION_TYPE_MENU - The initial thread of the job is currently at a system menu. The FUNCTION_NAME field contains the name of the menu.
  • FUNCTION_TYPE_IO - The job is a subsystem monitor that is performing input/output (I/O) operations to a work station. The FUNCTION_NAME attribute contains the name of the work station device to which the subsystem is performing an input/output operation.
  • FUNCTION_TYPE_PROCEDURE - The initial thread of the job is running a procedure. The FUNCTION_NAME attribute contains the name of the procedure.
  • FUNCTION_TYPE_PROGRAM - The initial thread of the job is running a program. The FUNCTION_NAME attribute contains the name of the program.
  • FUNCTION_TYPE_SPECIAL - The function type is a special function. For this value, the FUNCTION_NAME attribute contains one of the following values:
    • ADLACTJOB: Auxiliary storage is being allocated for the number of active jobs specified in the QADLACTJ system value. This may indicate that the system value for the initial number of active jobs is too low.
    • ADLTOTJOB: Auxiliary storage is being allocated for the number of jobs specified in the QADLTOTJ system value.
    • CMDENT: The Command Entry display is being used.
    • COMMIT: A commit operation is being performed.
    • DIRSHD: Directory shadowing.
    • DLTSPLF: The system is deleting a spooled file.
    • DUMP: A dump is in process.
    • JOBIDXRCY: A damaged job index is being recovered.
    • JOBLOG: The system is producing a job log.
    • PASSTHRU: The job is a pass-through job.
    • RCLSPLSTG: Empty spooled database members are being deleted.
    • ROLLBACK: A rollback operation is being performed.
    • SPLCLNUP: Spool cleanup is in process.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
FUNCTION_TYPE

getInquiryMessageReply

public String getInquiryMessageReply()
                              throws AS400SecurityException,
                                     ErrorCompletingRequestException,
                                     InterruptedException,
                                     IOException,
                                     ObjectDoesNotExistException
Returns how the job answers inquiry messages.

Returns:
How the job answers inquiry messages. Possible values are:
  • INQUIRY_MESSAGE_REPLY_REQUIRED - The job requires an answer for any inquiry messages that occur while this job is running.
  • 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.
  • 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:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
INQUIRY_MESSAGE_REPLY

getInteractiveTransactions

public int getInteractiveTransactions()
                               throws AS400SecurityException,
                                      ErrorCompletingRequestException,
                                      InterruptedException,
                                      IOException,
                                      ObjectDoesNotExistException
Returns the count of operator interactions, such as pressing the Enter key or a function key. This field is zero for jobs that have no interactions.

Returns:
The count of operator interactions, such as pressing the Enter key or a function key. This field is zero for jobs that have no interactions.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
INTERACTIVE_TRANSACTIONS

getInternalJobID

public String getInternalJobID()
Deprecated. Use getInternalJobIdentifier() instead. The internal job identifier should be treated as a byte array of 16 bytes.

Returns the internal job identifier. The internal job identifier is a value input to other APIs to increase the speed of locating the job on the system. The identifier is not valid following an initial program load (IPL). If you attempt to use it after an IPL, an exception occurs.

Returns:
The internal job identifier.

getInternalJobIdentifier

public byte[] getInternalJobIdentifier()
Returns the internal job identifier. The internal job identifier is a value input to other APIs to increase the speed of locating the job on the system. The identifier is not valid following an initial program load (IPL). If you attempt to use it after an IPL, an exception occurs.

Returns:
The 16-byte internal job identifier, or null if one has not been set or retrieved from the system.
See Also:
setInternalJobIdentifier(byte[])

getJobAccountingCode

public String getJobAccountingCode()
                            throws AS400SecurityException,
                                   ErrorCompletingRequestException,
                                   InterruptedException,
                                   IOException,
                                   ObjectDoesNotExistException
Returns an identifier assigned to the job by the system to collect resource use information for the job when job accounting is active.

Returns:
An identifier assigned to the job by the system to collect resource use information for the job when job accounting is active.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
ACCOUNTING_CODE

getJobActiveDate

public Date getJobActiveDate()
                      throws AS400SecurityException,
                             ErrorCompletingRequestException,
                             InterruptedException,
                             IOException,
                             ObjectDoesNotExistException
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:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
DATE_STARTED

getJobDate

public Date getJobDate()
                throws AS400SecurityException,
                       ErrorCompletingRequestException,
                       InterruptedException,
                       IOException,
                       ObjectDoesNotExistException
Returns the date to be used for the job. This value is for jobs whose status is *JOBQ or *ACTIVE. For jobs with a status of *OUTQ, the value for this field is blank.

Returns:
The date to be used for the job.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
JOB_DATE

getJobDescription

public String getJobDescription()
                         throws AS400SecurityException,
                                ErrorCompletingRequestException,
                                InterruptedException,
                                IOException,
                                ObjectDoesNotExistException
Returns the fully qualified integrated file system path name for the job description. The job description is a set of job-related attributes used for one or more jobs on the system. These attributes determine how the job is run on the system. Multiple jobs can also use the same job description.

Returns:
The fully qualified integrated file system path name for the job description.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
JOB_DESCRIPTION, QSYSObjectPathName

getJobEndedDate

public Date getJobEndedDate()
                     throws AS400SecurityException,
                            ErrorCompletingRequestException,
                            InterruptedException,
                            IOException,
                            ObjectDoesNotExistException
Returns the date and time when the job completed running on the system.

Returns:
The date and time when the job completed running on the system.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
DATE_ENDED

getJobEnterSystemDate

public Date getJobEnterSystemDate()
                           throws AS400SecurityException,
                                  ErrorCompletingRequestException,
                                  InterruptedException,
                                  IOException,
                                  ObjectDoesNotExistException
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:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
DATE_ENTERED_SYSTEM

getJobLog

public JobLog getJobLog()
Returns the job log.

Returns:
The job log.

getJobMessageQueueFullAction

public String getJobMessageQueueFullAction()
                                    throws AS400SecurityException,
                                           ErrorCompletingRequestException,
                                           InterruptedException,
                                           IOException,
                                           ObjectDoesNotExistException
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:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
MESSAGE_QUEUE_ACTION

getJobMessageQueueMaximumSize

public int getJobMessageQueueMaximumSize()
                                  throws AS400SecurityException,
                                         ErrorCompletingRequestException,
                                         InterruptedException,
                                         IOException,
                                         ObjectDoesNotExistException
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 to 64.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
MESSAGE_QUEUE_MAX_SIZE

getJobPutOnJobQueueDate

public Date getJobPutOnJobQueueDate()
                             throws AS400SecurityException,
                                    ErrorCompletingRequestException,
                                    InterruptedException,
                                    IOException,
                                    ObjectDoesNotExistException
Returns the date and time this job was put on this job queue. This field will contain blanks if the job was not on a job queue.

Returns:
The date and time this job was put on this job queue.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
JOB_QUEUE_DATE

getScheduleDate

public Date getScheduleDate()
                     throws AS400SecurityException,
                            ErrorCompletingRequestException,
                            InterruptedException,
                            IOException,
                            ObjectDoesNotExistException
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:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
SCHEDULE_DATE

getJobStatusInJobQueue

public String getJobStatusInJobQueue()
                              throws AS400SecurityException,
                                     ErrorCompletingRequestException,
                                     InterruptedException,
                                     IOException,
                                     ObjectDoesNotExistException
Returns the status of this job on the job queue.

Returns:
The status of this job on the job queue. Possible values are:
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
JOB_QUEUE_STATUS

getJobSwitches

public String getJobSwitches()
                      throws AS400SecurityException,
                             ErrorCompletingRequestException,
                             InterruptedException,
                             IOException,
                             ObjectDoesNotExistException
Returns the current setting of the job switches used by this job. This value is returned for all job types.

Returns:
The current setting of the job switches used by this job.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
JOB_SWITCHES

getLanguageID

public String getLanguageID()
                     throws AS400SecurityException,
                            ErrorCompletingRequestException,
                            InterruptedException,
                            IOException,
                            ObjectDoesNotExistException
Returns the language identifier associated with this job. The language identifier is used when *LANGIDUNQ or *LANGIDSHR is specified on the sort sequence parameter. If the job CCSID is 65535, this parameter is also used to determine the value of the job default CCSID.

Returns:
The language identifier associated with this job.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
LANGUAGE_ID

getLoggingCLPrograms

public String getLoggingCLPrograms()
                            throws AS400SecurityException,
                                   ErrorCompletingRequestException,
                                   InterruptedException,
                                   IOException,
                                   ObjectDoesNotExistException
Returns a value indicating whether or not commands are logged for CL programs that are run.

Returns:
The value indicating whether or not commands are logged for CL programs that are run. Possible values are:
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
LOG_CL_PROGRAMS

getLoggingLevel

public int getLoggingLevel()
                    throws AS400SecurityException,
                           ErrorCompletingRequestException,
                           InterruptedException,
                           IOException,
                           ObjectDoesNotExistException
Returns what type of information is logged.

Returns:
A value indicating what type of information 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. This includes the indication of job start, job end, and job completion status.
  • 2 - The following information is logged:
    • Logging level 1 information.
    • Request messages that result in a high-level message with a severity code greater than or equal to the logging severity cause the request message and all associated messages to be logged. A high-level message is one that is sent to the program message queue of the program that receives the request message. For example, QCMD is an IBM-supplied request processing program that receives request messages.
  • 3 - The following information is logged:
    • Logging level 1 and 2 information is logged.
    • All request messages are logged.
    • Commands run by a CL program are logged if it is allowed by the LOG_CL_PROGRAMS attribute and the log attribute of the CL program.
  • 4 - The following information is logged:
    • All request messages and all messages with a severity greater than or equal to the message logging severity, including trace messages.
    • Commands run by a CL program are logged if it is allowed by the LOG_CL_PROGRAMS attribute and the log attribute of the CL program.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
LOGGING_LEVEL

getLoggingSeverity

public int getLoggingSeverity()
                       throws AS400SecurityException,
                              ErrorCompletingRequestException,
                              InterruptedException,
                              IOException,
                              ObjectDoesNotExistException
Returns the severity level that is used in conjunction with the logging level to determine which error messages are logged in the job log. The values range from 00 through 99.

Returns:
The severity level that is used in conjunction with the logging level to determine which error messages are logged in the job log.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
LOGGING_SEVERITY

getLoggingText

public String getLoggingText()
                      throws AS400SecurityException,
                             ErrorCompletingRequestException,
                             InterruptedException,
                             IOException,
                             ObjectDoesNotExistException
Returns the level of message text that is written in the job log when a message is logged according to the LOGGING_LEVEL and LOGGING_SEVERITY.

Returns:
The level of message text that is written in the job log when a message is logged according to the LOGGING_LEVEL and LOGGING_SEVERITY. Possible values are:
  • LOGGING_TEXT_MESSAGE - Only the message text is written to the job log.
  • LOGGING_TEXT_SECLVL - Both the message text and the message help (cause and recovery) of the error message are written to the job log.
  • LOGGING_TEXT_NO_LIST - If the job ends normally, no job log is produced. If the job ends abnormally (the job end code is 20 or higher), a job log is produced. The messages that appear in the job log contain both the message text and the message.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
LOGGING_TEXT

getModeName

public String getModeName()
                   throws AS400SecurityException,
                          ErrorCompletingRequestException,
                          InterruptedException,
                          IOException,
                          ObjectDoesNotExistException
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. Possible values are:
  • The mode name is *BLANK.
  • The mode name is blanks.
  • The name of the mode.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
MODE

getName

public String getName()
Returns the job name.

Returns:
The job name.

getNumber

public String getNumber()
Returns the job number.

Returns:
The job number.

getNumberOfLibrariesInSYSLIBL

public int getNumberOfLibrariesInSYSLIBL()
                                  throws AS400SecurityException,
                                         ErrorCompletingRequestException,
                                         InterruptedException,
                                         IOException,
                                         ObjectDoesNotExistException
Returns the number of libraries in the system portion of the library list of the initial thread of the job.

Returns:
The number of libraries in the system portion of the library list of the initial thread of the job.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
SYSTEM_LIBRARY_LIST

getNumberOfLibrariesInUSRLIBL

public int getNumberOfLibrariesInUSRLIBL()
                                  throws AS400SecurityException,
                                         ErrorCompletingRequestException,
                                         InterruptedException,
                                         IOException,
                                         ObjectDoesNotExistException
Returns the number of libraries in the user portion of the library list for the initial thread of the job.

Returns:
The number of libraries in the user portion of the library list for the initial thread of the job.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
USER_LIBRARY_LIST

getNumberOfProductLibraries

public int getNumberOfProductLibraries()
                                throws AS400SecurityException,
                                       ErrorCompletingRequestException,
                                       InterruptedException,
                                       IOException,
                                       ObjectDoesNotExistException
Returns the number of libraries that contain product information for the initial thread of the job.

Returns:
The number of libraries that contain product information for the initial thread of the job.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
PRODUCT_LIBRARIES

getOutputQueue

public String getOutputQueue()
                      throws AS400SecurityException,
                             ErrorCompletingRequestException,
                             InterruptedException,
                             IOException,
                             ObjectDoesNotExistException
Returns the fully qualified integrated file system path name of the default output queue that is used for spooled output produced by this job. The default output queue is only for spooled printer files that specify *JOB for the output queue.

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:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
OUTPUT_QUEUE, QSYSObjectPathName

getOutputQueuePriority

public int getOutputQueuePriority()
                           throws AS400SecurityException,
                                  ErrorCompletingRequestException,
                                  InterruptedException,
                                  IOException,
                                  ObjectDoesNotExistException
Returns the output priority for spooled output files that this job produces. The highest priority is 0, and the lowest is 9.

Returns:
The output priority for spooled output files that this job produces.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
OUTPUT_QUEUE_PRIORITY

getPoolIdentifier

public int getPoolIdentifier()
                      throws AS400SecurityException,
                             ErrorCompletingRequestException,
                             InterruptedException,
                             IOException,
                             ObjectDoesNotExistException
Returns the identifier of the system-related pool from which the job's main storage is allocated. These identifiers are not the same as those specified in the subsystem description, but are the same as the system pool identifiers shown on the system status display. This is the pool that the threads in the job start in. Also see the CURRENT_SYSTEM_POOL_ID for more information.

Returns:
The identifier of the system-related pool from which the job's main storage is allocated.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
SYSTEM_POOL_ID

getPrinterDeviceName

public String getPrinterDeviceName()
                            throws AS400SecurityException,
                                   ErrorCompletingRequestException,
                                   InterruptedException,
                                   IOException,
                                   ObjectDoesNotExistException
Returns the printer device used for printing output from this job.

Returns:
The printer device used for printing output from this job.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
PRINTER_DEVICE_NAME

getPrintKeyFormat

public String getPrintKeyFormat()
                         throws AS400SecurityException,
                                ErrorCompletingRequestException,
                                InterruptedException,
                                IOException,
                                ObjectDoesNotExistException
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. Possible values are:
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
PRINT_KEY_FORMAT

getPrintText

public String getPrintText()
                    throws AS400SecurityException,
                           ErrorCompletingRequestException,
                           InterruptedException,
                           IOException,
                           ObjectDoesNotExistException
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:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
PRINT_TEXT

getProductLibraries

public String[] getProductLibraries()
                             throws AS400SecurityException,
                                    ErrorCompletingRequestException,
                                    InterruptedException,
                                    IOException,
                                    ObjectDoesNotExistException
Returns the libraries that contain product information for the initial thread of the job.

Returns:
The libraries that contain product information for the initial thread of the job.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
PRODUCT_LIBRARIES

getPurge

public boolean getPurge()
                 throws AS400SecurityException,
                        ErrorCompletingRequestException,
                        InterruptedException,
                        IOException,
                        ObjectDoesNotExistException
Indicates whether or not the job is eligible to be moved out of main storage and put into auxiliary storage at the end of a time slice or when entering a long wait (such as waiting for a work station user's response). This attribute is ignored when more than one thread is active within the job. If the job consists of multiple routing steps, a change to this attribute during a routing step does not apply to subsequent routing steps.

Returns:
true if the job is eligible to be moved out of main storage and put into auxiliary storage at the end of a time slice or when entering a long wait; false otherwise.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
ELIGIBLE_FOR_PURGE

getQueue

public String getQueue()
                throws AS400SecurityException,
                       ErrorCompletingRequestException,
                       InterruptedException,
                       IOException,
                       ObjectDoesNotExistException
Returns the fully qualified integrated file system path name of the job queue that the job is currently on, or that the job was on if it is currently active. This value is for jobs whose status is *JOBQ or *ACTIVE. For jobs with a status of *OUTQ, the value for this field is blank.

Returns:
The fully qualified integrated file system path name of the job queue that the job is currently on, or that the job was on if it is currently active.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
JOB_QUEUE, QSYSObjectPathName

getQueuePriority

public int getQueuePriority()
                     throws AS400SecurityException,
                            ErrorCompletingRequestException,
                            InterruptedException,
                            IOException,
                            ObjectDoesNotExistException
Returns the scheduling priority of the job compared to other jobs on the same job queue. The highest priority is 0 and the lowest is 9. This value is valid for jobs whose status is *JOBQ or *ACTIVE. For jobs with a status of *OUTQ, then the priority returned is -1.

Returns:
The scheduling priority of the job compared to other jobs on the same job queue.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
JOB_QUEUE_PRIORITY

getRoutingData

public String getRoutingData()
                      throws AS400SecurityException,
                             ErrorCompletingRequestException,
                             InterruptedException,
                             IOException,
                             ObjectDoesNotExistException
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:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
ROUTING_DATA

getRunPriority

public int getRunPriority()
                   throws AS400SecurityException,
                          ErrorCompletingRequestException,
                          InterruptedException,
                          IOException,
                          ObjectDoesNotExistException
Returns the priority at which the job is currently running, relative to other jobs on the system. The run priority ranges from 0 (highest priority) to 99 (lowest priority).

Returns:
The priority at which the job is currently running, relative to other jobs on the system.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
RUN_PRIORITY

getSignedOnJob

public boolean getSignedOnJob()
                       throws AS400SecurityException,
                              ErrorCompletingRequestException,
                              InterruptedException,
                              IOException,
                              ObjectDoesNotExistException
Indicates whether the job is to be treated like a signed-on user on the system.

Returns:
true if the job should be treateded like a signed-on user; false otherwise.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
SIGNED_ON_JOB

getSortSequenceTable

public String getSortSequenceTable()
                            throws AS400SecurityException,
                                   ErrorCompletingRequestException,
                                   InterruptedException,
                                   IOException,
                                   ObjectDoesNotExistException
Returns the name of the sort sequence table associated with this job.

Returns:
The name of the sort sequence table associated with this job. Possible values are:
  • SORT_SEQUENCE_TABLE_NONE - No sort sequence table is used. The hexadecimal values of the characters are used to determine the sort sequence.
  • SORT_SEQUENCE_TABLE_LANGUAGE_SHARED_WEIGHT - The sort sequence table used can contain the same weight for multiple characters, and it is the shared weight sort table associated with the language specified in the LANGUAGE_ID attribute.
  • SORT_SEQUENCE_TABLE_LANGUAGE_UNIQUE_WEIGHT - The sort sequence table used must contain a unique weight for each character in the code page, and it is the unique weight sort table associated with the language specified in the LANGUAGE_ID parameter.
  • The fully qualified integrated file system path name of the sort sequence table associated with this job.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
SORT_SEQUENCE_TABLE, QSYSObjectPathName

getStatus

public String getStatus()
                 throws AS400SecurityException,
                        ErrorCompletingRequestException,
                        InterruptedException,
                        IOException,
                        ObjectDoesNotExistException
Returns the status of this job.

Returns:
The status of this job. Possible values are:
  • JOB_STATUS_ACTIVE - This job is an active job. This includes group jobs, system request jobs, and disconnected jobs.
  • JOB_STATUS_JOBQ - This job is currently on a job queue.
  • JOB_STATUS_OUTQ - This job has completed running, but still has output on an output queue.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed, or if the job can no longer be found (AS400Exception).
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
JOB_STATUS

getStatusMessageHandling

public String getStatusMessageHandling()
                                throws AS400SecurityException,
                                       ErrorCompletingRequestException,
                                       InterruptedException,
                                       IOException,
                                       ObjectDoesNotExistException
Returns whether status messages are displayed for this job.

Returns:
A value indicating whether status messages are displayed for this job. Possible values are:
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
STATUS_MESSAGE_HANDLING

getStringValue

public String getStringValue(int attribute)
                      throws AS400SecurityException,
                             ErrorCompletingRequestException,
                             InterruptedException,
                             IOException,
                             ObjectDoesNotExistException
Returns the value for the specified job attribute, as a String. This is a generic way of retrieving string-valued job attributes, rather than using the specific getter methods. This method will either go to the system to retrieve the job attribute, or it will return a cached value if the attribute was previously retrieved or previously set by setValue() or one of the other setter methods. Use loadInformation() to refresh the attributes from the system.

Parameters:
attribute - The job attribute.
Returns:
The current value of the attribute, as a blank-trimmed String. This method may return null in the rare case that the specified attribute could not be retrieved using the QUSRJOBI system API. If the attribute value is not of type String, then the result of toString() on the value object is returned.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
loadInformation(), getValue(int), setValue(int, java.lang.Object)

getSubsystem

public String getSubsystem()
                    throws AS400SecurityException,
                           ErrorCompletingRequestException,
                           InterruptedException,
                           IOException,
                           ObjectDoesNotExistException
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:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
SUBSYSTEM, QSYSObjectPathName

getSubtype

public String getSubtype()
                  throws AS400SecurityException,
                         ErrorCompletingRequestException,
                         InterruptedException,
                         IOException,
                         ObjectDoesNotExistException
Returns additional information about the job type (if any exists).

Returns:
Additional information about the job type (if any exists). Possible values are:
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
JOB_SUBTYPE

getSystem

public AS400 getSystem()
Returns the system.

Returns:
The system.

getSystemLibraryList

public String[] getSystemLibraryList()
                              throws AS400SecurityException,
                                     ErrorCompletingRequestException,
                                     InterruptedException,
                                     IOException,
                                     ObjectDoesNotExistException
Returns the system portion of the library list of the initial thread of the job.

Returns:
The system portion of the library list of the initial thread of the job.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
SYSTEM_LIBRARY_LIST

getTimeSeparator

public String getTimeSeparator()
                        throws AS400SecurityException,
                               ErrorCompletingRequestException,
                               InterruptedException,
                               IOException,
                               ObjectDoesNotExistException
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. Possible values are:
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
TIME_SEPARATOR

getTimeSlice

public int getTimeSlice()
                 throws AS400SecurityException,
                        ErrorCompletingRequestException,
                        InterruptedException,
                        IOException,
                        ObjectDoesNotExistException
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. The time slice establishes the amount of time needed by a thread in this job to accomplish a meaningful amount of processing. At the end of the time slice, the thread might be put in an inactive state so that other threads can become active in the storage pool. Values retrieved range from 8 through 9,999,999 milliseconds (that is, 9999.999 seconds). Although you can specify a value of less than 8, the system takes a minimum of 8 milliseconds to run a process.

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:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
TIME_SLICE

getTimeSliceEndPool

public String getTimeSliceEndPool()
                           throws AS400SecurityException,
                                  ErrorCompletingRequestException,
                                  InterruptedException,
                                  IOException,
                                  ObjectDoesNotExistException
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:
  • TIME_SLICE_END_POOL_NONE - A thread in the job does not move to another main storage pool when it reaches the end of its time slice.
  • 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:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
TIME_SLICE_END_POOL

getTotalResponseTime

public int getTotalResponseTime()
                         throws AS400SecurityException,
                                ErrorCompletingRequestException,
                                InterruptedException,
                                IOException,
                                ObjectDoesNotExistException
Returns the total amount of response time for the initial thread, in milliseconds. This value does not include the time used by the machine, by the attached input/output (I/O) hardware, and by the transmission lines for sending and receiving data. This value is zero for jobs that have no interactions. A value of -1 is returned if this field is not large enough to hold the actual result.

Returns:
The total amount of response time for the initial thread, in milliseconds.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
TOTAL_RESPONSE_TIME

getType

public String getType()
               throws AS400SecurityException,
                      ErrorCompletingRequestException,
                      InterruptedException,
                      IOException,
                      ObjectDoesNotExistException
Returns the type of job.

Returns:
The type of job. Possible values are:
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
JOB_TYPE

getUser

public String getUser()
Returns the user name. This method will either return a cached value if the USER_NAME attribute was previously retrieved; or if attributes values have not yet been retrieved, the value previously by either a constructor, setUser(), or one of the other setter methods.

Note: To get the actual current user name for this job (for example, after swapping profiles), call getStringValue(CURRENT_USER)

Returns:
The user name.
See Also:
setUser(java.lang.String)

getUserLibraryList

public String[] getUserLibraryList()
                            throws AS400SecurityException,
                                   ErrorCompletingRequestException,
                                   InterruptedException,
                                   IOException,
                                   ObjectDoesNotExistException
Returns the user portion of the library list for the initial thread of the job.

Returns:
The user portion of the library list for the initial thread of the job.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
USER_LIBRARY_LIST

getValue

public Object getValue(int attribute)
                throws AS400SecurityException,
                       ErrorCompletingRequestException,
                       InterruptedException,
                       IOException,
                       ObjectDoesNotExistException
Returns the value for the specified job attribute. This is a generic way of retrieving job attributes, rather than using the specific getter methods. This method will either go to the system to retrieve the job attribute, or it will return a cached value if the attribute was previously retrieved or previously set by setValue() or one of the other setter methods. Use loadInformation() to refresh the attributes from the system.

Parameters:
attribute - The job attribute.
Returns:
The current value of the attribute. This method may return null in the rare case that the specified attribute could not be retrieved using the QUSRJOBI system API. String values are not trimmed.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
loadInformation(), getStringValue(int), setValue(int, java.lang.Object)

getWorkIDUnit

public String getWorkIDUnit()
                     throws AS400SecurityException,
                            ErrorCompletingRequestException,
                            InterruptedException,
                            IOException,
                            ObjectDoesNotExistException
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:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
LOCATION_NAME, NETWORK_ID, INSTANCE, SEQUENCE_NUMBER

hold

public void hold(boolean holdSpooledFiles)
          throws AS400SecurityException,
                 ErrorCompletingRequestException,
                 InterruptedException,
                 IOException
Holds this job.

Parameters:
holdSpooledFiles - true to hold this job's spooled files; false otherwise.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
See Also:
end(int), release()

loadInformation

public void loadInformation()
Refreshes the values for all attributes. This does not cancel uncommitted changes. To refresh just the elapsed statistics, use loadStatistics().

See Also:
loadInformation(int[]), commitChanges(), loadStatistics()

loadInformation

public void loadInformation(int[] attributes)
Refreshes the values for specific attributes. This does not cancel uncommitted changes.
Note: The specified attributes will be refreshed, along with other attributes in their "format group". For more information about attribute format groups, refer to the specification of the QUSRJOBI API.

Parameters:
attributes - The attributes to refresh.
See Also:
loadInformation(), commitChanges(), loadStatistics()

loadStatistics

public void loadStatistics()
                    throws AS400SecurityException,
                           ErrorCompletingRequestException,
                           InterruptedException,
                           IOException,
                           ObjectDoesNotExistException
Refreshes just the values for the elapsed statistics. Internally, this calls the QUSRJOBI API using the JOBI1000 format.

Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
resetStatistics(), loadInformation(), ELAPSED_TIME, ELAPSED_DISK_IO, ELAPSED_DISK_IO_ASYNCH, ELAPSED_DISK_IO_SYNCH, ELAPSED_INTERACTIVE_RESPONSE_TIME, ELAPSED_INTERACTIVE_TRANSACTIONS, ELAPSED_CPU_PERCENT_USED, ELAPSED_CPU_PERCENT_USED_FOR_DATABASE, ELAPSED_CPU_TIME_USED, ELAPSED_CPU_TIME_USED_FOR_DATABASE, ELAPSED_LOCK_WAIT_TIME, ELAPSED_PAGE_FAULTS

release

public void release()
             throws AS400Exception,
                    AS400SecurityException,
                    ErrorCompletingRequestException,
                    InterruptedException,
                    IOException
Releases this job.

Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
AS400Exception
See Also:
end(int), hold(boolean)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)
Removes a PropertyChangeListener.

Parameters:
listener - The listener.
See Also:
addPropertyChangeListener(java.beans.PropertyChangeListener)

removeVetoableChangeListener

public void removeVetoableChangeListener(VetoableChangeListener listener)
Removes a VetoableChangeListener.

Parameters:
listener - The listener.
See Also:
addVetoableChangeListener(java.beans.VetoableChangeListener)

resetStatistics

public void resetStatistics()
                     throws AS400SecurityException,
                            ErrorCompletingRequestException,
                            InterruptedException,
                            IOException,
                            ObjectDoesNotExistException
Resets the measurement start time used for computing elapsed statistics.

Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
loadStatistics(), ELAPSED_TIME, ELAPSED_DISK_IO, ELAPSED_DISK_IO_ASYNCH, ELAPSED_DISK_IO_SYNCH, ELAPSED_INTERACTIVE_RESPONSE_TIME, ELAPSED_INTERACTIVE_TRANSACTIONS, ELAPSED_CPU_PERCENT_USED, ELAPSED_CPU_PERCENT_USED_FOR_DATABASE, ELAPSED_CPU_TIME_USED, ELAPSED_CPU_TIME_USED_FOR_DATABASE, ELAPSED_LOCK_WAIT_TIME, ELAPSED_PAGE_FAULTS

setBreakMessageHandling

public void setBreakMessageHandling(String breakMessageHandling)
                             throws AS400SecurityException,
                                    ErrorCompletingRequestException,
                                    InterruptedException,
                                    IOException,
                                    ObjectDoesNotExistException
Sets how this job handles break messages.

Parameters:
breakMessageHandling - How this job handles break messages. Possible values are:
  • BREAK_MESSAGE_HANDLING_NORMAL - The message queue status determines break message handling.
  • BREAK_MESSAGE_HANDLING_HOLD - The message queue holds break messages until a user or program requests them. The work station user uses the Display Message (DPSMSG) command to display the messages; a program must issue a Receive Message (RCVMSG) command to receive a message and handle it.
  • BREAK_MESSAGE_HANDLING_NOTIFY - The system notifies the job's message queue when a message arrives. For interactive jobs, the audible alarm sounds if there is one, and the message-waiting light comes on.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
BREAK_MESSAGE_HANDLING

setCacheChanges

public void setCacheChanges(boolean cacheChanges)
Sets the value indicating whether attribute value changes are committed immediately. The default is true. If any cached changes are not committed before this method is called with a value of false, those changes are lost.

Parameters:
cacheChanges - true to cache attribute value changes, false to commit all attribute value changes immediately.
See Also:
commitChanges(), getCacheChanges(), getValue(int), setValue(int, java.lang.Object)

setCodedCharacterSetID

public void setCodedCharacterSetID(int codedCharacterSetID)
                            throws AS400SecurityException,
                                   ErrorCompletingRequestException,
                                   InterruptedException,
                                   IOException,
                                   ObjectDoesNotExistException
Sets the coded character set identifier (CCSID) used for this job.

Parameters:
codedCharacterSetID - The coded character set identifier (CCSID) used for this job. Possible values are:
  • CCSID_SYSTEM_VALUE - The CCSID specified in the system value QCCSID is used.
  • CCSID_INITIAL_USER - The CCSID specified in the user profile under which this thread was initially running is used.
  • A coded character set identifier.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
CCSID

setCountryID

public void setCountryID(String countryID)
                  throws AS400SecurityException,
                         ErrorCompletingRequestException,
                         InterruptedException,
                         IOException,
                         ObjectDoesNotExistException
Sets the country or region identifier associated with this job.

Parameters:
countryID - The country or region identifier associated with this job. Possible values are:
  • COUNTRY_ID_SYSTEM_VALUE - The system value QCNTRYID is used.
  • COUNTRY_ID_INITIAL_USER - The country or region ID specified in the user profile under which this thread was initially running is used.
  • A country or region identifier to be used by the job.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
COUNTRY_ID

setDateFormat

public void setDateFormat(String dateFormat)
                   throws AS400SecurityException,
                          ErrorCompletingRequestException,
                          InterruptedException,
                          IOException,
                          ObjectDoesNotExistException
Sets the format in which dates are presented.

Parameters:
dateFormat - The format in which dates are presented. Possible values are:
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
DATE_FORMAT

setDateSeparator

public void setDateSeparator(String dateSeparator)
                      throws AS400SecurityException,
                             ErrorCompletingRequestException,
                             InterruptedException,
                             IOException,
                             ObjectDoesNotExistException
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. Possible values are:
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
DATE_SEPARATOR

setDDMConversationHandling

public void setDDMConversationHandling(String ddmConversationHandling)
                                throws AS400SecurityException,
                                       ErrorCompletingRequestException,
                                       InterruptedException,
                                       IOException,
                                       ObjectDoesNotExistException
Sets whether connections using distributed data management (DDM) protocols remain active when they are not being used. The connections include APPC conversations, active TCP/IP connections, or Opti-Connect connections. The DDM protocols are used in Distributed Relational Database Architecture (DRDA) applications, DDM applications, or DB2 Multisystem applications.

Parameters:
ddmConversationHandling - Whether connections using distributed data management (DDM) protocols remain active when they are not being used. Possible values are:
  • KEEP_DDM_CONNECTIONS_ACTIVE_KEEP - The system keeps DDM connections active when there are no users, except for the following:
    • The routing step ends on the source system. The routing step ends when the job ends or when the job is rerouted to another routing step.
    • The Reclaim Distributed Data Management Conversation (RCLDDMCNV) command or the Reclaim Resources (RCLRSC) command runs.
    • A communications failure or an internal failure occurs.
    • A DRDA connection to an application server not running on an IBM i system ends.
  • KEEP_DDM_CONNECTIONS_ACTIVE_DROP - The system ends a DDM connection when there are no users. Examples include when an application closes a DDM file, or when a DRDA application runs an SQL DISCONNECT statement.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
KEEP_DDM_CONNECTIONS_ACTIVE

setDecimalFormat

public void setDecimalFormat(String decimalFormat)
                      throws AS400SecurityException,
                             ErrorCompletingRequestException,
                             InterruptedException,
                             IOException,
                             ObjectDoesNotExistException
Sets the decimal format used for this job.

Parameters:
decimalFormat - The decimal format used for this job. Possible values are:
  • DECIMAL_FORMAT_SYSTEM_VALUE - The system value QDECFMT is used as the decimal format for this job.
  • 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.
  • 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.
  • 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 position (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 (0,04). This constant also overrides any edit codes that might suppress the leading zero.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
DECIMAL_FORMAT

setDefaultWait

public void setDefaultWait(int defaultWait)
                    throws AS400SecurityException,
                           ErrorCompletingRequestException,
                           InterruptedException,
                           IOException,
                           ObjectDoesNotExistException
Sets the default maximum time (in seconds) that a thread in the job waits for a system instruction, such as a LOCK machine interface (MI) instruction, to acquire a resource. This default wait time is used when a wait time is not otherwise specified for a given situation. Normally, this is the amount of time the user is willing to wait for the system before the request is ended. If the job consists of multiple routing steps, a change to this attribute during a routing step does not appy to subsequent routing steps. The valid range is 1 through 9999999. A value of -1 represents no maximum wait time (*NOMAX).

Parameters:
defaultWait - The default maximum time (in seconds) that a thread in the job waits for a system instruction to acquire a resource. The value -1 means there is no maximum (*NOMAX). The valid range is 1 through 9999999. The value 0 is not valid.
Throws:
AS400SecurityException - If a security or authority error occurs.
ErrorCompletingRequestException - If an error occurs before the request is completed.
InterruptedException - If this thread is interrupted.
IOException - If an error occurs while communicating with the system.
ObjectDoesNotExistException - If the object does not exist on the system.
See Also:
DEFAULT_WAIT_TIME

setDeviceRecoveryAction

public void setDeviceRecoveryAction(String deviceRecoveryAction)
                             throws AS400SecurityException,
                                    ErrorCompletingRequestException,
                                    InterruptedException,
                                    IOException,
                                    ObjectDoesNotExistException
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:
  • DEVICE_RECOVERY_ACTION_SYSTEM_VALUE - The value in the system value QDEVRCYACN is used as the device recovery action for this job.
  • DEVICE_RECOVERY_ACTION_MESSAGE - Signals the I/O error message to the application and lets the application program perform error recovery.
  • 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 work station device has recovered.
  • 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.
  • 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.
  • 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:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    DEVICE_RECOVERY_ACTION

  • setInquiryMessageReply

    public void setInquiryMessageReply(String inquiryMessageReply)
                                throws AS400SecurityException,
                                       ErrorCompletingRequestException,
                                       InterruptedException,
                                       IOException,
                                       ObjectDoesNotExistException
    Sets how the job answers inquiry messages.

    Parameters:
    inquiryMessageReply - How the job answers inquiry messages. Possible values are:
    • INQUIRY_MESSAGE_REPLY_REQUIRED - The job requires an answer for any inquiry messages that occur while this job is running.
    • 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.
    • 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:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    INQUIRY_MESSAGE_REPLY

    setInternalJobID

    public void setInternalJobID(String internalJobID)
                          throws PropertyVetoException
    Deprecated. Use setInternalJobIdentifier(byte[]) instead. The internal job identifier should be treated as a byte array of 16 bytes.

    Sets the internal job identifier. This does not change the job on the system. 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 system.

    Parameters:
    internalJobID - The internal job identifier.
    Throws:
    PropertyVetoException - If the property change is vetoed.

    setInternalJobIdentifier

    public void setInternalJobIdentifier(byte[] internalJobID)
    Sets the internal job identifier. This does not change the job on the system. 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 system.

    Parameters:
    internalJobID - The 16-byte internal job identifier.

    setJobAccountingCode

    public void setJobAccountingCode(String jobAccountingCode)
                              throws AS400SecurityException,
                                     ErrorCompletingRequestException,
                                     InterruptedException,
                                     IOException,
                                     ObjectDoesNotExistException
    Sets an identifier assigned to the job by the system to collect resource use information for the job when job accounting is active. The user who is changing this field must have authority to the CHGACGCDE CL command. If the user does not have the proper authority, this field is ignored and processing continues.

    Parameters:
    jobAccountingCode - An identifier assigned to the job by the system to collect resource use information for the job when job accounting is active. Possible values are:
    • ACCOUNTING_CODE_BLANK - The accounting code is changed to all blanks.
    • Accounting code - The 15 character accounting code used for the next accounting segment. The accounting code may contain alphabetic or numeric characters.
    Throws:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    ACCOUNTING_CODE

    setJobDate

    public void setJobDate(Date jobDate)
                    throws AS400SecurityException,
                           ErrorCompletingRequestException,
                           InterruptedException,
                           IOException,
                           ObjectDoesNotExistException
    Sets the date that is assigned to the job. This value will only be changed for jobs whose status is *JOBQ or *ACTIVE.

    Parameters:
    jobDate - The date that is assigned to the job.
    Throws:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    JOB_DATE

    setJobMessageQueueFullAction

    public void setJobMessageQueueFullAction(String jobMessageQueueFullAction)
                                      throws AS400SecurityException,
                                             ErrorCompletingRequestException,
                                             InterruptedException,
                                             IOException,
                                             ObjectDoesNotExistException
    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:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    MESSAGE_QUEUE_ACTION

    setJobSwitches

    public void setJobSwitches(String jobSwitches)
                        throws AS400SecurityException,
                               ErrorCompletingRequestException,
                               InterruptedException,
                               IOException,
                               ObjectDoesNotExistException
    Sets the current setting of the job switches that are used by this job. Specify any combination of eight 0's, 1's, or X's to change the job switch settings. If a switch is not being changed, enter an X in the position that represents that switch.

    Parameters:
    jobSwitches - The current setting of the job switches that are used by this job.
    Throws:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    JOB_SWITCHES

    setLanguageID

    public void setLanguageID(String languageID)
                       throws AS400SecurityException,
                              ErrorCompletingRequestException,
                              InterruptedException,
                              IOException,
                              ObjectDoesNotExistException
    Sets the language identifier associated with this job. The language identifier is used when *LANGIDUNQ or *LANGIDSHR is specified on the sort sequence parameter. If the job CCSID is 65535, this parameter is also used to determine the value of the job default CCSID.

    Parameters:
    languageID - The language identifier associated with this job. Possible values are:
    Throws:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    LANGUAGE_ID

    setLoggingCLPrograms

    public void setLoggingCLPrograms(String loggingCLPrograms)
                              throws AS400SecurityException,
                                     ErrorCompletingRequestException,
                                     InterruptedException,
                                     IOException,
                                     ObjectDoesNotExistException
    Sets whether or not commands are logged for CL programs that are run.

    Parameters:
    loggingCLPrograms - The value indicating whether or not commands are logged for CL programs that are run. Possible values are:
    Throws:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    LOG_CL_PROGRAMS

    setLoggingLevel

    public void setLoggingLevel(int loggingLevel)
                         throws AS400SecurityException,
                                ErrorCompletingRequestException,
                                InterruptedException,
                                IOException,
                                ObjectDoesNotExistException
    Sets what type of information is logged.

    Parameters:
    loggingLevel - A value indicating what type of information 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. This includes the indication of job start, job end, and job completion status.
    • 2 - The following information is logged:
      • Logging level 1 information.
      • Request messages that result in a high-level message with a severity code greater than or equal to the logging severity cause the request message and all associated messages to be logged. A high-level message is one that is sent to the program message queue of the program that receives the request message. For example, QCMD is an IBM-supplied request processing program that receives request messages.
    • 3 - The following information is logged:
      • Logging level 1 and 2 information is logged.
      • All request messages are logged.
      • Commands run by a CL program are logged if it is allowed by the LOG_CL_PROGRAMS attribute and the log attribute of the CL program.
    • 4 - The following information is logged:
      • All request messages and all messages with a severity greater than or equal to the message logging severity, including trace messages.
      • Commands run by a CL program are logged if it is allowed by the LOG_CL_PROGRAMS attribute and the log attribute of the CL program.
    Throws:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    LOGGING_LEVEL

    setLoggingSeverity

    public void setLoggingSeverity(int loggingSeverity)
                            throws AS400SecurityException,
                                   ErrorCompletingRequestException,
                                   InterruptedException,
                                   IOException,
                                   ObjectDoesNotExistException
    Sets the severity level that is used in conjunction with the logging level to determine which error messages are logged in the job log. The values range from 00 through 99.

    Parameters:
    loggingSeverity - The severity level that is used in conjunction with the logging level to determine which error messages are logged in the job log.
    Throws:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    LOGGING_SEVERITY

    setLoggingText

    public void setLoggingText(String loggingText)
                        throws AS400SecurityException,
                               ErrorCompletingRequestException,
                               InterruptedException,
                               IOException,
                               ObjectDoesNotExistException
    Sets the level of message text that is written in the job log when a message is logged according to the LOGGING_LEVEL and LOGGING_SEVERITY.

    Parameters:
    loggingText - The level of message text that is written in the job log when a message is logged according to the LOGGING_LEVEL and LOGGING_SEVERITY. Possible values are:
    • LOGGING_TEXT_MESSAGE - Only the message text is written to the job log.
    • LOGGING_TEXT_SECLVL - Both the message text and the message help (cause and recovery) of the error message are written to the job log.
    • LOGGING_TEXT_NO_LIST - If the job ends normally, no job log is produced. If the job ends abnormally (the job end code is 20 or higher), a job log is produced. The messages that appear in the job log contain both the message text and the message.
    Throws:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    LOGGING_TEXT

    setName

    public void setName(String name)
                 throws PropertyVetoException
    Sets the job name. This does not change the name of the actual server job. Instead, it changes the job this Job object references. This cannot be changed if the object has already established a connection to the system.

    Parameters:
    name - The job name. Specify JOB_NAME_CURRENT to indicate the job this program running in, or JOB_NAME_INTERNAL to indicate that the job is specified using the internal job identifier.
    Throws:
    PropertyVetoException - If the property change is vetoed.

    setNumber

    public void setNumber(String number)
                   throws PropertyVetoException
    Sets the job number. This does not change the name of the actual server job. Instead, it changes the job this Job object references. This cannot be changed if the object has already established a connection to the system.

    Parameters:
    number - The job number. This must be JOB_NUMBER_BLANK if the job name is JOB_NAME_CURRENT.
    Throws:
    PropertyVetoException - If the property change is vetoed.

    setOutputQueue

    public void setOutputQueue(String outputQueue)
                        throws AS400SecurityException,
                               ErrorCompletingRequestException,
                               InterruptedException,
                               IOException,
                               ObjectDoesNotExistException
    Sets the fully qualified integrated file system path name of the default output queue that is used for spooled output produced by this job. The default output queue is only for spooled printer files that specify *JOB for the output queue.

    Parameters:
    outputQueue - The fully qualified integrated file system path name of the default output queue that is used for spooled output produced by this job. Possible values are:
    • OUTPUT_QUEUE_DEVICE - The device specified on the Create Printer File (CRTPRTF), Change Printer File (CHGPRTF), or Override with Printer File (OVRPRTF) commands is used.
    • OUTPUT_QUEUE_WORK_STATION - The default output queue that is used with this job is the output queue that is assigned to the work station associated with the job at the time the job is started.
    • OUTPUT_QUEUE_INITIAL_USER - The output queue name specified in the user profile under which this thread was initially running is used.
    • The fully qualified integrated file system path name of the output queue.
    Throws:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    OUTPUT_QUEUE, QSYSObjectPathName

    setOutputQueuePriority

    public void setOutputQueuePriority(int outputQueuePriority)
                                throws AS400SecurityException,
                                       ErrorCompletingRequestException,
                                       InterruptedException,
                                       IOException,
                                       ObjectDoesNotExistException
    Sets the output priority for spooled output files that this job produces. The highest priority is 0, and the lowest is 9.

    Parameters:
    outputQueuePriority - The output priority for spooled output files that this job produces. The valid values are a range from 1 to 9. The output priority specified cannot be higher than the priority specified in the user profile under which the job is running.
    Throws:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    OUTPUT_QUEUE_PRIORITY

    setPrinterDeviceName

    public void setPrinterDeviceName(String printerDeviceName)
                              throws AS400SecurityException,
                                     ErrorCompletingRequestException,
                                     InterruptedException,
                                     IOException,
                                     ObjectDoesNotExistException
    Sets the printer device used for printing output from this job.

    Parameters:
    printerDeviceName - The printer device used for printing output from this job. ssible values are:
    Throws:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    PRINTER_DEVICE_NAME

    setPrintKeyFormat

    public void setPrintKeyFormat(String printKeyFormat)
                           throws AS400SecurityException,
                                  ErrorCompletingRequestException,
                                  InterruptedException,
                                  IOException,
                                  ObjectDoesNotExistException
    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:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    PRINT_KEY_FORMAT

    setPrintText

    public void setPrintText(String printText)
                      throws AS400SecurityException,
                             ErrorCompletingRequestException,
                             InterruptedException,
                             IOException,
                             ObjectDoesNotExistException
    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. Possible values are:
    • PRINT_TEXT_SYSTEM_VALUE - The system value QPRTTXT is used.
    • PRINT_TEXT_BLANK - No text is printed on printed output.
    • The character string that is printed at the bottom of each page. A maximum of 30 characters can be entered.
    Throws:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    PRINT_TEXT

    setPurge

    public void setPurge(boolean purge)
                  throws AS400SecurityException,
                         ErrorCompletingRequestException,
                         InterruptedException,
                         IOException,
                         ObjectDoesNotExistException
    Sets the value indicating whether or not the job is eligible to be moved out of main storage and put into auxiliary storage at the end of a time slice or when entering a long wait (such as waiting for a work station user's response). This attribute is ignored when more than one thread is active within the job. If the job consists of multiple routing steps, a change to this attribute during a routing step does not apply to subsequent routing steps.

    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 entering a long wait; false otherwise.
    Throws:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    ELIGIBLE_FOR_PURGE

    setQueue

    public void setQueue(String jobQueue)
                  throws AS400SecurityException,
                         ErrorCompletingRequestException,
                         InterruptedException,
                         IOException,
                         ObjectDoesNotExistException
    Sets the fully qualified integrated file system path name of the job queue that the job is to be on. This value is valid for jobs whose status is *JOBQ. For jobs with a status of *OUTQ or *ACTIVE, an error will be signaled.

    Parameters:
    jobQueue - The fully qualified integrated file system path name of the job queue that the job is to be on.
    Throws:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    JOB_QUEUE, QSYSObjectPathName

    setQueuePriority

    public void setQueuePriority(int queuePriority)
                          throws AS400SecurityException,
                                 ErrorCompletingRequestException,
                                 InterruptedException,
                                 IOException,
                                 ObjectDoesNotExistException
    Sets the scheduling priority of the job compared to other jobs on the same job queue. The highest priority is 0 and the lowest is 9. This value is valid for jobs whose status is *JOBQ or *ACTIVE. For jobs with a status of *OUTQ, an error will be signaled.

    Parameters:
    queuePriority - The scheduling priority of the job compared to other jobs on the same job queue.
    Throws:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    JOB_QUEUE_PRIORITY

    setRunPriority

    public void setRunPriority(int runPriority)
                        throws AS400SecurityException,
                               ErrorCompletingRequestException,
                               InterruptedException,
                               IOException,
                               ObjectDoesNotExistException
    Sets the priority at which the job competes for the processing unit relative to the other jobs that are active at the same time. The run priority ranges from 1 (highest priority) to 99 (lowest priority). This value represents the relative (not absolute) importance of the job or thread. For example, a run priority of 25 is not twice as important as a run priority of 50. If the job consists of multiple routing steps, a change to this attribute during a routing step does not apply to subsequent routing steps.

    Parameters:
    runPriority - The run priority of the job is changed. The range of values is 1 (highest priority) to 99 (lowest priority). The value may never be higher than the run priority for the job in which the thread is running. If a priority higher than the job's is entered, an error is returned. Changing the run priority of the job affects the run priorities of all threads within the job. For example, the job is running at priority 10, thread A within the job is running at priority 10, and thread B within the job is running at priority 15. The priority of the job is changed to 20. The priority of thread A would then be adjusted to 20 and the priority of thread B would be adjusted to 25.
    Throws:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    RUN_PRIORITY

    setScheduleDate

    public void setScheduleDate(Date scheduleDate)
                         throws AS400SecurityException,
                                ErrorCompletingRequestException,
                                InterruptedException,
                                IOException,
                                ObjectDoesNotExistException
    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:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    SCHEDULE_DATE

    setScheduleDate

    public void setScheduleDate(String scheduleDate)
                         throws AS400SecurityException,
                                ErrorCompletingRequestException,
                                InterruptedException,
                                IOException,
                                ObjectDoesNotExistException
    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:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    SCHEDULE_DATE

    setScheduleTime

    public void setScheduleTime(Date scheduleTime)
                         throws AS400SecurityException,
                                ErrorCompletingRequestException,
                                InterruptedException,
                                IOException,
                                ObjectDoesNotExistException
    Sets the date and time the job is scheduled to become active.

    Parameters:
    scheduleTime - The date and time the job is scheduled to become active.
    Throws:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    SCHEDULE_DATE

    setScheduleTime

    public void setScheduleTime(String scheduleTime)
                         throws AS400SecurityException,
                                ErrorCompletingRequestException,
                                InterruptedException,
                                IOException,
                                ObjectDoesNotExistException
    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:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    SCHEDULE_DATE

    setSortSequenceTable

    public void setSortSequenceTable(String sortSequenceTable)
                              throws AS400SecurityException,
                                     ErrorCompletingRequestException,
                                     InterruptedException,
                                     IOException,
                                     ObjectDoesNotExistException
    Sets the name of the sort sequence table associated with this job..

    Parameters:
    sortSequenceTable - The name of the sort sequence table associated with this job. Possible values are:
    • SORT_SEQUENCE_TABLE_SYSTEM_VALUE - The system value QSRTSEQ is used.
    • SORT_SEQUENCE_TABLE_INITIAL_USER - The sort sequence table specified in the user profile under which this thread was initially running is used.
    • SORT_SEQUENCE_TABLE_NONE - No sort sequence table is used. The hexadecimal values of the characters are used to determine the sort sequence.
    • SORT_SEQUENCE_TABLE_LANGUAGE_SHARED_WEIGHT - The sort sequence table used can contain the same weight for multiple characters, and it is the shared weight sort table associated with the language specified in the LANGUAGE_ID attribute.
    • SORT_SEQUENCE_TABLE_LANGUAGE_UNIQUE_WEIGHT - The sort sequence table used must contain a unique weight for each character in the code page, and it is the unique weight sort table associated with the language specified in the LANGUAGE_ID parameter.
    • The fully qualified integrated file system path name of the sort sequence table associated with this job.
    Throws:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    SORT_SEQUENCE_TABLE, QSYSObjectPathName

    setStatusMessageHandling

    public void setStatusMessageHandling(String statusMessageHandling)
                                  throws AS400SecurityException,
                                         ErrorCompletingRequestException,
                                         InterruptedException,
                                         IOException,
                                         ObjectDoesNotExistException
    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:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    STATUS_MESSAGE_HANDLING

    setSystem

    public void setSystem(AS400 system)
                   throws PropertyVetoException
    Sets the system. This cannot be changed if the object has established a connection to the system.

    Parameters:
    system - The system.
    Throws:
    PropertyVetoException - If the property change is vetoed.

    setTimeSeparator

    public void setTimeSeparator(String timeSeparator)
                          throws AS400SecurityException,
                                 ErrorCompletingRequestException,
                                 InterruptedException,
                                 IOException,
                                 ObjectDoesNotExistException
    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. Possible values are:
    Throws:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    TIME_SEPARATOR

    setTimeSlice

    public void setTimeSlice(int timeSlice)
                      throws AS400SecurityException,
                             ErrorCompletingRequestException,
                             InterruptedException,
                             IOException,
                             ObjectDoesNotExistException
    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. The time slice establishes the amount of time needed by a thread in this job to accomplish a meaningful amount of processing. At the end of the time slice, the thread might be put in an inactive state so that other threads can become active in the storage pool. If the job consists of multiple routing steps, a change to this attribute during a routing step does not apply to subsequent routing steps. Valid values range from 1 through 9,999,999 milliseconds (that is, 9999.999 seconds). Although you can specify a value of less than 8, the system takes a minimum of 8 milliseconds to run a process. If you display a job's run attributes, the time slice value is never less than 8.

    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:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    TIME_SLICE

    setTimeSliceEndPool

    public void setTimeSliceEndPool(String timeSliceEndPool)
                             throws AS400SecurityException,
                                    ErrorCompletingRequestException,
                                    InterruptedException,
                                    IOException,
                                    ObjectDoesNotExistException
    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:
    Throws:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    TIME_SLICE_END_POOL

    setUser

    public void setUser(String user)
                 throws PropertyVetoException
    Sets the user name. This does not change the name of the actual server job. Instead, it changes the job this Job object references. This cannot be changed if the object has already established a connection to the system.

    Parameters:
    user - The user name. This must be USER_NAME_BLANK if the job name is JOB_NAME_CURRENT.
    Throws:
    PropertyVetoException - If the property change is vetoed.
    See Also:
    getUser()

    setValue

    public void setValue(int attribute,
                         Object value)
                  throws AS400SecurityException,
                         ErrorCompletingRequestException,
                         InterruptedException,
                         IOException,
                         ObjectDoesNotExistException
    Sets a value for a job attribute. If caching is off, the value is immediately sent to the system. If caching is on, call commitChanges() to send the uncommitted values to the system.

    Parameters:
    attribute - The job attribute to change.
    value - The new value of the attribute.
    Throws:
    AS400SecurityException - If a security or authority error occurs.
    ErrorCompletingRequestException - If an error occurs before the request is completed.
    InterruptedException - If this thread is interrupted.
    IOException - If an error occurs while communicating with the system.
    ObjectDoesNotExistException - If the object does not exist on the system.
    See Also:
    commitChanges(), getValue(int)

    toString

    public String toString()
    Returns the string representation of this Job in the format "number/user/name", or "" if any of these attributes is null.

    Overrides:
    toString in class Object
    Returns:
    The string representation.