schema.ixn.ixn-2.0.xsd Maven / Gradle / Ivy
A collection of interactions.
@jakarta.inject.Named("causeway.schema.ixn.v2.InteractionsDto")
The major version of the schema that an XML instance was created using.
The minor version of the schema that an XML instance was created using.
Represents an interaction, that is the execution of a command on a target object.
There is typically just a single execution per command. In more complex cases though executions can be nested, whereby a top-level execution causes other executions, as invoked through a wrapper (Wrapperproxy obtained from the WrapperFactory service).
@jakarta.inject.Named("causeway.schema.ixn.v2.InteractionDto")
The major version of the schema that an XML instance was created using.
Omit if within a top-level interactionsDto.
The minor version of the schema that an XML instance was created using.
Omit if within a top-level interactionsDto.
Unique identifier of the interaction which this member was interacted with (action invoked/property edited); can be used to locate the corresponding Command object (which may have been persisted).
Either an action invocation or a property edit.
Represents either an action invocation or a property edit. Is subclassed by both.
@jakarta.inject.Named("causeway.schema.ixn.v2.MemberExecutionDto")
Unique sequence number of an individual member interaction within the overall interaction. There could be many such member interactions (within a single transaction) for two reasons: either a single top-level interaction could call sub-interactions (by virtue of WrapperFactory), or there may be a bulk action interaction against many targets.
For target domain object being interacted with. For regular actions/properties, represents the entity or view model upon which the action is to be invoked/property edited. For mixin actions/properties, is the object being mixed-into (the constructor arg to the mixin). For contributed actions/properties, is the domain service (the contributee object will be one of the action arguments within the payload).
Logical formal identifier of the member being interacted with (action or property). Uses logicalTypeName, abstracts away whether the member is a declared member or a mixin.
The name of the user that invoked this action. Note that this isn't necessarily the user that initiated the original command; the SudoService may be being used to temporarily switch the effective user.
Profiling metrics capturing the this time/number of objects affected as a result of performing this member interaction (invoke the action, or edit the property).
Captures any exception thrown by an action. Either the 'returned' or the 'threw' element will be populated.
Capture interactions with other pathsToInclude from this interaction, using the WrapperFactory service. Typically this will be actions invoking other actions, but it is also possible for an action to perform a property edit, and - much rarer - for a property edit to invoke an action. Whatever; these interactions nest together into a call/stack, more generally into a graph.
Indicates whether this is an intention to invoke an action, or edit a property.
@jakarta.inject.Named("causeway.schema.ixn.v2.ActionInvocationDto")
The list of parameter/argument values for this action invocation.
The value returned by this action (including the type of that returned value). Either the 'returned' or the 'threw' element (from 'memberExecutionDto') will be populated.
@jakarta.inject.Named("causeway.schema.ixn.v2.PropertyEditDto")
@jakarta.inject.Named("causeway.schema.ixn.v2.MetricsDto")
The time taken to perform the member interaction (invoke the action, or edit the property).
How many objets were affected by the member interaction.
@jakarta.inject.Named("causeway.schema.ixn.v2.ObjectCountsDto")
The number of objects loaded.
The number of objects dirtied (ie updated).
Captures any exception thrown by an action invocation. Use as the xsd:type of the 'threw' element.
@jakarta.inject.Named("causeway.schema.ixn.v2.ExceptionDto")
A formatted stack trace. (A future version of the 'exceptionDto' element might refine this to more easily parseable stack trace elements).