com.beasys.commerce.foundation.property
Interface SchemaManager

public interface SchemaManager

This is the public interface for the schema manager. SchemaManager handles the intricacies of retrieving schemas, while hiding the various types of Schemas (Property Sets) from the developer.

Method Summary

java.util.Map	getDefaultValues(java.lang.String schemaName, java.lang.String schemaGroupName) Returns a Map of property name/default values for all properties in the given schema.
Schema	getSchema(java.lang.String schemaName, java.lang.String schemaGroupName) Returns a schema given a schema name and a schema group name.
SchemaHome	getSchemaHome(java.lang.String schemaGroupName) Convenience method for returning the appropriate SchemaHome for a given schema group.
java.util.Enumeration	getSchemas(java.lang.String schemaGroupName) Returns an Enumeration containing all the schemas found for a particular schema group.

Method Detail

getSchemaHome

public SchemaHome getSchemaHome(java.lang.String schemaGroupName)
                         throws java.rmi.RemoteException,
                                SchemaManagerException

Convenience method for returning the appropriate SchemaHome for a given schema group.

Parameters:

schemaGroupName - the name of the schema group

Returns:

the SchemaHome for a given schema group

Throws:

RemoteException - EJB error

SchemaManagerException - general error

getSchema

public Schema getSchema(java.lang.String schemaName,
                        java.lang.String schemaGroupName)
                 throws java.rmi.RemoteException,
                        SchemaManagerException

Returns a schema given a schema name and a schema group name.

Parameters:

schemaName - the name of the schema (property set)

schemaGroupName - the name of the schema group in which the schema exists

Returns:

a schema given a schema name and a schema group name

Throws:

RemoteException - EJB error

SchemaManagerException - general error

getSchemas

public java.util.Enumeration getSchemas(java.lang.String schemaGroupName)
                                 throws java.rmi.RemoteException,
                                        SchemaManagerException

Returns an Enumeration containing all the schemas found for a particular schema group.

Parameters:

schemaGroupName - the name of the schema group in which the schema exists

Returns:

an Enumeration containing all the schemas found for a particular schema group

Throws:

RemoteException - EJB error

SchemaManagerException - general error

getDefaultValues

public java.util.Map getDefaultValues(java.lang.String schemaName,
                                      java.lang.String schemaGroupName)
                               throws java.rmi.RemoteException,
                                      SchemaManagerException

Returns a Map of property name/default values for all properties in the given schema. If a property does not have a default value, the property name will be a key with a null value.

Parameters:

schemaName - the name of the schema (property set)

schemaGroupName - the name of the schema group in which the schema exists

Returns:

a Map of property name/default value pairs