com.beasys.commerce.foundation.property
Interface EntityPropertyManager

All Superinterfaces:

BusinessSmartComponent, javax.ejb.EJBObject, java.rmi.Remote, java.io.Serializable, Session

All Known Subinterfaces:

EntityPropertyAggregator, LDAPEntityPropertyManager

public interface EntityPropertyManager

extends Session

This class is used to expedite access to EntityProperties and the mapping of their names. This stateful session bean will "cache" a set of Entity Properties

See Also:

EntityPropertyManagerHome, EntityPropertyManagerImpl

Method Summary

void	addPropertyValue(PropertyLocator locator, java.lang.String scopeName, java.lang.String key, java.lang.Object value)
void	addPropertyValueMapped(PropertyLocator locator, java.lang.String scopeName, java.lang.String key, java.lang.String mapKey, java.lang.Object value)
java.lang.String[]	getDynamicProperties(PropertyLocator locator, java.lang.String scopeName) Returns a list of dynamically assigned properties for the given entity, that have been named with the given scope name.
java.util.Map	getProperties(PropertyLocator locator) Returns a map of PropertyMapKey to Objects for all properties set for the entity.
java.util.Map	getProperties(PropertyLocator locator, java.lang.String scopeName) Returns a map of PropertyMapKey to Objects for all properties set for the entity for the specified scope.
java.lang.Object	getProperty(PropertyLocator locator, java.lang.String scopeName, java.lang.String key) Returns the value of the property defined for the specified key and scopeName.
java.lang.Object	getPropertyDefault(PropertyLocator locator, java.lang.String scopeName, java.lang.String key) Returns the default value defined in the schema.
PropertyMetaData	getPropertyMetaData(PropertyLocator locator, java.lang.String scopeName, java.lang.String key) Returns the PropertyMetaData associated with the property specified the schema group name defined in the property locator, the scope name, and the key.
java.util.Enumeration	getPropertyMetaDatum(PropertyLocator locator)
java.util.Map	getSchemaDefaults(java.lang.String schemaName, java.lang.String schemaGroupName) Returns a map of property name/default value pairs for the given property set.
long	getUniqueId(java.lang.String homeName, java.lang.String pkString) Returns the number that uniquely identifies the entity specified by the home name and the pk string.
void	removeProperties(PropertyLocator locator) Removes all properties for all scopes associated with the entity specified by the property locator.
java.lang.Object	removeProperty(PropertyLocator locator, java.lang.String scopeName, java.lang.String key) Removes the property in the specified scope name for the entity specified by the property locator.
java.lang.Object	removePropertyValue(PropertyLocator locator, java.lang.String scopeName, java.lang.String key, java.lang.Object value)
java.lang.Object	removePropertyValueMapped(PropertyLocator locator, java.lang.String scopeName, java.lang.String key, java.lang.String mapKey)
void	setProperties(PropertyLocator locator, java.util.Map propertyValues)
void	setProperty(PropertyLocator locator, java.lang.String scopeName, java.lang.String key, java.lang.Object value) Associates the property value to the entity identified by the locator for the specified scope and key.

Methods inherited from interface javax.ejb.EJBObject

getEJBHome, getHandle, getPrimaryKey, isIdentical, remove

Method Detail

addPropertyValue

public void addPropertyValue(PropertyLocator locator,
                             java.lang.String scopeName,
                             java.lang.String key,
                             java.lang.Object value)
                      throws java.rmi.RemoteException

addPropertyValueMapped

public void addPropertyValueMapped(PropertyLocator locator,
                                   java.lang.String scopeName,
                                   java.lang.String key,
                                   java.lang.String mapKey,
                                   java.lang.Object value)
                            throws java.rmi.RemoteException

getProperties

public java.util.Map getProperties(PropertyLocator locator)
                            throws java.rmi.RemoteException

Returns a map of PropertyMapKey to Objects for all properties set for the entity.

getProperties

public java.util.Map getProperties(PropertyLocator locator,
                                   java.lang.String scopeName)
                            throws java.rmi.RemoteException

Returns a map of PropertyMapKey to Objects for all properties set for the entity for the specified scope.

getProperty

public java.lang.Object getProperty(PropertyLocator locator,
                                    java.lang.String scopeName,
                                    java.lang.String key)
                             throws java.rmi.RemoteException

Returns the value of the property defined for the specified key and scopeName. If the property is not defined then null is returned.

getPropertyMetaData

public PropertyMetaData getPropertyMetaData(PropertyLocator locator,
                                            java.lang.String scopeName,
                                            java.lang.String key)
                                     throws java.rmi.RemoteException

Returns the PropertyMetaData associated with the property specified the schema group name defined in the property locator, the scope name, and the key.

getPropertyMetaDatum

public java.util.Enumeration getPropertyMetaDatum(PropertyLocator locator)
                                           throws java.rmi.RemoteException

getUniqueId

public long getUniqueId(java.lang.String homeName,
                        java.lang.String pkString)
                 throws java.rmi.RemoteException

Returns the number that uniquely identifies the entity specified by the home name and the pk string. If the entity does not have a unique id assigned, a new one will be created.

removeProperties

public void removeProperties(PropertyLocator locator)
                      throws java.rmi.RemoteException

Removes all properties for all scopes associated with the entity specified by the property locator.

removeProperty

public java.lang.Object removeProperty(PropertyLocator locator,
                                       java.lang.String scopeName,
                                       java.lang.String key)
                                throws java.rmi.RemoteException

Removes the property in the specified scope name for the entity specified by the property locator.

removePropertyValue

public java.lang.Object removePropertyValue(PropertyLocator locator,
                                            java.lang.String scopeName,
                                            java.lang.String key,
                                            java.lang.Object value)
                                     throws java.rmi.RemoteException

removePropertyValueMapped

public java.lang.Object removePropertyValueMapped(PropertyLocator locator,
                                                  java.lang.String scopeName,
                                                  java.lang.String key,
                                                  java.lang.String mapKey)
                                           throws java.rmi.RemoteException

setProperty

public void setProperty(PropertyLocator locator,
                        java.lang.String scopeName,
                        java.lang.String key,
                        java.lang.Object value)
                 throws java.rmi.RemoteException

Associates the property value to the entity identified by the locator for the specified scope and key.

setProperties

public void setProperties(PropertyLocator locator,
                          java.util.Map propertyValues)
                   throws java.rmi.RemoteException

getPropertyDefault

public java.lang.Object getPropertyDefault(PropertyLocator locator,
                                           java.lang.String scopeName,
                                           java.lang.String key)
                                    throws java.rmi.RemoteException

Returns the default value defined in the schema.

getDynamicProperties

public java.lang.String[] getDynamicProperties(PropertyLocator locator,
                                               java.lang.String scopeName)
                                        throws java.rmi.RemoteException

Returns a list of dynamically assigned properties for the given entity, that have been named with the given scope name.

getSchemaDefaults

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

Returns a map of property name/default value pairs for the given property set.