Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal
11g Release 1 (11.1.1.6.0)
E15995-05


oracle.wcps.property
Interface IPropertyLocator

All Known Subinterfaces:
IPeoplePropertyLocator
All Known Implementing Classes:
AbstractPeoplePropertyLocator, PeoplePropertyLocator

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.

  1. IPropertyMapping.getPropertyLocatorClassName()
  2. IPropertySetDefinition.getPropertyLocatorClassName()
  3. INamespace.getPropertyLocatorClassName()
  4. default property locator

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

loadProperties

void loadProperties(IContext context,
                    IPropertySet propertySet,
                    IPropertySetDefinition propertySetDefinition,
                    java.util.List<IPropertyName> propertyNames)
                    throws OperationFailedException
Adds properties to the given 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.
Parameters:
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.
Throws:
OperationFailedException - if the process of loading fails.

storeProperties

void storeProperties(IContext context,
                     IPropertySet propertySet,
                     IPropertySetDefinition propertySetDefinition,
                     java.util.List<IPropertyName> propertyNames)
                     throws OperationFailedException
Stores the properties present in the given propertySet. The list of properties that this locator is responsible to store are in the propertyNames list.
Parameters:
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.
Throws:
OperationFailedException - if the process of storing fails.
java.lang.UnsupportedOperationException - if this operation is not supported.

removeProperties

void removeProperties(IContext context,
                      IPropertySet propertySet,
                      java.util.List<IPropertyName> propertyNames)
                      throws OperationFailedException
Removes the properties identified by the property names in the given propertyNames list. The given propertySet contains propertyset name, propertysetdefinition name, namespace name and properties.
Parameters:
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.
Throws:
OperationFailedException - if the process of removing fails.
java.lang.UnsupportedOperationException - if this operation is not supported.

removeProperties

void removeProperties(IContext context,
                      INamespaceName namespaceName,
                      IPropertySetDefinitionName propertySetDefinitionName)
                      throws OperationFailedException
Remove all the properties of all the propertysets in the given namespaceName and propertySetDefinitionName.
Parameters:
context - a property service context.
namespaceName - a namespace name.
propertySetDefinitionName - a propertysetdefinition name.
Throws:
OperationFailedException - if the process of removing fails.
java.lang.UnsupportedOperationException - if this operation is not supported.

filter

IPagedList<IPropertySet> filter(IContext context,
                                INamespaceName namespaceName,
                                IPropertySetDefinitionName setDefinitionName,
                                PropertySetFilterContext filterContext)
                                throws OperationFailedException
Filters propertysets based on the given filterContext.
Parameters:
context - a property service context.
namespaceName - a namespace name.
setDefinitionName - a propertysetdefinition name.
filterContext - a filter context that contains search expression and pagination context.
Returns:
A paged list of propertysets that satisfies the given filter context.
Throws:
OperationFailedException - if the process of filtering fails.
java.lang.UnsupportedOperationException - if this operation is not supported.

count

int count(IContext context,
          INamespaceName namespaceName,
          IPropertySetDefinitionName setDefinitionName,
          PropertySetExpression expression)
          throws OperationFailedException
Returns the number of propertysets that satisfy the given expression.
Parameters:
context - a property service context.
namespaceName - a namespace name.
setDefinitionName - a propertysetdefinition name.
expression - a propertyset expression.
Returns:
an integer indicating the number of the propertysets that satisfy the given expression.
Throws:
OperationFailedException - if the process of counting fails.
java.lang.UnsupportedOperationException - if this operation is not supported.

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal
11g Release 1 (11.1.1.6.0)
E15995-05


Copyright © 2009, 2012, Oracle and/or its affiliates. All rights reserved.