DomainIterator

Function	Returns
`matches(a,b)`	Performs a case-insensitive text search of `a` against the query `b`. Every word in `b` is matched, usually using a SQL keyword or function `LIKE`, against `a`.
`now()`	Returns the current date and time.

Examples

DomainInheritance.iaml (source)
- Selecting a DomainIterator with attributes across inherited DomainTypes. [DomainInheritance]
- Selecting a DomainIterator with more than one queryparameter (qualification = :qualification and degree = :degree) [DomainInheritance]
- Selecting an instance of a DomainType which has been extended. [DomainInheritance]
DomainInheritanceEditing.iaml (source)
- Creating a new instance of an inherited DomainType,accessible only within a Session. [DomainInheritanceEditing]
IteratedSyncWires.iaml (source)
- Navigating with a DomainIterator using the provided BuiltinOperations. [IteratedSyncWires]
IteratorCurrentPointer.iaml (source)
- Using the onIterate Event along withthe currentPointer Value. [IteratorCurrentPointer]
IteratorListSearchInstant.iaml (source)
- Searching a DomainIterator instantly and populating the resultsinto an IteratorList. [IteratorListSearchInstant]
IteratorListSetWire.iaml (source)
- Using a IteratorList to render the contents of a DomainIterator. [IteratorListSetWire]
QueryParameterAsParameter.iaml (source)
- Using a QueryParameter fromthe current request URI to selectan object instance. [QueryParameterAsParameter]
SelectWireManyPaginate.iaml (source)
- Using a DomainIterator that selects many resultsto transform an InputForm into a paginated browser over that iterator. [SelectWireManyPaginate]

Implementation Notes

A new instance of an inherited DomainType with autosave=falsecan have its attributes modified before being saved. [DomainInheritanceEditing]
New instances of DomainTypes which extend others can be created;all of their inherited attributes are accessible. [DomainInheritanceEditing]
A DomainIterator must have a limit not equal to 1 in order tonavigate successfully. [IteratedSyncWires]
A DomainType which inherits another can be instantiated bythe combination of all inherited attributes. [DomainInheritance]
Incoming Parameters into a DomainIteratorcan be null; this may cause some queries to fail(e.g. matches(a, null) will return no results). [testHomeNull()]
If a DomainIterator is using a query with more than one parameter,and the Parameters are not named, the name of thedata source will be used to match up a query. [DomainInheritance]
A LoginHandler (selecting a DomainType) needs incoming DomainAttributes as Parameters in orderto select the valid instance. [LoginHandlerInstanceMultiple]
If a new instance of an inherited DomainType is created withina Session, then the modification of this instance is limited towithin the Session. [DomainInheritanceEditing]
empty will return true even if the current arguments are not even set; i.e. it will fail silently. [IterateDefinitions]
The current offset of browsing instances is stored in the containing Session if there is one, otherwise globally. [IterateDefinitions]
The current offset of browsing instances is stored in the containing Session if there is one, otherwise globally. [StoreDefinitions]
A DomainIterator has a BuiltinOperation named 'add permission'. [DomainInstance]
A DomainIterator has a BuiltinOperation named 'add role'. [DomainInstance]
A DomainIterator has a BuiltinOperation named 'jump'. [DomainInstance]
A DomainIterator has a BuiltinOperation named 'new'. [DomainInstance]
A DomainIterator has a BuiltinOperation named 'next'. [DomainInstance]
A DomainIterator has a BuiltinOperation named 'previous'. [DomainInstance]
A DomainIterator has a BuiltinOperation named 'remove permission'. [DomainInstance]
A DomainIterator has a BuiltinOperation named 'remove role'. [DomainInstance]
A DomainIterator has a BuiltinOperation named 'reset'. [DomainInstance]
A DomainIterator has a BuiltinOperation named 'save'. [DomainInstance]
A DomainIterator has a BuiltinOperation named 'skip'. [DomainInstance]
A DomainIterator has a BuiltinProperty named 'canSave'. [DomainInstance]
A DomainIterator has a BuiltinProperty named 'empty'. [DomainInstance]
A DomainIterator has a BuiltinProperty named 'hasNext'. [DomainInstance]
A DomainIterator has a BuiltinProperty named 'hasPrevious'. [DomainInstance]

Inference Rules

The selected DomainIterator used to select one instance of a DetailWire source is given the same DomainSource as the source DomainIterator. [detail-wires]
DomainIterators do not have a Value named fieldValue created by default. [base]
A DomainIterator will contain a generated ActivityPredicate named 'not empty' - the inverse of the empty condition. [instance]
The 'not empty' ActivityPredicate for a DomainIterator, will be completed with the contents necessary to check that the iterator is not empty. [instance]
DomainIterators have a BuiltinOperation named jump. [instance]
DomainIterators have a BuiltinOperation named next. [instance]
DomainIterators have a BuiltinOperation named previous. [instance]
DomainIterators have a BuiltinOperation named reset. [instance]
DomainIterators have a BuiltinOperation named skip. [instance]
A DomainIterator contains an Operation named save. [new-instance]
DomainIterators have a BuiltinProperty named hasNext. [instance]
DomainIterators have a BuiltinProperty named hasNext. [instance]
DomainIterators have a BuiltinProperty named hasPrevious. [instance]
All DomainIterators will be populated with a single instance of a DomainInstance, representing the currentInstance of that iterator. [new-instance]
DomainIterators have an Event named onIterate. [instance]
An InputForm connected to a DomainIterator using a SetWire with a limit set (not 1), will contain Buttons named 'Next', 'Previous', 'First' and 'Last', in order to support navigation through the DomainIterator. [paginate]
An InputForm connected to a DomainIterator using a SetWire with a limit set (not 1), will contain a Label named 'Results'. [paginate]
The 'first' Button defined for navigating a DomainIterator, as defined by a SetWire, will execute the reset Operation on that iterator when clicked. [paginate]
The 'first' Button defined for navigating a DomainIterator, as defined by a SetWire, will be conditionally executed only if the iterator's notEmpty Function returns true. [paginate]
The 'last' Button defined for navigating a DomainIterator, as defined by a SetWire, needs to execute the 'update target' Operation within that Button before calling jump on the iterator. [paginate]
The 'last' Button defined for navigating a DomainIterator, as defined by a SetWire, will execute the jump Operation on that iterator when clicked. [paginate]
The 'last' Button defined for navigating a DomainIterator, as defined by a SetWire, will be conditionally executed only if the iterator's notEmpty Function returns true. [paginate]
The 'last' Button defined for navigating a DomainIterator, as defined by a SetWire, will contain a Value named 'target'. [paginate]
The 'next' Button defined for navigating a DomainIterator, as defined by a SetWire, will execute the next Operation on that iterator when clicked. [paginate]
The 'next' Button defined for navigating a DomainIterator, as defined by a SetWire, will be conditionally executed only if the iterator's hasNext Function returns true. [paginate]
The 'previous' Button defined for navigating a DomainIterator, as defined by a SetWire, will execute the previous Operation on that iterator when clicked. [paginate]
The 'previous' Button defined for navigating a DomainIterator, as defined by a SetWire, will be conditionally executed only if the iterator's hasPrevious Function returns true. [paginate]
The 'results' Label defined for navigating a DomainIterator, as defined by a SetWire, will be updated whenever the containing InputForm is accessed. [paginate]
The 'results' Label defined for navigating a DomainIterator, as defined by a SetWire, will be updated whenever the iterator changes. [paginate]
The 'last' Button defined for navigating a DomainIterator, as defined by a SetWire, will contain an ActivityOperation named 'update target'. [paginate]
The 'target' Value defined in a 'last' Button defined for navigating a DomainIterator, as defined by a SetWire, will be used as a Parameter for executing the jump Operation on that iterator. [paginate]
The current results count of the DomainIterator will be used as a Parameter to update the 'results' Label defined for navigating a DomainIterator with a SetWire when the containing InputForm is accessed. [paginate]
The current results count of the DomainIterator will be used as a Parameter to update the 'results' Label defined for navigating a DomainIterator with a SetWire when the iterator changes. [paginate]
DomainIterators have a readOnly Value named results. [instance]
A Session protected by a LoginHandler of type DOMAIN_OBJECT will contain a DomainIterator 'current instance' to represent the current domain object instance. [login-handler]
A Session protected by a LoginHandler of type USER will contain a DomainIterator 'current instance' to represent the current domain object instance. [login-handler]
The query of a DomainIterator used to set a LoginHandler of type DOMAIN_OBJECT will be updated according to the DomainType of the handler. [login-handler]
The query of a DomainIterator used to set a LoginHandler of type USER will be updated according to the DomainAttributes provided as Parameters to the handler. [login-handler]
The query of a DomainIterator used to set a LoginHandler of type USER will be updated according to the Role of the handler. [login-handler]
The query of a DomainIterator used to set a LoginHandler of type USER will be updated according to the Role of the handler. [login-handler]
The query of a DomainIterator used to set a LoginHandler of type USER will be set according to the DomainAttributes provided as Parameters to the handler. [login-handler]
A SetWire connecting a DomainIterator to an InputForm should only execute the 'init' Operation on the created Labels when the label is accessed if the DomainInstance is not empty. [set-wires]
A SetWire connecting a DomainIterator to an InputForm should only execute the 'update' Operation on the created Labels when the label is changed if the DomainInstance is not empty. [set-wires]
When a DomainIterator is connected to an IteratorList by a SetWire, Labels will be generated for its non-generated, non-primary key DomainAttributeInstances. [set-wires]
When a DomainIterator is connected to an IteratorList by a SetWire, a hidden Label will be generated for the primary key DomainAttributeInstance. [set-wires]
A SyncWire connecting a 'new' DomainIterator to an InputForm should only execute the 'init' Operation on the created Labels when the label is accessed if the DomainInstance is not empty. [sync-wires]
An ActivityOperation named 'permissions check' within an AccessControlHandler protecting a Session-contained Frame, used to check the status of the 'check permissions' Operation within the same handler, will be completed with the necessary ActivityNodes to implement this functionality. [users] [from Changeable]
An ActivityPredicate named 'can cast?', used to check casting for a Changeable fieldValue, will be completed with the necessary ActivityNodes to implement this functionality. [casting] [from Changeable]
An ActivityPredicate named 'permissions check' within an AccessControlHandler protecting a Frame, used to check the status of the 'check permissions' Operation within the same handler, will be completed with the necessary ActivityNodes to implement this functionality. [users] [from Changeable]
An empty ActivityOperation named "update", "refresh" or "init", contained within a Changeable, will be completed with ActivityNodes to implement the particular operation. [operations] [from Changeable]
An empty ActivityOperation named "set value XXX", contained within a Changeable, used to set a Value other than fieldValue, will be completed with ActivityNodes to implement the particular operation. [operations] [from Changeable]
Changeable elements will contain a BuiltinProperty named 'can cast?'. [casting] [from Changeable]
Changeable elements have an Event named onChange. [events] [from Changeable]
A Changeable contains an untyped Value named fieldValue. [base] [from Changeable]
If set, the defaultValue is used as the default value of the created fieldValue Value. [base] [from Changeable]
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 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 Changeable]
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 a Changeable is connected to a Value by a SetWire, the source element will call the 'set value XXX' Operation on the target when the source changes. [set-wires] [from Changeable]
When a Changeable element is connected to a Value by a SetWire, the value of the source element will be provided as a Parameter to the updating ECARule. [set-wires] [from Changeable]
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 DomainIterator has incoming Parameters, but does not have a query to use them" [Checks.chk]
"A DomainIterator can only have one Source" [Checks.chk]
"A DomainIterator should have one DomainSource specified" [Checks.chk]
"Contained fieldValue property has a default value, even though container already specifies one" [Checks.chk] [from Changeable]
"Type '".+(toString(type.name)).+("' is incompatible with contained fieldValue type '").+(toString(fieldValue.type.name)).+("'") [Checks.chk] [from Changeable]
"You should not have a contained Property named 'fieldValue', unless it is contained within the fieldValue containment feature" [Checks.chk] [from ContainsValues]

Attributes

autosave : EBoolean (optional)
If true, then any changes to the contained DomainInstance will also be automatically applied to its underlying DomainSource.
limit : EInt (default: 1)
A limit to the number of DomainInstances retrieved and kept in runtime memory.
orderAscending : EBoolean (optional)
If false, the order will be sorted in descending order (Z-A).
query : EString (optional)
The query used to select DomainInstances.

Inherited Attributes

defaultValue : EString (optional)
The default value of the fieldValue. This value should be the same as the defaultValue of the contained fieldValue, and is provided to simplify end-user implementation.
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

canSave : [0...1] Function
Returns true if the current instance can be saved to the specified DomainSource without throwing an error.
currentInstance : [0...1] DomainInstance
The current DomainInstance as pointed to by the current instance pointer.
currentPointer : [0...1] Value
The current value of the instance pointer. If there are no results or this is a new query, this will return -1. If there is one or many results, this will return a value between 0 and results-1.
empty : [0...1] Function
Returns true if the current result set is empty; that is, there are no matching DomainInstances for the given query.
hasNext : [0...1] Function
Returns true if navigating to the next result will not be out-of-bounds for the given query.
hasPrevious : [0...1] Function
Returns true if navigating to the previous result will not be out-of-bounds for the given query.
jump : [0...1] Operation
Navigates to a specific instance result, where 0 is the first result.
next : [0...1] Operation
Navigate to the next result. Will throw an error if hasNext would return false.
onIterate : [0...1] Event
This Event is triggered when the current instance pointer changes, or the current instance is reloaded.
previous : [0...1] Operation
Navigate to the previous result. Will throw an error if hasPrevious would return false.
reset : [0...1] Operation
Resets the current instance pointer and reloads the current instance.
results : [0...1] Value
The number of results in the current result set.
skip : [0...1] Operation
Navigate forwards over the provided number of results; negative parameters may be used to navigate backwards.

Inherited Children

conditionEdges : [0...*] SimpleCondition
A list of contained SimpleConditions.
constraintEdges : [0...*] ConstraintEdge
A list of contained ConstraintEdges.
ecaRules : [0...*] ECARule
A list of contained ECARules.
extendsEdges : [0...*] ExtendsEdge
A list of contained ExecutionEdges.
fieldValue : [0...1] Value
The current value of this Changeable element. This is always a valid type instance.
functions : [0...*] Function
A list of contained Functions.
onChange : [0...1] Event
This Event is triggered immediately after the fieldValue of this element is changed.
operations : [0...*] Operation
A list of contained Operations.
parameterEdges : [0...*] Parameter
A list of contained Parameters.
providesEdges : [0...*] ProvidesEdge
A list of contained ProvidesEdges.
requiresEdges : [0...*] RequiresEdge
A list of contained RequiresEdges.
schemaEdges : [0...*] SchemaEdge
A list of contained SchemaEdges.
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

orderBy : [0...1] DomainAttribute
A DomainAttribute used to sort the results obtained from this iterators' query.
outSelects : [0...*] SelectEdge [opposite: from]
A list of outgoing SelectEdges, specifying the sources of type instances.

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.
inParameterEdges : [0...*] Parameter [opposite: parameterTerm]
A list of incoming Parameters.
inProvidesEdges : [0...*] ProvidesEdge [opposite: to]
A list of incoming ProvidesEdges.
inWires : [0...*] Wire [opposite: to]
A list of incoming Wires.
outParameterEdges : [0...*] Parameter [opposite: parameterValue]
A list of outgoing Parameters.
outProvidesEdges : [0...*] ProvidesEdge [opposite: from]
A list of outgoing ProvidesEdges.
outWires : [0...*] Wire [opposite: from]
A list of outgoing Wires.
type : [0...1] EDataType
The type of this Changeable element and its contained fieldValue.

DomainIterator extends CanBeSynced, Changeable, ContainsFunctions, ContainsOperations, ContainsValues, ContainsWires, GeneratesElements, NamedElement, ParameterEdgeDestination, ProvidesEdgeDestination, ProvidesEdgesSource, Wireable

query

Containing Scope

Failure Handlers

Attributes

Operations

Examples

Implementation Notes

Inference Rules

Constraints

Attributes

Inherited Attributes

Children

Inherited Children

References

Inherited References

Extensions

Inherited Extensions