JeeWiz Architect's Guide - StoField Object


	The Model-Driven System Builder

JeeWiz Architect's Guide

Contents > 14. 'Business Object' Reference

14.39 StoField Object

Superclass baseViewField

Description The STO field - a data field on a service transfer object.

The STO field turns into a field or property on the run-time STO. This typically is not generated by JeeWiz patterns.

Patterns also use the sto-field as the basis for creating

a data-view-field on the related data-view. The name of this field by adjusted by the related-data-view-field property.
a ui-view-field on the related ui-view. The name of this field by adjusted by the related-ui-view-field property.

Contained
Lists

1

Name   constraint

Type   constraint

Inherited from   baseViewField

2

Name   style

Type   String

Inherited from   internalClass

3

Name   rolesReadonly

Type   String

Inherited from   entity

4

Name   rolesAllowed

Type   String

Inherited from   entity

5

Name   rolesBlocked

Type   String

Inherited from   entity

Inherited
properties

name from baseViewField.name

description from relation.description

template (base property)

text from parameter.text

jwpattern (base property)

type from baseViewField.type

annotation from java:interfaceMethod.annotation

default from baseViewField.default

access from java:interface.access

static from java:method.static

final from java:parameter.final

volatile from java:field.volatile

readonly from java:field.readonly

readable from baseViewRelation.readable

writeable from baseViewRelation.writeable

uid from roleGroup.uid

onLoadExpression from baseViewField.onLoadExpression

onStoreExpression from baseViewField.onStoreExpression

filterExpression from baseViewField.filterExpression

lookupGroup from baseViewField.lookupGroup

lookupDataView from baseViewField.lookupDataView

lookupField from baseViewField.lookupField

orderable from baseViewField.orderable

renderSpecial from baseViewField.renderSpecial

htmlInsert from baseViewField.htmlInsert

group from businessMethod.group

required from baseViewField.required

convertEmptyStringsToNull from entity.convertEmptyStringsToNull

dontDisplay from baseViewField.dontDisplay

externalName from baseViewField.externalName

summaryName from baseViewField.summaryName

useOnSummary from baseViewField.useOnSummary

useOnSearch from baseViewField.useOnSearch

textEvent from baseViewField.textEvent

screenPosition from baseViewField.screenPosition

uiControl from baseViewField.uiControl

format from baseViewField.format

14.39.1	Property 'relatedDataViewField'
14.39.2	Property 'relatedUiViewField'
14.39.3	Property 'notOnSto'
14.39.4	Property 'notOnDataView'
14.39.5	Property 'notOnUiView'
14.39.6	Property 'onProviderRequestExpression'
14.39.7	Property 'onProviderResponseExpression'
14.39.8	Property 'onConsumerRequestExpression'
14.39.9	Property 'onConsumerResponseExpression'

14.39.1 Property 'relatedDataViewField'

*Description*	Specifies the data-view-field related to this stoField. This field is optional; the standard patterns use the name of the sto field by default.
*Type*	String

14.39.2 Property 'relatedUiViewField'

*Description*	Specifies the ui-view-field related to this stoField. This field is optional; the standard patterns generated a suitable default if necessary.
*Type*	String

14.39.3 Property 'notOnSto'

*Description*	If true, this flag prevents generation of the field on the generated STO class. This is only relevant if the run-time STO classes are generated under the control of JeeWiz. It may seem paradoxical to have a field modeled on the STO that does not appear on the run-time STO. However, this is perfectly sensible because the sto-field also generates fields on the data-view and ui-view meta classes. These fields can be calculated, by onProviderRequest (class-level method) or the onProviderRequestExpression for a data-view-field onConsumerResponse (class-level method) or the onConsumerResponseExpression for a ui-view-field.
*Type*	boolean
*Default*	false

14.39.4 Property 'notOnDataView'

*Description*	If true, this flag prevents generation of the field on the generated data-view class. If this flag is set, the sto-field input fields will be used to calculate other fields on the data-view. For example, say a birthDate sto-field has been modeled, but it is used in the backend as three separate fields - birthDay, birthMonth and birthYear. Then 'not-on-data-view' would be set for birthDate 'not-on-sto' would be set for birthDay, birthMonth and birthYear birthDate would probably be set by an OnProviderResponseExpression (but it could also be via the OnProviderResponse() method) birthDay, birthMonth and birthYear would probably be set by an OnProviderRequestExpression (but it could also be via the OnProviderRequest() method). 'not-on-data-view' can also be used by pattern writers when creating a number of dispersed and aggregate fields for a particular type - in this case the original field needs to be 'turned off'.
*Type*	boolean
*Default*	false

14.39.5 Property 'notOnUiView'

*Description*	If true, this flag prevents generation of the field on the generated ui-view class. If this flag is set, the sto-field input fields will be used to calculate other fields on the ui-view. For more information, see 'not-on-data-view'.
*Type*	boolean
*Default*	false

14.39.6 Property 'onProviderRequestExpression'

*Description*	If set, this must be an expression used to calculate the related data-view-field on a request (a call into the provider).
*Type*	String

14.39.7 Property 'onProviderResponseExpression'

*Description*	If set, this must be an expression used to calculate this field from the related data-view-field on a response (a value returned from a call to the provider).
*Type*	String

14.39.8 Property 'onConsumerRequestExpression'

*Description*	If set, this must be an expression used to calculate this field from the related ui-view-field on a request (a call from the consumer).
*Type*	String

14.39.9 Property 'onConsumerResponseExpression'

*Description*	If set, this must be an expression used to calculate the related ui-view-field from this field on a response (a value returned from a call to the consumer).
*Type*	String