|
|
|
The Model-Driven System Builder
|
|
JeeWiz Architect's Guide
|
|
|
|
Contents >
14. 'Business Object' Reference
|
|
|
14.8 BaseViewEnd Object
| Used on |
|
| Superclass | associationEnd |
| Subclassed By |
|
| Description | Specifies the participation of a view object in a view-relation.
|
Contained
Lists |
| 1 |
|
| |
| 2 |
| Name | rolesReadonly |
| Type | String |
| Description | If the principal is not in the roles-allowed or the roles-blocked, they may have
their access limited to read only by being included in a role here.
|
| Unique | false |
|
| |
| 3 |
| Name | rolesAllowed |
| Type | String |
| Description | If no roles are specified all roles are allowed that are not explicitly prohibited,
otherwise only the specified roles are allowed.
|
| Unique | false |
|
| |
| 4 |
| Name | rolesBlocked |
| Type | String |
| Description | Members of these roles are blocked, whether they are granted permission elsewhere or not.
|
| Unique | false |
|
|
| Validation |
1.
The viewEnd's 'view' property does not name a view object in this jar/assembly
2.
The accessor property after defaults are applied must be non-null
3.
The accessor property after defaults are applied must be non-empty
4.
The accessor must start with a lower-case letter or '_'
5.
Objects of different types are at the end of the relation
|
Inherited
properties |
|
14.8.1 Property 'description'
|
| Overrides | associationEnd.description |
| Description | Optional description of the role of the object at this end in the parent relationship.
|
| Type | String |
14.8.2 Property 'view'
|
| Description | The name of the participating view (i.e. the one at 'this end' of the relationship).
This value is normally deduced from the UML model; in XML specifications, it can be entered directly.
|
| Type | String |
| Required | true |
14.8.3 Property 'endRoleName'
|
| Description | This optional property is for advanced use. It names the role of the object at this end of the view relation.
|
| Type | String |
14.8.4 Property 'externalName'
|
| Description | This is effectively the name of the related data-view i.e. what will appear on the screen
|
| Type | String |
14.8.5 Property 'format'
|
| Description | Allows variations of the style
|
| Type | String |
14.8.6 Property 'visible'
|
| Description | This property allows the field to be specified but without it appearing on a UI form as an input field.
This means that extra data can be added as part of the input without it requiring direct user intervention.
The default value is true - i.e. it will appear as an input field.
The standard patterns use invisible fields to hold the primary keys of related entities in summary views.
|
| Type | boolean |
| Default | true |
14.8.7 Property 'access'
|
| Description | In the business model, business object/methods and attributes are by definition public - they are designed for access by clients outside the object. Therefore the 'access' value is fixed at 'public'.
This factor hides the 'access' property from users.
However, the attribute can be set programmatically (i.e. in some patterns access is set to private) so that it will be rendered via normal field generators according to the architect's design.
|
| Type | String |
| Default | public |
| Hidden | true |
14.8.8 Property 'readable'
|
| Overrides | baseViewEnd.readable |
| Description | Defines whether a public 'getter' method will be generated to get the value.
|
| Type | boolean |
| Default | true |
14.8.9 Property 'writeable'
|
| Overrides | baseViewEnd.writeable |
| Description | Defines whether a public 'setter' method will be generated to set the attribute.
|
| Type | boolean |
| Default | true |
14.8.10 Property 'group'
|
| Description | A group is a hint to generation scripts as to where to place this object.
It provides an alternative, more flexbile way of grouping business-methods, objects, data-views and pages.
For example, pages for data-maintenance might be in the "DataMaintenance" group,
while specially-designed sessions might be in the "BusinessFunctions" group.
(Expressing this grouping cannot be derived from the hierarchy: all pages are children of a single application.)
Another usage could be to group fields for presentation based on their group name.
The 'group' property should be used to guide presentation to the user, whereas 'style' should be used to guide further pattern generation.
The 'default' group is the null value (script writers must use '#if( !$group )' to identify the default group.
|
| Type | String |
14.8.11 Property 'required'
|
| Overrides | associationEnd.required |
| Description | This determines whether a value needs to be input into this field.
This field applies to strings (text fields), dates and references to other objects.
It does not apply to numbers or money (currency) or other primitive data types.
|
| Type | boolean |
| Default | false |
14.8.12 Property 'screenPosition'
|
| Description | A numeric value indicating the position of this page or field within a group.
This affects the position of the item's display on the screen, relative to other members of the group.
The value is a string of 1-6 digits; the order is calculated numerically rather than alphabetically - so 25 is higher than 5.
Lower-valued positions appear first.
If this is not specified, then the order of controls within a group is determined by the order in the XML specification file.
The order within the specification can be set if the XML is being specified directly and this field need not be specified.
However, for specifications from UML design tools this may not be possible and it will be necessary to set this field to control screen order.
|
| Type | String |
| Delegates | true |
Copyright (c) 2001-2008 New Technology/enterprise Ltd.
| |
