com.beasys.commerce.foundation.property
Interface Schema

public interface Schema

extends Entity

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:

SchemaPk, SchemaHome, SchemaImpl, SchemaValue

Method Summary

void	clearPropertyMetaData() Removes all mappings from this map (optional operation).
boolean	containsKeyPropertyMetaData(java.lang.Object key) Returns true if this map contains a mapping for the specified key.
boolean	containsValuePropertyMetaData(PropertyMetaData element) Returns true if this map maps one or more keys to the specified value.
java.util.Set	entrySetPropertyMetaData() Returns a set view of the mappings contained in this map.
boolean	equalsPropertyMetaData(java.lang.Object object) Compares the specified object with this map for equality.
java.util.Map	getAllPropertyMetaData() Returns the entire map
java.lang.String	getDescription() Get the value of description
PropertyMetaData	getPropertyMetaData(java.lang.Object key) Returns the value to which this map maps the specified key.
SchemaValue	getSchemaByValue() Get all of Schema's attributes.
java.lang.String	getSchemaGroupName()
java.lang.String	getScopeName()
int	hashCodePropertyMetaData() Returns the hash code value for this map.
boolean	isEmptyPropertyMetaData() Returns true if this map contains no key-value mappings.
java.util.Set	keySetPropertyMetaData() Returns a set view of the keys contained in this map.
void	putAllPropertyMetaData(java.util.Map map) Copies all of the mappings from the specified map to this map (optional operation).
PropertyMetaData	putPropertyMetaData(java.lang.Object key, PropertyMetaData element) Associates the specified value with the specified key in this map (optional operation).
PropertyMetaData	removePropertyMetaData(java.lang.Object key) Removes the mapping for this key from this map if present (optional operation).
void	setAllPropertyMetaData(java.util.Map map) Sets the entire map
void	setDescription(java.lang.String description) Set the value of description
void	setSchemaByValue(SchemaValue value) Set all of Schema's attributes to the passed in value.
int	sizePropertyMetaData() Returns the number of key-value mappings in this map.
java.util.Collection	valuesPropertyMetaData() Returns a collection view of the values contained in this map.

Methods inherited from interface javax.ejb.EJBObject

getEJBHome, getHandle, getPrimaryKey, isIdentical, remove

Methods inherited from interface com.beasys.commerce.foundation.RemoteRelationalReference

get__classIdentifier, get__containingBelonging, get__containingEntity, get__mapKey, get__sequenceNumber, set__containingBelonging, set__containingEntity, set__mapKey

Method Detail

getSchemaByValue

public SchemaValue getSchemaByValue()
                             throws java.rmi.RemoteException

Get all of Schema's attributes.

Returns:

SchemaValue the Schema value object

setSchemaByValue

public void setSchemaByValue(SchemaValue value)
                      throws java.rmi.RemoteException

Set all of Schema's attributes to the passed in value. Note: Primary key attributes are not set.

Parameters:

SchemaValue - the Schema value object

getScopeName

public java.lang.String getScopeName()
                              throws java.rmi.RemoteException

getSchemaGroupName

public java.lang.String getSchemaGroupName()
                                    throws java.rmi.RemoteException

getDescription

public java.lang.String getDescription()
                                throws java.rmi.RemoteException

Get the value of description

Returns:

description.

setDescription

public void setDescription(java.lang.String description)
                    throws java.rmi.RemoteException

Set the value of description

Parameters:

description - description to be added

getAllPropertyMetaData

public java.util.Map getAllPropertyMetaData()
                                     throws java.rmi.RemoteException

Returns the entire map

setAllPropertyMetaData

public void setAllPropertyMetaData(java.util.Map map)
                            throws java.rmi.RemoteException

Sets the entire map

clearPropertyMetaData

public void clearPropertyMetaData()
                           throws java.rmi.RemoteException

Removes all mappings from this map (optional operation).

containsKeyPropertyMetaData

public boolean containsKeyPropertyMetaData(java.lang.Object key)
                                    throws java.rmi.RemoteException

Returns true if this map contains a mapping for the specified key.

containsValuePropertyMetaData

public boolean containsValuePropertyMetaData(PropertyMetaData element)
                                      throws java.rmi.RemoteException

Returns true if this map maps one or more keys to the specified value.

entrySetPropertyMetaData

public java.util.Set entrySetPropertyMetaData()
                                       throws java.rmi.RemoteException

Returns a set view of the mappings contained in this map.

equalsPropertyMetaData

public boolean equalsPropertyMetaData(java.lang.Object object)
                               throws java.rmi.RemoteException

Compares the specified object with this map for equality.

getPropertyMetaData

public PropertyMetaData getPropertyMetaData(java.lang.Object key)
                                     throws java.rmi.RemoteException

Returns the value to which this map maps the specified key.

hashCodePropertyMetaData

public int hashCodePropertyMetaData()
                             throws java.rmi.RemoteException

Returns the hash code value for this map.

isEmptyPropertyMetaData

public boolean isEmptyPropertyMetaData()
                                throws java.rmi.RemoteException

Returns true if this map contains no key-value mappings.

keySetPropertyMetaData

public java.util.Set keySetPropertyMetaData()
                                     throws java.rmi.RemoteException

Returns a set view of the keys contained in this map.

putPropertyMetaData

public PropertyMetaData putPropertyMetaData(java.lang.Object key,
                                            PropertyMetaData element)
                                     throws java.rmi.RemoteException

Associates the specified value with the specified key in this map (optional operation).

putAllPropertyMetaData

public void putAllPropertyMetaData(java.util.Map map)
                            throws java.rmi.RemoteException

Copies all of the mappings from the specified map to this map (optional operation).

removePropertyMetaData

public PropertyMetaData removePropertyMetaData(java.lang.Object key)
                                        throws java.rmi.RemoteException

Removes the mapping for this key from this map if present (optional operation).

sizePropertyMetaData

public int sizePropertyMetaData()
                         throws java.rmi.RemoteException

Returns the number of key-value mappings in this map.

valuesPropertyMetaData

public java.util.Collection valuesPropertyMetaData()
                                            throws java.rmi.RemoteException

Returns a collection view of the values contained in this map.