|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.7.0) E15995-06 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPropertyLocator
A locator used for managing propertysets. The implementation classes are required to implement loadProperties(IContext, IPropertySet, IPropertySetDefinition, java.util.List)
method. All the unsupported methods should throw UnsupportedOperationException
exception. They are also responsible for maintaining createdOn ITimestamped.setCreatedOn(java.sql.Timestamp)
and updatedOn ITimestamped.setUpdatedOn(java.sql.Timestamp)
for all the entities. The property service will use an implementation instance found based on the following precedence order.
IPropertyMapping.getPropertyLocatorClassName()
IPropertySetDefinition.getPropertyLocatorClassName()
INamespace.getPropertyLocatorClassName()
Please refer to the deployment guide for how to deploy locators onto the property service server.
Method Summary | |
---|---|
int |
count(IContext context, INamespaceName namespaceName, IPropertySetDefinitionName setDefinitionName, PropertySetExpression expression) Returns the number of propertysets that satisfy the given expression . |
IPagedList<IPropertySet> |
filter(IContext context, INamespaceName namespaceName, IPropertySetDefinitionName setDefinitionName, PropertySetFilterContext filterContext) Filters propertysets based on the given filterContext . |
void |
loadProperties(IContext context, IPropertySet propertySet, IPropertySetDefinition propertySetDefinition, java.util.List<IPropertyName> propertyNames) Adds properties to the given propertySet for the property names in the given propertyNames list. |
void |
removeProperties(IContext context, INamespaceName namespaceName, IPropertySetDefinitionName propertySetDefinitionName) Remove all the properties of all the propertysets in the given namespaceName and propertySetDefinitionName . |
void |
removeProperties(IContext context, IPropertySet propertySet, java.util.List<IPropertyName> propertyNames) Removes the properties identified by the property names in the given propertyNames list. |
void |
storeProperties(IContext context, IPropertySet propertySet, IPropertySetDefinition propertySetDefinition, java.util.List<IPropertyName> propertyNames) Stores the properties present in the given propertySet . |
Method Detail |
---|
void loadProperties(IContext context, IPropertySet propertySet, IPropertySetDefinition propertySetDefinition, java.util.List<IPropertyName> propertyNames) throws OperationFailedException
propertySet
for the property names in the given propertyNames
list. The propertySetDefinition
to which the given propertySet
belongs to is also passed to access property mappings.context
- a property service context.propertySet
- a propertySet instance to which properties are added.propertySetDefinition
- the associated propertysetdefinition.propertyNames
- a list of property names of properties to be loaded.OperationFailedException
- if the process of loading fails.void storeProperties(IContext context, IPropertySet propertySet, IPropertySetDefinition propertySetDefinition, java.util.List<IPropertyName> propertyNames) throws OperationFailedException
propertySet
. The list of properties that this locator is responsible to store are in the propertyNames
list.context
- a property service context.propertySet
- a propertyset that contains properties to store.propertySetDefinition
- the propertysetdefinition that the given propertySet
belongs to.propertyNames
- a list of property names of the properties to store.OperationFailedException
- if the process of storing fails.java.lang.UnsupportedOperationException
- if this operation is not supported.void removeProperties(IContext context, IPropertySet propertySet, java.util.List<IPropertyName> propertyNames) throws OperationFailedException
propertyNames
list. The given propertySet
contains propertyset name, propertysetdefinition name, namespace name and properties.context
- a property service context.propertySet
- a propertyset whose properties need to be removed.propertyNames
- a list of property names of the properties to remove.OperationFailedException
- if the process of removing fails.java.lang.UnsupportedOperationException
- if this operation is not supported.void removeProperties(IContext context, INamespaceName namespaceName, IPropertySetDefinitionName propertySetDefinitionName) throws OperationFailedException
namespaceName
and propertySetDefinitionName
.context
- a property service context.namespaceName
- a namespace name.propertySetDefinitionName
- a propertysetdefinition name.OperationFailedException
- if the process of removing fails.java.lang.UnsupportedOperationException
- if this operation is not supported.IPagedList<IPropertySet> filter(IContext context, INamespaceName namespaceName, IPropertySetDefinitionName setDefinitionName, PropertySetFilterContext filterContext) throws OperationFailedException
filterContext
.context
- a property service context.namespaceName
- a namespace name.setDefinitionName
- a propertysetdefinition name.filterContext
- a filter context that contains search expression and pagination context.OperationFailedException
- if the process of filtering fails.java.lang.UnsupportedOperationException
- if this operation is not supported.int count(IContext context, INamespaceName namespaceName, IPropertySetDefinitionName setDefinitionName, PropertySetExpression expression) throws OperationFailedException
expression
.context
- a property service context.namespaceName
- a namespace name.setDefinitionName
- a propertysetdefinition name.expression
- a propertyset expression.expression
.OperationFailedException
- if the process of counting fails.java.lang.UnsupportedOperationException
- if this operation is not supported.
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.7.0) E15995-06 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |