Class Ens.Job

class Ens.Job extends %RegisteredObject

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
4	2	23	1

Summary

Properties
Name	TaskPass

Methods
%AddToSaveSet	%ClassIsLatestVersion	%ClassName	%ConstructClone
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%Extends
%GetParameter	%IsA	%IsModified	%New
%NormalizeObject	%ObjectModified	%OriginalNamespace	%PackageName
%RemoveFromSaveSet	%SerializeObject	%SetModified	%ValidateObject
AbortOperation	CleanUpDeadJobs	EnumerateClose	EnumerateExecute
EnumerateFetch	Launch	MakeNotQuiescent	MakeQuiescent
MarkDeadJobs	RecoverActiveMessage	Register	SetStatus
ShouldAbort	ShouldBeQuiescent	ShouldSuspend	ShouldTerminate
Start	Stop	StopAll	SuspendOperation
UnRegister

Parameters

• parameter DOMAIN = "Ensemble";

• parameter FGLAUNCHWAIT = 30;

• parameter FGTELNETWAIT = 30;

• parameter JOBSTARTWAIT = 120;

Properties

• property Name as %String;

Name of this job instance

• property TaskPass as %Integer;

The number of times OnTask() has run.

Methods

• classmethod AbortOperation(pJob As %String = "") as %Status

• classmethod CleanUpDeadJobs()

• classmethod EnumerateClose(ByRef qHandle As %Binary) as %Status

• classmethod EnumerateExecute(ByRef qHandle As %Binary) as %Status

• classmethod EnumerateFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status

• classmethod Launch(pConfigName As %String = "", pForeground As %Boolean, pDisableErrorTraps As %Boolean, pInterimJob As %String = "", Output pChildJob As %String, Output pListeningTelnetPort As %String = "") as %Status

• classmethod MakeNotQuiescent()

• classmethod MakeQuiescent(pTimeout As %Numeric = 10, Output pIsQuiescent As %Boolean)

• classmethod MarkDeadJobs()

• classmethod RecoverActiveMessage(pId As %ObjectIdentity, pName As %String, pMarkAsCrashed As %Boolean = 1) as %Status

• classmethod Register(pConfigName As %String, pIsTempJob As %Integer, pForeground As %Boolean, pJob As %String, pInterimJob As %String, pJobStatus As %String) as %Status

• classmethod SetStatus(pJobStatus As %Integer, pDetail As %String)

• classmethod ShouldAbort() as %Boolean

• classmethod ShouldBeQuiescent() as %Boolean

• classmethod ShouldSuspend() as %Boolean

• classmethod ShouldTerminate() as %Boolean

• classmethod Start(pConfigName As %String, pDisableErrorTraps As %Boolean, pIsTempJob As %Boolean = 0, pForeground As %Boolean = 0, pInterimJob As %String = "", pEventName As %String = "") as %Status

Start a background Job in the specified namespace.

• classmethod Stop(pJob As %String, pTimeout As %Numeric = 10, pForce As %Boolean = 0) as %Status

Stop one job

• classmethod StopAll(pTimeout As %Integer = 10, pForce As %Boolean = 0) as %Status

Stop all jobs

• classmethod SuspendOperation(pJob As %String) as %Status

• classmethod UnRegister(pConfigName As %String, pJob)

Queries

• query Enumerate()

Selects Job As %String, ConfigName As %String, Mode As %String, Status As %String, Detail As %String, ActiveMessage As %String, State As %String

List the known jobs and their information

Class Reference IRIS for UNIX 2024.1.2
Documentation Search