BatchJob class | QSYS API Reference Guide
Estimated reading time: 3 minutes
Defines the core behavior of a batch job.
Namespace: ASNA.QSys.Runtime.JobSupport Assembly: ASNA.QSys.Runtime.dll
Methods
| Signature | Description |
|---|---|
| CreateJobConfig(BatchEntry) | Creates a JobConfig from a BatchEntry. |
| Dispose(Boolean) | Releases the resources used by the current instance of the Job class. |
| Execute(MethodInfo, List<String>) | Execute a program with a parameter list. |
| getADO_Connection() | Gets the ADO connection used for ‘embedded SQL’ |
| getDatabase() | Gets the main DataGate Database associated with the Job. |
| getPrinterDB() | Gets the DataGate Database for Printer Files associated with the Job. |
| LogAbnormalTermination(String, Exception) | Log abnormal termination. |
| openDataConnections(BatchEntry) | New and populate a JobConfig from a BatchEntry |
| Setup(BatchEntry) | Setup a job with the options in the BatchEntry. |
JobConfig CreateJobConfig(BatchEntry batchEntry)
Creates a JobConfig from a BatchEntry.
JobConfig CreateJobConfig(BatchEntry batchEntry)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| BatchEntry | batchEntry | The input BatchEntry. |
Returns
| Type | Description |
|---|---|
| JobConfig | A initialized JobConfig. |
void Dispose(bool disposing)
Releases the resources used by the current instance of the Job class.
void Dispose(bool disposing)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| Boolean | disposing | true to release managed and unmanaged resources; false to release only unmanaged resources. |
void Execute(MethodInfo entryMethod, List<string> parmameterList)
Execute a program with a parameter list.
void Execute(MethodInfo entryMethod, List<string> parmameterList)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| MethodInfo | entryMethod | The *ENTRY method info for the program to be executed. |
| List<String> | parmameterList | The parameter list to be passed to the program. |
DbConnection getADO_Connection()
Gets the ADO connection used for ‘embedded SQL’
DbConnection getADO_Connection()
Database getDatabase()
Gets the main DataGate Database associated with the Job.
Database getDatabase()
Database getPrinterDB()
Gets the DataGate Database for Printer Files associated with the Job.
Database getPrinterDB()
void LogAbnormalTermination(string error, Exception e)
Log abnormal termination.
void LogAbnormalTermination(string error, Exception e)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | error | Error message to log, may be null. |
| Exception | e | Exception to log, may be null. |
void openDataConnections(BatchEntry batchEntry)
New and populate a JobConfig from a BatchEntry
void openDataConnections(BatchEntry batchEntry)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| BatchEntry | batchEntry | The source BatchEntry |
void Setup(BatchEntry batchEntry)
Setup a job with the options in the BatchEntry.
void Setup(BatchEntry batchEntry)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| BatchEntry | batchEntry | The BatchEntry with the options for the job. |