InterSystems IRIS Data Platform 2020.4 > Class Reference > ENSLIB namespace > Ens.BPL.Scope


class Ens.BPL.Scope extends Ens.BPL.Activity

This class represents a sequence of activities to be performed. Errors occuring with the scope block are caught and redirected to the a fault handler. The fault handler can, if desired, invoke a compensation handler which is a named block of code which is intended to compensate for the fault. Transfer of control flow to a catch block can also be achieved by using the Throw activity,naming the catch block to be invoked.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property Activities as Ens.BPL.ActivityList;
This holds the Try Activity List
Property methods: ActivitiesGet(), ActivitiesGetSwizzled(), ActivitiesIsValid(), ActivitiesNewObject(), ActivitiesSet()
property CompensationHandlers as Ens.BPL.CompensationHandlerList;
This holds the CompensationHandlers
Property methods: CompensationHandlersGet(), CompensationHandlersGetSwizzled(), CompensationHandlersIsValid(), CompensationHandlersNewObject(), CompensationHandlersSet()
property FaultHandlers as Ens.BPL.CatchList;
This holds the Catch List
Property methods: FaultHandlersGet(), FaultHandlersGetSwizzled(), FaultHandlersIsValid(), FaultHandlersNewObject(), FaultHandlersSet()

Methods (Including Private)

private method %OnNew(initvalue As %RawString) as %Status [ Language = objectscript ]
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

method GenerateCode(pCompiler As Ens.BPL.Compiler) as %Status [ Language = objectscript ]
method GenerateXML(pStream As %BinaryStream) as %Status [ Language = objectscript ]
Inherited description: This generates the common XML attributes for this Activity
method Validate(ByRef pStatus As %Status, pContext As Ens.BPL.ValidationContext) as %Status [ Language = objectscript ]
Perform a sanity check on the nodes in the parse tree
private method activityName() as %String [ Language = objectscript ]
Provide a user readable string which names the activity

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)