Frame extends Action, ParameterEdgesSource, Scope

Examples

• FeedProducerComplete.iaml (source)
  • A complete example of using an RSS Frame to provide an RSSfeed from a DomainIterator. [FeedProducerComplete]
• FeedProducerSimple.iaml (source)
  • A simple example of using an RSS Frame to provide an RSSfeed from a DomainIterator. [FeedProducerSimple]
• RemoteRSSFeedPiped.iaml (source)
  • An external feed can be piped through toa local RSS Frame. [RemoteRSSFeedPiped]

Implementation Notes

• When an ECARule executes a Frame, the user is redirected to the location of the given Frame. [OperationCall]
• A RSS frame will output empty fields if the sources are empty. [FrameRss20]
• A footer file is selected from the first file that exists of CUSTOM_PATH/templates/footer/frame_id.php; CUSTOM_PATH/templates/footer/default.php; or the default include footer_default.php. [FrameHtml]
• A header file is selected from the first file that exists of CUSTOM_PATH/templates/header/frame_id.php; CUSTOM_PATH/templates/header/default.php; or the default include header_default.php. [FrameHtml]
• A meta include file is selected from the first file that exists of CUSTOM_PATH/templates/meta/frame_id.php; CUSTOM_PATH/templates/meta/default.php; or the default include meta_default.php. [FrameHtml]
• An RSS frame will obtain the <pubdate> for a feed item first from a DomainAttribute named pubDate, or one named updated. [FrameRss20]
• An RSS 2.0 Frame will lose Session parameters passed as part of links; i.e. PHPSESSID will not be included in URLs. [Render]
• An RSS 2.0 Frame will search for <title>, ... values with the following precedence: direct attribute; contained named Value; then value of contained named VisibleThing, all case insensitive. [FrameRss20]
• If an RSS Frame contains a InputForm with two Buttons named 'next' and 'reset', and a Label named 'results count', this InputForm will be navigated over to create the items in the feed. [FrameRss20]
• When a Frame is loaded, all onAccess Events for the frame and its children, recursively, are executed. [Frame]
• When a Frame is accessed, all entry Gates will be checked in order of the name of each gate. [Frame]
• When a Frame is accessed, all exit Gates will be checked in order of the name of each gate. [Frame]

Inference Rules

• A Frame protected by an AccessControlHandler will execute the 'page permissions check' Operation when the frame is accessed. [users]
• A Frame protected by an AccessControlHandler will have an Operation named 'page permissions check'. [users]
• A Frame within a Session protected by an AccessControlHandler will execute the 'permissions check' Operation when the frame is accessed. [users]
• A Frame within a Session protected by an AccessControlHandler will have an Operation named 'permissions check'. [users]
• The 'permissions check' Operation defined by an AccessControlHandler protecting a Frame within a Session will navigate to the 'login' Frame within a separate login Session if the check fails. [users]
• The 'permissions check' Operation defined by an AccessControlHandler protecting a Frame within a Session will navigate to the 'login' Frame within the same Session if the check fails. [users]
• A LoginHandler is generated for a Frame contained within a Session that contains an AccessControlHandler. [users]
• A Scope protected by a LoginHandler will create a login Frame named 'login' within the login Session. [login-handler]
• A Scope protected by a LoginHandler will create a logout Frame named 'logout' within the same Scope. [login-handler]
• If no 'logout' ECARule is defined for a LoginHandler, then a default 'logout successful' Frame will be created. [login-handler]
• If no 'success' ECARule is defined for a LoginHandler, then a default 'login successful' Frame will be created. [login-handler]
• The login Frame created for a LoginHandler protecting a Scope will be provided as the login rule for the LoginHandler if none is specified. [login-handler]
• Accessible elements have an Event named onAccess. [events] [from Accessible]
• 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] [from Scope]
• 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] [from Scope]
• 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] [from Scope]
• Scopes have an Event named onInit. [sessions] [from Scope]
• 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

• "A Frame cannot contain a LoginHandler" [Checks.chk]
• "Frame must have a name" [Checks.chk]
• "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]

Attributes

• render : RenderTypes (optional)
  The format that the Frame should be rendered as; by default, to HTML/Javascript.
  Accepted literals: HTML, RSS20
• url : EString (optional)
  The intended runtime URL of this Frame, which is normally derived from the id of this element.

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

• children : [0...*] VisibleThing
  A Frame can directly contain other VisibleThings, which are then rendered to the client.

Inherited Children

• accessHandlers : [0...*] AccessControlHandler
  A list of contained AccessControlHandlers.
• conditionEdges : [0...*] SimpleCondition
  A list of contained SimpleConditions.
• constraintEdges : [0...*] ConstraintEdge
  A list of contained ConstraintEdges.
• ecaRules : [0...*] ECARule
  A list of contained ECARules.
• 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.
• extendsEdges : [0...*] ExtendsEdge
  A list of contained ExecutionEdges.
• functions : [0...*] Function
  A list of contained Functions.
• iterators : [0...*] DomainIterator
  A list of contained DomainIterators.
• loginHandlers : [0...*] LoginHandler
  A list of contained LoginHandlers.
• messages : [0...*] Message
  A list of contained Messages.
• onAccess : [0...1] Event
  This Event is executed whenever it is accessed, which may occur many times within a single request.
• onInit : [0...1] Event
  This Event is triggered once when this Scope is initialised.
• operations : [0...*] Operation
  A list of contained Operations.
• parameterEdges : [0...*] Parameter
  A list of contained Parameters.
• parameters : [0...*] QueryParameter
  Runtime HTTP GET parameters of the current URL may be accessed as QueryParameters.
• providesEdges : [0...*] ProvidesEdge
  A list of contained ProvidesEdges.
• requiresEdges : [0...*] RequiresEdge
  A list of contained RequiresEdges.
• schemaEdges : [0...*] SchemaEdge
  A list of contained SchemaEdges.
• scopes : [0...*] Scope
  A Scope can contain many children Scopes through a containment hierarchy.
• selectEdges : [0...*] SelectEdge
  A list of contained SelectEdges.
• values : [0...*] Value
  A list of contained Values.
• wires : [0...*] Wire
  A list of contained Wires.

References

Inherited References

• generatedBy : [0...*] GeneratesElements [opposite: generatedElements]
  A list of elements that generated this element; conversely, overriding the source will prevent this element from being created.
• generatedElements : [0...*] GeneratedElement [opposite: generatedBy]
  A list of GeneratedElements that this element has generated through model completion.
• inWires : [0...*] Wire [opposite: to]
  A list of incoming Wires.
• listeners : [0...*] ECARule [opposite: trigger]
  A list of outgoing ECARules.
• outParameterEdges : [0...*] Parameter [opposite: parameterValue]
  A list of outgoing Parameters.
• outWires : [0...*] Wire [opposite: from]
  A list of outgoing Wires.
• rules : [0...*] ECARule [opposite: target]
  A list of incoming ECARules.

Extensions

• allContainerOperations [GeneratorExtensions.ext]
• containingFrame [Extensions.ext]
• frameContainingOperation [GeneratorExtensions.ext]
• frameTitle [GeneratorExtensions.ext]
• getAllExitGates [GeneratorExtensions.ext]
• isAccessibleOnFrame [Extensions.ext]
• isAccessibleOnFrame [Extensions.ext]
• isAccessibleOnFrame [Extensions.ext]

Inherited Extensions

• availableInCurrentScript(model::WireSource source,model::WireDestination target) [GeneratorExtensions.ext]
• availableInCurrentScriptAction(model::ActionEdgeSource source,model::Action target) [GeneratorExtensions.ext]
• model::Scope containingScope(model::NamedElement this) [GeneratorExtensions.ext]
• model::Scope containingScope(model::Scope this) [GeneratorExtensions.ext]
• getFailHandler(model::ActionEdgeSource this) [GeneratorExtensions.ext]
• List[model::components::Gate] getFrameEntryGates(model::Scope this) [GeneratorExtensions.ext]
• onCurrentFrame(model::WireSource source,model::WireDestination target) [GeneratorExtensions.ext]
• onCurrentSession(model::WireSource source,model::WireDestination target) [GeneratorExtensions.ext]
• operationName(model::Action this) [GeneratorExtensions.ext]
• safeName(model::GeneratedElement this) [GeneratorExtensions.ext]
• simpleName(model::NamedElement this) [GeneratorExtensions.ext]