|
© 2003 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
This control requires that the EntityProperty EJB has been deployed to the application. The EntityProperty EJB is contained in p13n_ejb.jar, and is automatically deployed as part of a Portal application.
EntityPropertyManager
,
EntityPropertyCache
,
ConfigurableEntity
,
PropertyLocator
Method Summary | |
long |
createUniqueId(String jndiHomeName,
String pkString)
Create a record for a new ConfigurableEntity, as identified by the given jndiHomeName and pkString. |
String[] |
getDynamicProperties(PropertyLocator locator,
String pkString)
Returns a list of dynamically assigned properties for the given entity, that have been named with the given property set name. |
String[] |
getEntityNames(String anEntityId)
Get the PropertyLocator for the entity identified by the given entity id |
EntityPropertyCache |
getProperties(PropertyLocator locator)
Returns an EntityPropertyCache full of all properties that are persisted for the given ConfigurableEntity |
Object |
getProperty(PropertyLocator locator,
String propertySet,
String propertyName)
Returns the value of the property defined for the specified property and property set. |
PropertyLocator |
getPropertyLocator(long anEntityId)
Get the PropertyLocator for the entity identified by the given entity id |
long |
getUniqueId(String homeName,
String pkString)
Returns the number that uniquely identifies the entity specified by the home name and the pk string. |
void |
removeEntity(PropertyLocator locator)
Remove all properties, and the entity record, for the entity identified by the given property locator |
void |
removeProperties(PropertyLocator locator)
Removes all property values associated with the entity specified by the property locator.scope |
Object |
removeProperty(PropertyLocator locator,
String propertySet,
String propertyName)
Removes a specific property value from the entity specified by the property locator. |
void |
setProperty(PropertyLocator locator,
String propertySet,
String propertyName,
Object value)
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. |
Method Detail |
public long createUniqueId(String jndiHomeName, String pkString) throws P13nControlException
jndiHomeName
- the entity's home namepkString
- the entity's identifier string
P13nControlException
- if there is an error creating the new Configurable
Entity.public String[] getDynamicProperties(PropertyLocator locator, String pkString) throws P13nControlException
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.
locator
- a PropertyLocator identifying the entity to look up
P13nControlException
- if the Entity cannot be foundpublic String[] getEntityNames(String anEntityId) throws P13nControlException
anEntityId
- the unique id for the entity to look up
P13nControlException
- if database errors occur while attempting the
querypublic EntityPropertyCache getProperties(PropertyLocator locator) throws P13nControlException
locator
- a PropertyLocator that identifies the entity
P13nControlException
- if the entity is not foundpublic Object getProperty(PropertyLocator locator, String propertySet, String propertyName) throws P13nControlException
If the property does not have a value persisted, then null is returned.
locator
- a PropertyLocator identifying the entity to look uppropertySet
- the name of the property setpropertyName
- the name of the property
P13nControlException
- if the Entity cannot be foundpublic PropertyLocator getPropertyLocator(long anEntityId) throws P13nControlException
anEntityId
- the unique id for the entity to look up
P13nControlException
- if the Entity cannot be foundpublic long getUniqueId(String homeName, String pkString) throws P13nControlException
If the entity is not found, -1 will be returned.
homeName
- the entity's JNDI home namepkString
- the entity's string identifier
P13nControlException
- if the Entity cannot be foundpublic void removeEntity(PropertyLocator locator) throws P13nControlException
locator
- the PropertyLocator identifying the entity to remove
P13nControlException
- if the Entity cannot be foundpublic void removeProperties(PropertyLocator locator) throws P13nControlException
locator
- a PropertyLocator identifying the entity to modify
P13nControlException
- if the Entity cannot be foundpublic Object removeProperty(PropertyLocator locator, String propertySet, String propertyName) throws P13nControlException
locator
- a PropertyLocator identifying the entity to modifypropertySet
- the property set containing the property to removepropertyName
- the name of the property to remove
P13nControlException
- if the Entity cannot be foundpublic void setProperty(PropertyLocator locator, String propertySet, String propertyName, Object value) throws P13nControlException
locator
- a PropertyLocator identifying the entity to modifypropertySet
- the property set containing the property to modifypropertyName
- the name of the property to modifyvalue
- the value to persist for the given property and entity
P13nControlException
- if the entity cannot be found, or if
the value is not valid for the given property
|
© 2003 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |