EJBObject
EntityPropertyManager is the remote interface for a session bean that manages persistence of ConfigurableEntity EJB's and their properties. The default implementation uses the WLPS database as its backing store, other implementations may use other datastores such as an LDAP server.
Each ConfigurableEntity must have an ejb-ref in its deployment descriptor that can be used to identify the correct EntityPropertyManager to use.
Related Topics
EJBObject
, Remote
CustomerPropertyManager
, LdapPropertyManager
Method Summary |
public long |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public long |
|
public void |
|
public void |
|
public |
|
public void |
|
Methods from interface javax.ejb. |
getEJBHome, getHandle, getPrimaryKey, isIdentical, remove |
Method Detail |
public long createUniqueId(Create a record for a new ConfigurableEntity, as identified by the given jndiHomeName and pkString.String
jndiHomeName,String
pkString)
throwsRemoteException
,ConfigurableEntityCreateException
RemoteException
ConfigurableEntityCreateException
publicReturns a list of dynamically assigned properties for the given entity, that have been named with the given property set name. Dynamic properties are properties that have values persisted, and may even have a property set name, but are not actually defined in a property set.String
[] getDynamicProperties(PropertyLocator
locator,String
propertySet)
throwsRemoteException
,EntityNotFoundException
Dynamic properties could exist if the property set definition has been changed to remove a property but the given entity still has a value for this property. They could also exist if the entity has properties that were set using the property set name as the scope, but the property set definition does not contain the properties.
If the given property set name is null then this method returns the property names that were set for this entity using null for the property set name.
RemoteException
EntityNotFoundException
publicReturn a list of Entity names that have this jndi name.String
[] getEntityNames(String
jndiName)
throwsRemoteException
RemoteException
publicGet the JNDI home name for the entity identified by the given entity idString
getHomeName(long anEntityId)
throwsRemoteException
,EntityNotFoundException
RemoteException
EntityNotFoundException
publicReturns an EntityPropertyCache full of all properties that are persisted for the given ConfigurableEntityEntityPropertyCache
getProperties(PropertyLocator
locator)
throwsRemoteException
,EntityNotFoundException
RemoteException
EntityNotFoundException
publicReturns the value of the property defined for the specified property and property set.Object
getProperty(PropertyLocator
locator,String
propertySet,String
propertyName)
throwsRemoteException
,EntityNotFoundException
If the property does not have a value persisted, then null is returned.
RemoteException
EntityNotFoundException
publicGet the PropertyLocator for the entity identified by the given entity idPropertyLocator
getPropertyLocator(long anEntityId)
throwsRemoteException
,EntityNotFoundException
RemoteException
EntityNotFoundException
public long getUniqueId(Returns the number that uniquely identifies the entity specified by the home name and the pk string.String
homeName,String
pkString)
throwsRemoteException
,EntityNotFoundException
If the entity is not found, -1 will be returned.
RemoteException
EntityNotFoundException
public void removeEntity(Remove all properties, and the entity record, for the entity identified by the given property locatorPropertyLocator
locator)
throwsRemoteException
,EntityNotFoundException
RemoteException
EntityNotFoundException
public void removeProperties(Removes all property values associated with the entity specified by the property locator.scopePropertyLocator
locator)
throwsRemoteException
,EntityNotFoundException
RemoteException
EntityNotFoundException
publicRemoves a specific property value from the entity specified by the property locator.Object
removeProperty(PropertyLocator
locator,String
propertySet,String
propertyName)
throwsRemoteException
,EntityNotFoundException
RemoteException
EntityNotFoundException
public void setProperty(Sets the property identified by the given property set and property name to the given value for the entity specified by the given property locator.PropertyLocator
locator,String
propertySet,String
propertyName,Object
value)
throwsRemoteException
,PropertyValidationException
,EntityNotFoundException
RemoteException
PropertyValidationException
EntityNotFoundException