//Artefact:ModelClass/com/sphenon/modelling/xmodel/XMPresentation

Description

Properties concerning the pure presentation of objects, i.e independent of a specific media and independent of implementation issues.

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/DefaultModelHumanLanguage

Description

The human language (according to ISO 639) which is assumed for all texts in the model that are not explicitly labeled differently. E.g. "en" means: all texts in the respective model element are english texts.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☑ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☑ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/Index

Description

If provided, the position of the respective feature within it's containing class. Overrides the natural ordering given be the model. Allows also attributes and association to be mixed in the ordering, which is not possible to specify in the model, since these both are managed in separate collections.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/Id

Description

An string usable as an identifier for artefacts related to the respective model element. The string is be alphanumeric without any special characters or white space. It satisfies the regular expression [A-Za-z0-9_]+
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☑ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☑ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/Name

Description

The name of the respective model element.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☑ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☑ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/NameCondition

Description

Code, that evaluates to a boolean and indicates whether the respective Name reflects a valid value.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☑ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☑ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/CoreTypeName

Description

Optionally the name of an associated core class. E.g. the target type of a factory.
Applies to
▸ Model level: ☐ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☐ attributes ∙ ☐ operations ∙ ☐ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/ShortDescription

Description

A short description of the respective model element, typically a sentence or a phrase. Might be used in tooltips, popups and alike
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☑ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☑ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/ShortDescriptionCondition

Description

Code, that evaluates to a boolean and indicates whether the respective ShortDescription reflects a valid value.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☑ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☑ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/LongDescription

Description

A longer description of the respective model element, typically one or more paragraphs. Might be used in larger popups and alike.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☑ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☑ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/WaitMessage

Description

A message that appears when an operation lasts longer
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☐ attributes ∙ ☑ operations ∙ ☐ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/Style

Description

The style of the respective model element, consisting of a single word. Styles are processed in cascading style sheets, i.e. the standard HTML/XML css files or the EM/OS specific sscss (server side css) files.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☑ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☑ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/Colors

Description

A list of named color RGB values. These are used in the generated cascading style sheet.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☑ packages ∙ ☐ classes ∙ ☐ attributes ∙ ☐ operations ∙ ☐ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/Fonts

Description

A list of named font specifications. These are used in the generated cascading style sheet.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☑ packages ∙ ☐ classes ∙ ☐ attributes ∙ ☐ operations ∙ ☐ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/StyleProperties

Description

Properties for styling UI items related to this artefact. These will be placed in corresponding style sheets.
Applies to
▸ Model level: ☑ logical model ∙ ☐ technical model
▸ Model elements: ☑ packages ∙ ☐ classes ∙ ☐ pattern ends ∙ ☐ attributes ∙ ☐ operations ∙ ☐ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/StyleCategories

Description

A list of categories, which are also added as a style, in two ways. First the category is added itself, second, the category concatenated with a "-" sign and the class name is added.
Default is "ADO", so e.g. for a class "Person" the styles "ADO" and "ADO-Person" will be added.
Applies to
▸ Model level: ☑ logical model ∙ ☐ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☐ attributes ∙ ☐ operations ∙ ☐ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/Type

Description

The preferred type of presenting this entity. E.g., the user might want to choose from "Dialog" and "Diagram". If more than one type is specified, the user should be presented a list where he can choose a type from.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/TypeMap

Description

A mapping from modes to preferred types of presenting this entity.
See XMPresentation/Type for details on presentation types.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/ManyType

Description

The preferred type of presenting collections of this entity. E.g., the user might want to choose from "Table" and "Tree". If more than one type is specified, the user should be presented a list where he can choose a type from.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/ManyTypeMap

Description

A mapping from modes to preferred types of presenting this collection of entities.
See XMPresentation/Type for details on presentation types.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/Formatter

Description

Code, that evaluates to a VUIValueConverter instance, which is used to format primitive values into strings and parsing strings back into values.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/TransparentSlot

Description

Deprecated: please use "Transparent" instead.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/Transparent

Description

If true, the respective attribute, association or instance shall not be represented directly in the user interface, but only it's contents instead.
For attributes and association ends this means that the respective slot of this feature shall not be shown, but only it's value instead.
E.g., an enumeration value might contain just a single name field, which shall be shown whenever it's containing instance is presented, but obviously without it's attributes name "Name" as a field label. Another use case is in Interaction classes, where attributes are used to just hold content, but the attribute itself is not to be shown (e.g. 'Browser' in 'EditorTransaction').
For classes this means that the respective instance shall not be shown, but only it's features instead.
E.g., most toolkit classes only serve the purpose of providing a container for internal management, but only the tools itself shall be represented.
Yet, while the slot or the instance may not be visibly represented, their properties must not be neglected. If, e.g., the slot or class is declared completely invisble by other properties (state, security etc.), the value must not be shown, too.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/Anonymous

Description

If true, the respective attribute, association or instance might be represented in the user interface, but unnamed, i.e. a visual grouping border could be drawn, but not a prominent name. It might be ok to show the name e.g. in a tooltip, but this is not required.
Yet, whether shown or not, the id of the respective attribute, association or instance must not be neglected in locators.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/IconName

Description

The name of an icon symbolising the respective model element. It should be rather unique within a model element, since the user should be able to distinguish model elements by them. They are comparable to names.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☑ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☑ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/IconNameCondition

Description

Code, that evaluates to a boolean and indicates whether the respective IconName reflects a valid value.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☑ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☑ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/IconOverlay

Description

The icon overlay indicates additional icons to be added to the general class icon, typically as a tiny little overlay. The name of the overlay is an arbitrary string denoting the overlay, while the layer denotes a category. For each category exactly one overlay can be specified. E.g., in the category (i.e. layer) "operation" the name "edit" might be used. Another type of category might be some kind of status or alike.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☑ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☑ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/IconFolder

Description

The subfolder within the image root folder where the given icon is to be found. Defaults to the current package path. If the icon name starts with a "/" (slash character), this icon folder is not prepended, instead, the icon is assumed to contain the respective folder itself already.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☑ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☑ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/HelpURL

Description

A URL referring to some help text associated the respective model element.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☑ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☑ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/LayoutType

Description

A hint on a preferred layout for the respective model element (currently only "Grid" is considered)
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☑ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/Tightness

Description

Describes how tight a feature is bound to it's containing class. This information is used for rendering purposes.
The more tight a feature is, the more likely it is immediately visible when viewing a class instance. The less tight, the more clicks, additional windows and alike are necessary to view it.
With regard to attributes or associations this might be used for the sake of overview as well as for the sake of using limited screen space.
With regard to operations, it will decide how near and in which menu the operation will be placed.
Please note: there are disjunct subsets of valid properties used for attributes and associations in the one hand side and for operations on the other hand side.
For valid values see JavaClass
PresentationTightness
.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/ItemTightness

Description

In case of a to-many relationship, this property describes how tight the single items of the collection of this feature are bound to that collection itself, in contrast to how tight the collection is bound to the containing class.
The former tightness (item to collection) is described by this property, the latter (collection to containing class) by the property XMPresentation/Tightness.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/Importance

Description

Describes how important a feature is within it's containing class. Some information might be essential, while other information might be of secondary nature and can be suppressed in interfaces with limited space or e.g. within a one line preview in a choice list or combo box.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/Relationship

Description

Describes the logical relation of the annotated feature to it's surrounding container (containing class). Depending on this property, the UI rendered may decide where to place the feature with relative to the main content.
Applies to
▸ Model level: ☑ logical model ∙ ☐ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/Impact

Description

Categorises the impact of an operation. In addition to user preferences and the container of the method, this information provides a hint where to place the operation. E.g., an aborting operation might be bound to the window close button, while a committing operation is typically placed where "Ok" buttons belong to.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☐ attributes ∙ ☑ operations ∙ ☐ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/Discoverability

Description

Describes how respective items can be discovered in the UI, i.e. whether they are included automatically in menus, or are e.g. listed in sitemaps.
Applies to
▸ Model level: ☑ logical model ∙ ☐ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☐ attributes ∙ ☐ operations ∙ ☐ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/TextSize

Description

For text fields, specifies a preferred field width and height. The height means the count of lines a text field may offer.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☐ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/Position

Description

The position of the repspective model element within some context. The context is given by the "Base" attribute of this property instance (see class XMPosition). Examples are a position of a class in a class diagram (base "Diagram"), or a position of a field in a dialog (base "Grid").
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☑ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☑ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/ViewState

Description

The state of a view of the repspective model element within some context. The context is given by the "Base" attribute of this property instance (see class XMViewState).
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☑ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☑ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/ExpansionState

Description

The expansion state of a view of the repspective model element within some context. The context is given by the "Base" attribute of this property instance (see class XMExpansionState).
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☑ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☑ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/TreeNodeChild

Description

Denotes whether the respective model element is expandable in a TreeView.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/TreeNodeType

Description

Specifies the content to be shown when this feature is shown in a tree. In case of 'Slot' the feature is shown as one line with the name of the feature (slot). In case of 'Value' the slots value is shown, which might correspond to several lines if the value is a collection (many). The default is 'Value'.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/TreeNodeChildExpression

Description

Code, that evaluates to an boolean, and which indicates dynamically whether this feature is a tree node child.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/TabOrder

Description

Specifies the position in the tab order of the respective model element. The tab order is the order in which dialog elements are traversed if the user presses the Tab key (forward traversal) or the shift Tab key (backward traversal).
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/SortType

Description

Declares the type used for sorting of the respective attribute or association end. Important in case of in memory sorting where the sort algorithm of the business logic or database can not be called. For example displaying a list without a retriever.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/VisibilityAspectCondition

Description

If specified, the feature is only visible if the current aspect is matched by this condition. The current aspect is an external concept in the user realm. It is typically a string which is selected somehow implicitly or explicitly by the user and symbolises a certain aspect the user wants to see, in other words a point of view of the application she takes. Examples of aspects might be "overview", "customer", "management" or "system_diagnostics".
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/VisibilityAspectConditionSource

Description

Code, that dynamically evaluates to a XMPresentation/VisibilityAspectCondition.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/VisibilityAspectIncludeRegExp

Description

Deprecated: please use the more comprehensive solution XMPresentation/VisibilityAspectCondition.
If specified, the feature is only visible if the current aspect is matched by this regular expression. The current aspect is an external concept in the user realm. It is typically a string which is selected somehow implicitly or explicitly by the user and symbolises a certain aspect the user wants to see, in other words a point of view of the application she takes. Examples of aspects might be "overview", "customer", "management" or "system_diagnostics".
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/VisibilityAspectExcludeRegExp

Description

Deprecated: please use the more comprehensive solution XMPresentation/VisibilityAspectCondition.
If specified, the feature is only visible if the current aspect is not matched by this regular expression. The current aspect is an external concept in the user realm. It is typically a string which is selected somehow implicitly or explicitly by the user and symbolises a certain aspect the user wants to see, in other words a point of view of the application she takes. Examples of aspects might be "overview", "customer", "management" or "system_diagnostics".
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/VisibilityViewCondition

Description

If specified, the feature is only visible if the current view is matched by this condition. The current view is a concept within the VUI assemply tier. I.e., it is seperated from (external to) the business logic, but also separated from the user realm (internal to the system from the users perspective).
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/VisibilityViewConditionSource

Description

Code, that dynamically evaluates to a XMPresentation/VisibilityViewCondition.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/VisibilityViewIncludeRegExp

Description

Deprecated: please use the more comprehensive solution XMPresentation/VisibilityViewCondition.
If specified, the feature is only visible if the current view is matched by this regular expression. The current view is a concept within the VUI assemply tier. I.e., it is seperated from (external to) the business logic, but also separated from the user realm (internal to the system from the users perspective).
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/VisibilityViewExcludeRegExp

Description

Deprecated: please use the more comprehensive solution XMPresentation/VisibilityViewCondition.
If specified, the feature is only visible if the current view is not matched by this regular expression. The current view is a concept within the VUI assemply tier. I.e., it is seperated from (external to) the business logic, but also separated from the user realm (internal to the system from the users perspective).
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/VisibilityModes

Description

A list of VUI modes within which the respective attribute is visible. VUI modes are an internal concept in the VUI/BL adapter realm. They are a classification of modes in which adapters are used. The current mode is provided by some context, e.g. a containing transaction or space. Predefined modes are "readonly" and "readwrite", but an application can use arbitrary ones.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/VisibilityStates

Description

A list of VUI transaction states within which the respective attribute is visible. This is only valid within transactional classes which declare a visible state, see XMVUI/TransactionStateExpression.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/Visibility

Description

Code, that dertermines dynamically whether the respective feature is visible.
Note: a feature is only visible if all visibility constraints do permit this. E.g., an attribute must not be marked as "hidden" in the core model, otherwise it is never visible. Visibility constraints comprise general visibility, states, modes, aspects and security constraints.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/ChangeabilityAspectCondition

Description

If specified, the feature is only changeable if the current aspect is matched by this condition. The current aspect is an external concept in the user realm. It is typically a string which is selected somehow implicitly or explicitly by the user and symbolises a certain aspect the user wants to see, in other words a point of view of the application she takes. Examples of aspects might be "overview", "customer", "management" or "system_diagnostics".
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/ChangeabilityAspectConditionSource

Description

Code, that dynamically evaluates to a XMPresentation/ChangeabilityAspectCondition.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/ChangeabilityAspectIncludeRegExp

Description

Deprecated: please use the more comprehensive solution XMPresentation/ChangeabilityAspectCondition.
If specified, the feature is only changeable if the current aspect is matched by this regular expression. The current aspect is an external concept in the user realm. It is typically a string which is selected somehow implicitly or explicitly by the user and symbolises a certain aspect the user wants to see, in other words a point of view of the application she takes. Examples of aspects might be "overview", "customer", "management" or "system_diagnostics".
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/ChangeabilityAspectExcludeRegExp

Description

Deprecated: please use the more comprehensive solution XMPresentation/ChangeabilityAspectCondition.
If specified, the feature is only changeable if the current aspect is not matched by this regular expression. The current aspect is an external concept in the user realm. It is typically a string which is selected somehow implicitly or explicitly by the user and symbolises a certain aspect the user wants to see, in other words a point of view of the application she takes. Examples of aspects might be "overview", "customer", "management" or "system_diagnostics".
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/ChangeabilityViewCondition

Description

If specified, the feature is only changeable if the current view is matched by this condition. The current view is a concept within the VUI assemply tier. I.e., it is seperated from (external to) the business logic, but also separated from the user realm (internal to the system from the users perspective).
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/ChangeabilityViewConditionSource

Description

Code, that dynamically evaluates to a XMPresentation/ChangeabilityViewCondition.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/ChangeabilityViewIncludeRegExp

Description

Deprecated: please use the more comprehensive solution XMPresentation/ChangeabilityViewCondition.
If specified, the feature is only changeable if the current view is matched by this regular expression. The current view is a concept within the VUI assemply tier. I.e., it is seperated from (external to) the business logic, but also separated from the user realm (internal to the system from the users perspective).
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/ChangeabilityViewExcludeRegExp

Description

Deprecated: please use the more comprehensive solution XMPresentation/ChangeabilityViewCondition.
If specified, the feature is only changeable if the current view is not matched by this regular expression. The current view is a concept within the VUI assemply tier. I.e., it is seperated from (external to) the business logic, but also separated from the user realm (internal to the system from the users perspective).
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/ChangeabilityModes

Description

A list of VUI adapter modes within which the respective attribute is changeable. VUI modes are an internal concept in the VUI/BL adapter realm. They are a classification of modes in which adapters are used. The current mode is provided by some context, e.g. a containing transaction or space. Predefined modes are "readonly" and "readwrite", but an application can use arbitrary ones.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/ChangeabilityStates

Description

A list of VUI transaction states within which the respective attribute is changeable. This is only valid within transactional classes which declare a visible state, see XMVUI/TransactionStateExpression.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/Changeability

Description

Code, that dertermines dynamically whether the respective attribute or class as a whole is changeable. Note: a feature or class is only changeable if all changeability constraints do permit this. E.g., an attribute must not be marked as "readonly" in the core model, otherwise it is never changeable.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/ExecutabilityModes

Description

A list of VUI adapter modes within which the respective operation is executable. VUI modes are an internal concept in the VUI/BL adapter realm. They are a classification of modes in which adapters are used. The current mode is provided by some context, e.g. a containing transaction or space. Predefined modes are "readonly" and "readwrite", but an application can use arbitrary ones.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☐ attributes ∙ ☑ operations ∙ ☐ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/ExecutabilityStates

Description

A list of VUI transaction states within which the respective operation is executable. This is only valid within transactional classes which declare a visible state, see XMVUI/TransactionStateExpression.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☐ attributes ∙ ☑ operations ∙ ☐ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/Executability

Description

Code, that dertermines dynamically whether the respective operation is executable. Note: a feature is only executable if all executability constraints do permit this.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☐ attributes ∙ ☑ operations ∙ ☐ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/DefaultOperation

Description

Marks an operation to be executed by default when the user presses e.g. the return key in a dialog box.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☐ attributes ∙ ☑ operations ∙ ☐ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/Preview

Description

A small preview string describing the underlying ADO instance of a VUI adapter, typically based on it's attributes. Preview strings are used e.g. in choice lists and should be rather unique within a certain context. See also property 'DefaultPreview'.
Value of LastName and FirstName attributes, separated by comma
<Preview.TextJavaCodeTemplateForVUIInstance> @(LastName) + ", " + @(FirstName) </Preview.TextJavaCodeTemplateForVUIInstance>
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☐ attributes ∙ ☐ operations ∙ ☐ association ends ∙ ☐ states
Evaluation context: VUIObjectAdapter

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/PreviewObject

Description

Code, that produces a binary object describing the current value of a VUI adapter feature, like e.g. a thumbnail image.
Use thumbnail of image
<PreviewObject.JavaCodeTemplateForVUI> (new VUIThumbnail(context, @(Image), 128, 128)).get(context) </PreviewObject.JavaCodeTemplateForVUI>
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☐ association ends ∙ ☐ states
Evaluation context: VUIObjectAdapter

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/PreviewMediaType

Description

If provided, determines the media type of the Preview. The default is "text/plain".
Value of LastName and FirstName attributes, separated by comma
<PreviewMediaType.JavaCodeTemplate> TypeManager.getMediaTypeMIME(context, "text/html") </PreviewMediaType.JavaCodeTemplate>
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☐ association ends ∙ ☐ states
Evaluation context: VUIObjectAdapter

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/PreviewComplete

Description

If true, the provided preview contains already the complete information about this entity. That implies e.g. that it is not necessary to provide zooming capabilities for it.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☐ operations ∙ ☐ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/DefaultPreview

Description

If no preview is declared and this property is set to true, a default preview is generated which consists of a comma seperated list of all identifier attributes of this instance, i.e. all attributes with a PresentationImportance of "Identifier". This can be overridden by explicitly specifying a XMPresentation/PreviewPart.
Applies to
▸ Model level: ☑ logical model ∙ ☐ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☐ attributes ∙ ☐ operations ∙ ☐ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/DefaultPreviewFormat

Description

An alternate format string used in conjunction with the automatically generated default preview. Normally, the format string describes a comma separated list. With this format string, different formats than comma separated are possible. The advantage of using this property in contrast to XMPresentation/Preview, is, that still the runtime previews of the attributes are automatically generated, so this is easier to specify.
Use 'from' and 'till' previews, separated by a dash
<DefaultPreviewFormat> %(from) - %(till) </DefaultPreviewFormat>
Applies to
▸ Model level: ☑ logical model ∙ ☐ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☐ attributes ∙ ☐ operations ∙ ☐ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/PreviewPart

Description

If set to "Include" or "Exclude", explicitly defines whether this attribute is part or is not part of the automatically generated default preview.
If set to "IfIdentifier" (default), the participation is based on the Importance property as described at property XMPresentation/DefaultPreview.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☑ attributes ∙ ☑ operations ∙ ☑ association ends ∙ ☐ states
Evaluation context: ---

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/PreviewMany

Description

A small preview string describing an underlying collection of ADO instances inside a VUI many adapter, typically based on the elements of the collection. If no such PreviewMany is declared, no default is generated, independent of the setting of the property DefaultPreview.
Join previews of each item into comma separated list
<PreviewMany.TextJavaCodeTemplateForVUI> VUIUtilities.joinPreviews(context, getItems(context), ", ") </PreviewMany.TextJavaCodeTemplateForVUI>
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☑ classes ∙ ☐ attributes ∙ ☐ operations ∙ ☐ association ends ∙ ☐ states
Evaluation context: VUIManyAdapter

//Artefact:ModelAttribute/com/sphenon/modelling/xmodel/XMPresentation/TargetSpace

Description

If provided, evaluates to a String, which specifies the target space, which is navigated to after the respective operation has been executed. E.g., in an HTML interface, this will produce corresponding links, in addition to trigger parameters.
Applies to
▸ Model level: ☑ logical model ∙ ☑ technical model
▸ Model elements: ☐ packages ∙ ☐ classes ∙ ☐ attributes ∙ ☑ operations ∙ ☐ association ends ∙ ☐ states
Evaluation context: ---