|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EntityPropertyManager
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.
ConfigurableEntity
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 propertySet)
Returns a list of dynamically assigned properties for the given entity, that have been named with the given property set name. |
String[] |
getEntityNames(String jndiName)
Return a list of Entity names that have this jndi name. |
String |
getHomeName(long anEntityId)
Get the JNDI home name 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. |
Methods inherited from interface javax.ejb.EJBObject |
---|
getEJBHome, getHandle, getPrimaryKey, isIdentical, remove |
Method Detail |
---|
EntityPropertyCache getProperties(PropertyLocator locator) throws RemoteException, EntityNotFoundException
locator
- a PropertyLocator that identifies the entity
RemoteException
EntityNotFoundException
Object getProperty(PropertyLocator locator, String propertySet, String propertyName) throws RemoteException, EntityNotFoundException
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
RemoteException
EntityNotFoundException
long getUniqueId(String homeName, String pkString) throws RemoteException, EntityNotFoundException
If the entity is not found, -1 will be returned.
homeName
- the entity's JNDI home namepkString
- the entity's string identifier
RemoteException
EntityNotFoundException
void removeProperties(PropertyLocator locator) throws RemoteException, EntityNotFoundException
locator
- a PropertyLocator identifying the entity to modify
RemoteException
EntityNotFoundException
Object removeProperty(PropertyLocator locator, String propertySet, String propertyName) throws RemoteException, EntityNotFoundException
locator
- a PropertyLocator identifying the entity to modifypropertySet
- the property set containing the property to removepropertyName
- the name of the property to remove
RemoteException
EntityNotFoundException
void setProperty(PropertyLocator locator, String propertySet, String propertyName, Object value) throws RemoteException, PropertyValidationException, EntityNotFoundException
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
PropertyValidationException
- if the value is not valid for the given property
RemoteException
EntityNotFoundException
String[] getDynamicProperties(PropertyLocator locator, String propertySet) throws RemoteException, 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.
locator
- a PropertyLocator identifying the entity to look uppropertySet
- the propertySet to look up
RemoteException
EntityNotFoundException
long createUniqueId(String jndiHomeName, String pkString) throws RemoteException, ConfigurableEntityCreateException
jndiHomeName
- the entity's home namepkString
- the entity's identifier string
ConfigurableEntityCreateException
- if there is an error
RemoteException
void removeEntity(PropertyLocator locator) throws RemoteException, EntityNotFoundException
locator
- the PropertyLocator identifying the entity to remove
RemoteException
EntityNotFoundException
String getHomeName(long anEntityId) throws RemoteException, EntityNotFoundException
anEntityId
- the unique id for the entity to look up
RemoteException
EntityNotFoundException
PropertyLocator getPropertyLocator(long anEntityId) throws RemoteException, EntityNotFoundException
anEntityId
- the unique id for the entity to look up
RemoteException
EntityNotFoundException
String[] getEntityNames(String jndiName) throws RemoteException
jndiName
- the jndiName to query
RemoteException
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |