JeeWiz Architect's Guide


	The Model-Driven System Builder

JeeWiz Architect's Guide

Contents > 14. 'Business Object' Reference

14.23 Field Object

Used on

internalClass

javaBean

Superclass java:field

Subclassed By

attribute

baseViewField

Description A field on an internal-class in the business object model (BOM).

This is a field intended for implementation; see 'attribute' for fields intended for exposure to callers.

The BOM 'field' meta-class adds the following facilities to the Java meta-model's 'field' meta-class:

constraints
getters and setters should be automatically produced by the rendering, governed by the readable and writeable properties.

Contained
Lists

1

Name   constraint

Type   constraint

Description   Constraints for this field (or attribute).

GenerateAllList   false

2

Name   style

Type   String

Description   You can specify one or more styles to give information to the code generation scripts. The meaning of the styles is up to the script writer.

The styles can be used as flags by the script calling $styleList.contains( "styleOfInterest" )

[ Currently, there is no built-in support for style="styleType=value" type semantics. This would have to be defined by each script writer. ]

Examples of the use of styles:

characteristics of a web page (e.g. should it be included in one of the menus)
whether an entity should be automatically mapped to a data-view (the 'maintain' style).
Note that styles and the 'group' property are different concepts, and therefore complimentary. Many modelling objects - such as data-views and their fields, or business methods - can be put into groups as a hint as to where to render the UI pages. Typically groups are used to define 'where' to place the meta class, whereas styles indicate how to render the object.

Unique   false

Inherited
properties

name from java:namedValue.name

description from java:interfaceMethod.description

template (base property)

text from java:interfaceMethod.text

jwpattern (base property)

type from java:namedValue.type

annotation from java:interfaceMethod.annotation

default from baseViewField.default

access from java:method.access

static from java:method.static

final from java:method.final

volatile from java:field.volatile

readonly from java:field.readonly

14.23.1	Property 'readable'
14.23.2	Property 'writeable'
14.23.3	Property 'uid'

14.23.1 Property 'readable'

*Description*	Defines whether a public 'getter' method will be generated to get the value.
*Type*	boolean
*Default*	true

14.23.2 Property 'writeable'

*Description*	Defines whether a public 'setter' method will be generated to set the attribute.
*Type*	boolean
*Default*	true

14.23.3 Property 'uid'

*Description*	The 'uid' is a Unique IDentifier for a methods in the business object model (and derivatives like J2EE). The 'uid' uniquely identifies the method, even if the name or signature of the method changes. This will normally be generated by the modelling tool; if not, it can be entered manually (but make sure it is unique!).
*Type*	String