JeeWiz Home  
The Model-Driven System Builder

JeeWiz Architect's Guide
 
Contents  >   14.  'Business Object' Reference
 


14.14 BusinessObject Object

SuperclassinternalClass
Subclassed By
attributeCollection
session
DescriptionThe business object in the business object model embodies the notion of a logical object with

  • attributes (from the business object model) and fields (from the Java meta-model)
  • methods (from the business object model) and methods from the Java meta-model
  • constraints that can apply to the whole holds business object.
If you are used to UML modelling, the business-object maps to the notion of a UML class with the idea that it provides a service outside of a particular location (i.e. package, or EJB container).

The 'access' for these objects is therefore fixed at public.

The business-object is used as a base for entities and sessions, which should be used if applicable in preference to business-object itself.
Contained
Lists
1
Name  typeParameter
Type  java:typeParameter
Inherited from  java:referenceType
 
2
Name  import
Type  String
Inherited from  java:referenceType
 
3
Name  field
Type  java:field
Inherited from  internalClass
 
4
Name  method
Type  java:method
Inherited from  internalClass
 
5
Name  implements
Type  String
Inherited from  java:jwclass
 
6
Name  constraint
Type  constraint
Inherited from  internalClass
 
7
Name  style
Type  String
Inherited from  internalClass
Validation The 'extends' attribute is not the name of a class
Inherited
properties
name from java:referenceType.name

description from java:interfaceMethod.description

template from java:interfaceMethod.template

text from java:method.text

jwpattern (base property)

typeDeclaration from java:referenceType.typeDeclaration

extends from java:referenceType.extends

headerComment from java:referenceType.headerComment

customerHeaderComment from java:referenceType.customerHeaderComment

package from baseViewRelation.package

generateLogLevel from java:method.generateLogLevel

annotation from java:interfaceMethod.annotation

abstract from java:method.abstract

static from java:method.static

serializable from java:jwclass.serializable

final from java:method.final

alwaysGenerateTriggers from internalClass.alwaysGenerateTriggers

constraintExceptionType from internalClass.constraintExceptionType

uid from method.uid

 14.14.1  Property 'access'
 14.14.2  Property 'group'
 14.14.3  Property 'userNameBase'
 14.14.4  Property 'generatePagesForBusinessMethods'

14.14.1  Property 'access'
Overridesjava:method.access
DescriptionIn 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.
TypeString
Defaultpublic
Hiddentrue

14.14.2  Property 'group'
OverridesbusinessMethod.group
DescriptionA 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.
TypeString

14.14.3  Property 'userNameBase'
OverridesbusinessMethod.userNameBase
DescriptionThis is the user-visible name for this object (currently it is used on business objects, business-methods and data-views.

In the standard rendering, this is further embellished in component.properties to create the userName, which the user will actually see.

For example, say the name of a session object is AccountTransaction. Then the default for the user-name-base will be 'Account Transaction'. This will be embellished in component.properties to give the userName 'Account Transactions'.

Either the userNameBase or the userName can then be used in scripts.
TypeString

14.14.4  Property 'generatePagesForBusinessMethods'
DescriptionSet this to 'true' to generate pages based on a business method.

The default for this value (which is true in the standard distribution) comes from the generatePagesForBusinessMethods setting in the system.properties file. If you want to disable this for a particular object, set the value to 'false'.

The standard pattern triggered by this value creates a page with a single button that will be linked to the business method.
Typeboolean
Delegatestrue
 


Copyright (c) 2001-2008 New Technology/enterprise Ltd.