11.15 Interface Object
| Used on |
|
| Description | This defines an interface in the business object model.
Imports specified in the containing jar will be included in the interface's import list.
|
Contained
Lists |
| 1 |
| Name | import |
| Type | String |
| Description | List of classes or packages to import. The imports get put into 'import' statements in the *.java files (and could be put in a 'using' statement in C#).
In XML, you can use one or more <import> nested elements as an alternative to the 'import=' property.
See also the import list on the Business Object Model jar, which provides additional facilities.
|
| Unique | false |
|
| |
| 2 |
| Name | typeParameter |
| Type | typeParameter
|
| Description | A list of type-parameters on the reference-type.
If this is a generic type, then there will be one or more type-parameter's.
In the current implementation,
(a) type-parameters can also be specified via the name, in which case they should be in canonical form
... define.
This approach should really be used as a last resort, and trigger a rethink ...!
(b) once the canonical name for a reference-type is generated from a list of type-parameters,
the type-parameters are ignored (in the current implementation).
Therefore, the implementation is oriented towards patterns that produce type-parameters, and modelled classes
(which will then have to generate the type-parameters).
|
| GenerateAllList | false |
|
| |
| 3 |
| Name | interfaceField |
| Type | interfaceField
|
| Description | A list of fields on an interface or class. Fields on the interface should have a default (the constant value).
The synonym 'field' can be used on interfaces, but when used on interfaces it will create an 'interface-field',
which has fewer properties than the field on a class and a restricted rendering.
|
| Indexed property | name |
|
| |
| 4 |
| Name | interfaceMethod |
| Type | interfaceMethod
|
| Description | A list of interface-methods on the interface.
The synonym 'method' can be used on interfaces, but when used on interfaces it will create an 'interface-method',
which has fewer properties than the method on a class and a restricted rendering.
|
| Indexed property | name |
|
| |
| 5 |
| Name | intEnum |
| Type | intEnum
|
| Description | List of simplified int-enums on the class or interface.
|
| Indexed property | name |
|
|
Inherited
properties |
|
11.15.1 Property 'access'
|
| Description | Specifies the access control for the attribute.
The default access is specifically null, so that there is no access control value placed in the code.
This is necessary because the default for the access changes depending on the context.
|
| Type | String |
| Choices |
| <empty> (default) |
| private |
| protected |
| public |
|
11.15.2 Property 'description'
|
| Description | Optional description.
Use this to
- document the meaning of a particular item
- specify functionality at the design stage for implementation later.
|
| Type | String |
11.15.3 Property 'extends'
|
| Description | Specifies the class or interface that this class or interface extends from. This field is optional.
The value of 'extends' can be
- an external class - in which case it must have a '.' in it
- a reference to a class or interface in another model, in 'model:object' form
- or the name of a class or interface in this model, without either a '.' or ':'.
References to simple classes must be fully-qualified if the referenced class is not in the same package as the current class.
Business objects (entities, sessions, etc.) in the businessObject model normally reference each other by name only
and there is then a restriction that business object names of a certain type must be unique
(e.g. you can't have two entities named 'E').
The 'extends' type is added to the 'implements' list in C# and the appended to the class name with ':'
(e.g. "class C : ExtendedClass,ImplementedInterface {}" ).
In Java systems, the 'extends' keyword is used.
|
| Type | String |
11.15.4 Property 'name'
|
| Description | Specifies name of the interface or class.
This should be a valid Java identifier name and will be used as-is as the interface or class name.
|
| Type | String |
| Required | true |
11.15.5 Property 'package'
|
| Alias | namespace |
| Description | This is the package attribute: it declares the name of the package that this interface (or class, or entity, etc.) belongs to.
It can be used on
- reference types (interfaces and classes) and all their derivatives
- associations
- assemblies of model-objects
- containers of same, like jars.
It uses delegation of responsibility to search its parent chain. For example, in the J2EE realm, this means that the package can be specified on (working up the containment chain):
- an entity,
- or its ejb-jar,
- or the application,
- or in the assembly
- or in the build properties '.jwp' file.
If none of these is specified the package will be null.
Null packages are not recommended but legal for simple Java builds.
For larger systems, null packages are not allowed.
The combination of the package and class name (i.e. the fully-qualified Java classname) must be unique
across all reference types and their derivatives in a build.
|
| Type | String |
|
