@ws.sdo.value-object (class-level)

 

Scope

Class

 

Multiplicity

(0..*): You can use this tag zero or more times on any Java source file that implements a CMP entity bean.

 

Purpose

This tag defines a value object that encompasses some subset of the CMP entity bean's fields and container-managed relationships (CMR fields). A Service Data Object (SDO) class will be generated for each value-object. The “default” value-object contains members for all the CMP fields defined in the bean. Value objects with a subset of CMP fields are commonly referred to as “light” objects, and value objects that contain members for CMR fields are commonly referred to as “deep” objects. When a CMR field is added to a value-object, then there must also be a value-object defined for the related CMP bean. For example, if the “address” CMR field of user is added to the “User” value-object, then a value-object named “Address” (or in this case default) must be defined on the “Address” CMP entity bean.

 

Parameters

Parameter	Type	Applicability	Description	Mandatory
name	text	All	The abstract name of the value object. The name must be unique to the EJB module, and must be a valid Java identifier. The generated class name will be the SDO name. By default all CMP fields and no CMR fields are included in the generated SDO.	True
read-only	boolean	All	If true, indicates that only "read" methods should be created on the session façade.	False

 

Parent topic

Annotations for session facades and SDOs