com.beasys.commerce.foundation.property
Class SchemaValue

java.lang.Object
  |
  +--com.beasys.commerce.foundation.SmartValue
        |
        +--com.beasys.commerce.foundation.property.SchemaValue

public class SchemaValue

extends SmartValue

The Schema entity bean is used to define meta data about properties that can be set on a ConfigurableEntity. The primary key class of the Schema entity bean includes the schemaGroupName and the scopeName. The schemaGroupName serves as a namespace so that scopeNames can conveniently re-used for different application areas. Typically, the schemaGroupName is used to define the application area and the scopeName uniquely identifies the Schema within the application area. The Schema EJB provides the finder findBySchemaGroupName that returns the collection of all Schemas for a given schemaGroupName. The Schema entity bean used a Map of PropertyMetaData objects to store the meta data about properties. The names of the properties are the keys in the Map.

See Also:

Schema, SchemaHome, Schema.getSchemaByValue(), Schema.setSchemaByValue(SchemaValue), Serialized Form

Field Summary

java.lang.String	description A textual description for the Schema.
java.util.Map	propertyMetaData Containment: By Value Multiplicity: 0:N Interface: java.util.Map
java.lang.String	schemaGroupName Specifies the schema namespace for this Schema.
long	schemaId Unique ID used for the relationship with PropertyMetaData.
java.lang.String	scopeName Specifies the scopeName within the schemaGroupName for this Schema.

Constructor Summary

protected

SchemaValue() Only get/setSchemaByValue methods are allowed to call this constructor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

schemaGroupName

public java.lang.String schemaGroupName

Specifies the schema namespace for this Schema.

• Containment: By Value
• Multiplicity: 1:1
• PRIMARY KEY FIELD

scopeName

public java.lang.String scopeName

Specifies the scopeName within the schemaGroupName for this Schema.

• Containment: By Value
• Multiplicity: 1:1
• PRIMARY KEY FIELD

description

public java.lang.String description

A textual description for the Schema.

• Containment: By Value
• Multiplicity: 1:1

propertyMetaData

public java.util.Map propertyMetaData

• Containment: By Value
• Multiplicity: 0:N
• Interface: java.util.Map

schemaId

public long schemaId

Unique ID used for the relationship with PropertyMetaData.

• Containment: By Value
• Multiplicity: 1:1

Constructor Detail

SchemaValue

protected SchemaValue()

Only get/setSchemaByValue methods are allowed to call this constructor.