@ejb.value-object-method

Scope: method

Multiplicity

(0..*): You can use this tag zero to many times in the Java™ source file.

Purpose

This tag defines ValueObjects that follow the TransferObject pattern from http://java.sun.com/blueprints/corej2eepatterns/Patterns/TransferObject.html. ValueObjects can link to other objects (of a relation) in two ways: aggregation and composition. Aggregation means that the other object is loosely coupled, while Composition means that the other object is embedded. Aggregation and composition are mutually exclusive. See also http://xdoclet.sourceforge.net/valueobjects.html for more info. Applies to entity beans.

Parameters

Parameter Type Applicability Description Mandatory
name text   The name for this value object. The name will be used to form the generated class name. Using the default pattern, for example, if name is User, an UserValue class will be generated.  
match text   An identifier that can be used to select groups of attributes to be included in this value object. You can repeat this identifier in the method-level @ejb.value-object tag to add a property to a value object. You can use an asterisk (*) as a special value, to indicate that all entity properties will be included in this value object. false
extends text   The name of the class that the generated value object class extends, if any. false
implements text   A comma-separated list of interfaces the generated value object implements, if any.
Note: XDoclet will not generate methods to implement these interfaces, so use this only if the interfaces do not contain any methods, or if the value object superclass (indicated in the extends parameter) already implements all interface methods.
false
abstract boolean   Set if this value object is intended to be an abstract object which other value objects extend. false
generatePKConstructor boolean   Set if this value object should have a single argument constructor that sets the primary key only. It is useful when using aggregation and you want to create a relationship between a new object and an existing object with the form of obj.addSomeObjectRelation(new SomeObject(pk)); false
Related reference
@ejb.bean
@ejb.create-method
@ejb.ejb-external-ref
@ejb.ejb-ref
@ejb.env-entry
@ejb.facade
@ejb.facade-method
@ejb.finder
@ejb.home
@ejb.home-method
@ejb.interface
@ejb.interface-method
@ejb.permission
@ejb.persistence
@ejb.persistence (method)
@ejb.pk
@ejb.pk-field
@ejb.relation
@ejb.remote-facade
@ejb.resource-env-ref
@ejb.resource-ref
@ejb.security-identity
@ejb.security-role-ref
@ejb.select
@ejb.session
@ejb.transaction
@ejb.util
@ejb.value-object
Terms of use | Feedback
(C) Copyright IBM Corporation 2000, 2005. All Rights Reserved.