Scope extends Accessible, ActionEdgeSource, CanBeSynced, ContainsFunctions, ContainsOperations, ContainsValues, ContainsWires, GeneratedElement, GeneratesElements, NamedElement, Wireable

A particular runtime scope of a web application, which permits lifecycle modelling. Scopes may contain other Scopes through a containment hierarchy.

All scopes in IAML are instances of Scope, and a Scope may contain another Scope through a hierarchy of containment. A Scope may directly contain any number of Scopes. Every Scope will contain the pre-render lifecycle Events onAccess (through Accessible) and onInit.

When a Scope is rendered, the lifecycle events for that Scope must be executed in the following order. If a failure occurs during this process, the current lifecycle execution process is cancelled and the failure handler for the current Scope is executed. If an ECARule is executed which must redirect the user to another Frame, the current lifecycle execution process is cancelled.

If this Scope is contained by a parent Scope, then the pre-render lifecycle events for that parent Scope must be triggered.
If this Scope has not yet been initialised according to the storage semantics of that Scope, then the onInit Event is triggered.
The onAccess Event is triggered.
All entry Gates contained within this Scope are sorted according to their name. The access semantics of each entry Gate are then executed.
All exit Gates contained within this Scope are sorted according to their name. The access semantics of each exit Gate are then executed.
The Scope is then rendered.

Failure Handler

An outgoing ECARule from a particular Scope with the name "fail" is defined as a failure handler for the given scope. If an error occurs during the execution of the given Scope -- for example, an Operation fails -- then the failure handler for that Scope is executed according to the execution semantics of the ECARule.

If the current Scope does not define a failure handler, then the failure handler of the containing Scope is used as the failure handler. If an exception is not caught through the containment hierarchy of Scopes, then the exception is caught by the runtime environment and the web application will display a runtime error.

[Scope.html]

Direct subtypes:

Frame,

InternetApplication,

Session

All subtypes: Toggle

Implementation Notes

Gates are of a lower priority in execution than Events. That is, onAccess will execute before any Gates are executed. [Frame]
All operation calls to Operations contained within Scopes are first evaluated for any onAccess events. [login-handler]
If a Scope is not contained by a Session, then the storage semantics for that Scope are globally accessible; otherwise, they follow the semantics of the Session. [Parameters]

Inference Rules

A Scope protected by a Gate named 'XXX', with an outgoing ECARule named 'first' or 'last', will contain an ActivityPredicate named 'check XXX' to check that the Gate has been satisfied. [gate]
The 'check XXX' Function for a Gate, with an outgoing ECARule named 'first' or 'last', will be provided as a runtime SimpleCondition check to that Gate. [gate]
The 'check XXX' ActivityPredicate for a Gate, with an outgoing ECARule named 'first' or 'last', will be completed with the contents necessary to evaluate the flag Value. [gate]
Scopes have an Event named onInit. [sessions]
Accessible elements have an Event named onAccess. [events] [from Accessible]
A SetWire connecting an CanBeSynced object to a DomainIterator will create sub- SetWires between every contained CanBeSynced object to every contained object within the contained DomainInstance which have matching names. [set-wires] [from CanBeSynced]
A SetWire connecting an DomainIterator to a CanBeSynced object will create sub- SetWires between every contained object within the contained DomainInstance to every contained CanBeSynced object which have matching names. [set-wires] [from CanBeSynced]
A SetWire connecting two objects will create sub- SetWires between every contained object within these parent objects which have matching names. [set-wires] [from CanBeSynced]
When a Changeable element is connected to an CanBeSynced element by a SetWire, the value of the source element will be provided as a Parameter to the updating ECARule. [set-wires] [from CanBeSynced]
When a CanBeSynced element is connected to an CanBeSynced element by a SetWire, the value of the source element will be provided as a Parameter to the updating ECARule. [set-wires] [from CanBeSynced]
When an InputTextField is connected to a CanBeSynced element by an instant SetWire, the value of the source element will be provided as a Parameter to the updating ECARule. [set-wires] [from CanBeSynced]
A SyncWire connecting an DomainIterator to a CanBeSynced object will create sub- SyncWires between every contained object within the contained DomainInstance to every contained CanBeSynced object which have matching names. [sync-wires] [from CanBeSynced]
A SyncWire connecting two objects will create sub- SyncWires between every contained object within these parent objects which have matching names. [sync-wires] [from CanBeSynced]
For elements connected by a SyncWire, the onAccess Event executing the 'init' Operation will only execute if the source fieldValue can be cast successfully. [casting] [from CanBeSynced]
For elements connected by a SyncWire, the onAccess Event will only call the 'validate' Operation if the relevant fieldValue is set. [casting] [from CanBeSynced]
When a CanBeSynced element is connected to an CanBeSynced element by a SyncWire, the value of the source element will be provided as a Parameter to the updating ECARule. [sync-wires] [from CanBeSynced]
When an InputTextField is connected to a CanBeSynced element by an instant SyncWire, the value of the source element will be provided as a Parameter to the updating ECARule. [sync-wires] [from CanBeSynced]

Constraints

"Some of the ECARules defined for this trigger may not be executed, as an unconditional navigation will occur due to the priority order, halting ECARule execution" [Checks.chk] [from ActionEdgeSource]
"You should not have a contained Property named 'fieldValue', unless it is contained within the fieldValue containment feature" [Checks.chk] [from ContainsValues]

Inherited Attributes

generatedRule : EString (optional)
To assist in debugging, this attribute may be populated with the name of the model completion rule that created this element. More extensive traceability support may be provided in the future.
id : EString (optional)
A unique identifier for this model element. Should be globally unique.
isGenerated : EBoolean (optional)
Set to true if the current element has been generated.
name : EString (optional)
A non-unique string that names a given object.
overridden : EBoolean (optional)
If a GeneratesElements is overridden, then this element will not generate any elements directly.
overriddenNames : EString (optional)
When applying model completion, no NamedElements with these names will be generated by this element.

Children

accessHandlers : [0...*] AccessControlHandler
A list of contained AccessControlHandlers.
entryGate : [0...1] Gate
A user accessing this Scope must first satisfy this Gate before its contents can be accessed.
exitGate : [0...1] Gate
Once this Scope has been accessed, a user must satisfy this Gate before the user may leave a Frame within this scope.
iterators : [0...*] DomainIterator
A list of contained DomainIterators.
loginHandlers : [0...*] LoginHandler
A list of contained LoginHandlers.
messages : [0...*] Message
A list of contained Messages.
onInit : [0...1] Event
This Event is triggered once when this Scope is initialised.
parameters : [0...*] QueryParameter
Runtime HTTP GET parameters of the current URL may be accessed as QueryParameters.
scopes : [0...*] Scope
A Scope can contain many children Scopes through a containment hierarchy.