ASNA.QSys.Runtime.JobSupport Classes

Estimated reading time: 8 minutes

Remarks

The ASNA.QSys.Runtime.JobSupport namespace contains classes that provide support for managing jobs, programs, and service programs in an ASNA environment. These classes provide the core functionality for organizing and controlling the execution of programs, handling exceptions, managing message queues, and interacting with the integrated file system, among other tasks.

This namespace is crucial for developers working with ASNA, as it provides the necessary tools for managing the lifecycle of jobs and handling the complexities of program execution. Each class in this namespace is documented in detail in the subsequent pages, providing developers with the information they need to effectively use these tools in their applications.

Type Description
ActivationGroup Provides the facilities to organize the instances of programs and service programs into related groups.
ActivationGroupAttribute Defines the Activation Group Attribute used to mark a program or service program class.
ActivationGroupCallException The exception that is thrown when an program is to be activated in the caller’s activation but the caller activation group could not be found.
ActivationGroupCreateException The exception that is thrown when an activation could not be found or created.
ActivationGroupDisposeException The exception that is thrown when an program has a null activation group at dispose time.
ActivationGroupInvalidCreatorException The exception that is thrown when an activation group’s dynamic creator is being overwritten.
ActivationGroupInvalidProgramException The exception that is thrown when an activation could not be created because the program is invalid.
ActivationGroupProgramConstructorException The exception that is thrown when a program could not be constructed.
ActivationManager Provides the facilities to manage the instances of programs and service programs.
AssemblyListProfilesSetting Gets or sets a dictionary of named assembly lists.
BatchEntry Represents a single entry in a batch processing system. This class providesthe necessary properties and methods to manage the entry’s data and state.
BatchJob Defines the core behavior of a batch job.
BatchJobProfile Provides the facilities to configure and launch a batch job.
BatchOptions Defines the options for a batch job.
BatchPoint Defines the location and time or a batch job.
CallerActivationGroupAttribute Defines the special Attribute used to mark a program or service program class for it to be activated in the caller’s Activation Group.
CallHostSpecs Packages the specification of a remote program call command and its parameters.
CLProgram Defines the core behavior of programs migrated from CL program .
CodePage Provides facilities to probe an IBM i file’s code page.
CommonProgram Defines the core behavior of programs and service programs.
DatabaseProfile Represents the configuration settings for a database connection within a batch entry.This class encapsulates all necessary details required to establish a connectionto the database, including server information, authentication credentials, andother connection-specific settings.
DBCharParm Represents a parameter for a Character type.
DBDateTimeParm Represents a parameter for a date-time type.
DBDecimalParm Represents a parameter for a decimal type.
DBIntegerParm Represents a parameter for an integer type.
DBParm Represents a SQL Parameter (used as base to specific parameter type)
DBScaledParm Represents a parameter for a Scalar type.
DBStrParm Represents a String SQL Parameter.
DocumentLibraryObject Provides functionality to manipulate Document Library Objects (DLO).
DynamicDisplayFile Provides the facilities to use a display file without prior infrastructure.
ExecuteStateException The exception that is thrown when a job is artificially being set to a state of ‘Running’.
FileOverrideOptionMismatchException The exception that is thrown when a file override has an option value that does not match expected by the named option.
FileOverrideSettingsException The exception that is thrown when a file override specified in the config file is invalid.
IntegratedFileSystem Holds the Integrated File System (IFS) root folder.
InteractiveJob Defines the core behavior of an interactive job.
InvalidMessageIntValueException The exception that is thrown when an exception placeholder integer is not an integer value string.
InvalidMessageLengthException The exception that is thrown when the replacement data length does not correspond to placeholder length.
InvalidMessagePlaceholderException The exception that is thrown when an message string is missing matching curly braces on a placeholder.
Job Defines the core behavior of a Job that provides an environment to submit, control, and keep track of Program activation and execution.
JobConfig Holds configuration values for the creation of new jobs.
JobException Defines the core behavior of the the base class that is thrown when there is a job exception.
JobFrameworkException Defined the core behavior of exceptions thrown by Monarch Base and provides a base for derived exceptions.
JobLogger Defines the core behavior of a job message logger and provides a base for derived classes.
JobStats Tracks lifetime metrics for the job.
JobStatus Represents the status of a job.
LDACapacityException The exception that is thrown when a field being get or set on the LDA is beyond the LDA length.
LDALengthException The exception that is thrown when a field being get or set from the LDA has a negative length.
LDAOffsetException The exception that is thrown when a field being get or set from the LDA has a negative offset.
LocalDataCollection Represents a versioned collection of name/value pairs.
Message Represent a message sent by a program.
MessageBase Represents a base class for messages, providing properties and methods for message text, cause, recovery suggestions, and logging functionality.
MessageFormatter Provides functionality to format a message.
MessageQueue Holds a group of messages in a queue.
MessageQueueNotFoundException The exception that is thrown when a program message queue is not found in the invocation stack.
Module Defines the core behavior of classes that were migrated from RPG or CL programs and modules.
ModuleCollection A dictionary of the modules making up this program.
ModuleImportAttribute Attribute to indicate the list of (external) modules this program will contain.
NewActivationGroupAttribute Defines the special Attribute used to mark a program or service program class for it to be activated in a brand new Activation Group.
NoDeviceAvailableException The exception that is thrown when an operation is attempted when the job is not attached to a device.
ObjectLockRequest Provides facilities to Allocate and De-Allocate object related.
OpenAccessFile Provides the facilities to use a display file without prior infrastructure.
OutOfProcessBatchJob Defines the core behavior of an out of process batch job.
Program Defines the core behavior of a program and provides a base for migrated derived classes.
QueryCursor Represents the SQL Query Cursor.
QueryResults Dictionary with Query result items.
QueryValue Represents a Value stored in a SQL Query Result.
RecursiveCallException The exception that is thrown when a program is being called recursively.
ServerTerminatedException The exception that is thrown to signal the host server is being shut down.
ServiceProgram Defines the core behavior of a service program and provides a base for migrated derived classes.
ServiceProgramCollection A dictionary of the service programs used by this program.
ServiceProgramUseAttribute Attribute to indicate the list of service programs to which a program is bound.
ShuttingDownException The exception that is thrown to signal the Job is being shut down.
Spooler Provides the infrastructure to manage spooled output from print files.
SQL_CommunicationsArea Implements SQLCA (SQL communications area)
SqlPreparedStatement Used to implement SQL PREPARE statements.
SystemValue Provides System Value attributes.
UnsupportedOperationException The exception that is thrown when an unsupported operation is attempted.
UserDefinedCommand Defines the core behavior of user defined commands and provide a base for derived classes.
WebDevice Defines the core behavior of the device handling the user interface for an interactive job and provides a base for derived classes.
WebDisplayFile Provides a program with an interface to the user interactions, supporting read and write operation to the user’s screen.
WebSocketDevice Implements a WebDevice using a socket to communicate with a website for its UI services.