Skip navigation links

oracle.wcps.property
Interface IDefinitionLocator

public interface IDefinitionLocator

A locator used for managing propertydefinitions and propertysetdefinitions. The implementation classes are required to implement loadPropertyDefinition(IContext, INamespaceName, IPropertyDefinitionName) and loadPropertySetDefinition(IContext, INamespaceName, IPropertySetDefinitionName) methods and all the unsupported methods of this 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.

An implementation instance will be used by the property service if found in a namespace INamespace.getDefinitionLocatorClassName() and in the property service server's classpath. The property service will use the default definition locator if the custom definition locator is not registered.

Please refer to the deployment guide for how to deploy the custom locators onto the property service server.

Method Summary

int	count(IContext context, INamespaceName namespaceName, PropertyDefinitionExpression expression) Returns the number of the propertydefinitions that satisfy the given expression.
int	count(IContext context, INamespaceName namespaceName, PropertySetDefinitionExpression expression) Returns the number of propertysetdefinitions that satisfy the given expression.
IPagedList<IPropertyDefinition>	filter(IContext context, INamespaceName namespaceName, PropertyDefinitionFilterContext filterContext) Filters propertydefinitions based on the given filterContext.
IPagedList<IPropertySetDefinition>	filter(IContext context, INamespaceName namespaceName, PropertySetDefinitionFilterContext filterContext) Filters propertysetdefinitions based on the given filterContext.
IPropertyDefinition	loadPropertyDefinition(IContext context, INamespaceName namespaceName, IPropertyDefinitionName propertyDefinitionName) Returns the propertydefinition identified by the given propertyDefinitionName.
IPropertySetDefinition	loadPropertySetDefinition(IContext context, INamespaceName namespaceName, IPropertySetDefinitionName setDefinitionName) Returns the propertysetdefinition for the given setDefinitionName.
void	remove(IContext context, INamespaceName namespaceName, PropertyDefinitionName propertyDefinitionName) Removes the propertydefinition identified by the given propertyDefinitionName.
void	remove(IContext context, INamespaceName namespaceName, PropertySetDefinitionName setDefinitionName) Removes the propertysetdefinition identified by the given setDefinitionName.
void	removeAllPropertyDefinitions(IContext context, INamespaceName namespaceName) Removes all the propertydefinitions within the given namespace namespaceName.
void	removeAllPropertySetDefinitions(IContext context, INamespaceName name) Removes all the propertysetdefinitions associated with the given namespace name.
void	storePropertyDefinition(IContext context, IPropertyDefinition propertyDefinition) Stores the given propertyDefinition.
void	storePropertySetDefinition(IContext context, IPropertySetDefinition setDefinition) Stores the given propertysetdefinition setDefinition.

Method Detail

loadPropertySetDefinition

IPropertySetDefinition loadPropertySetDefinition(IContext context,
                                                 INamespaceName namespaceName,
                                                 IPropertySetDefinitionName setDefinitionName)
                                                 throws OperationFailedException

Returns the propertysetdefinition for the given setDefinitionName.

Parameters:

context - a property service context.

namespaceName - the namespace name referred by the propertysetdefinition.

setDefinitionName - a propertysetdefinition name.

Returns:

the propertysetdefinition if found, otherwise null.

Throws:

OperationFailedException - if the process of loading fails.

storePropertySetDefinition

void storePropertySetDefinition(IContext context,
                                IPropertySetDefinition setDefinition)
                                throws OperationFailedException

Stores the given propertysetdefinition setDefinition.

Parameters:

context - a property service context.

setDefinition - a propertysetdefinition to store.

Throws:

OperationFailedException - if the process of storing fails.

java.lang.UnsupportedOperationException - if this operation is not supported.

remove

void remove(IContext context,
            INamespaceName namespaceName,
            PropertySetDefinitionName setDefinitionName)
            throws ObjectInUseException,
                   OperationFailedException

Removes the propertysetdefinition identified by the given setDefinitionName.

Parameters:

context - a property service context.

namespaceName - the namespace name referred by the propertysetdefinition.

setDefinitionName - a propertysetdefinition's name.

Throws:

ObjectInUseException - if there is a propertyset associated with the propertysetdefinition identified by the given propertySetDefinitionName

OperationFailedException - if the process of removing fails.

java.lang.UnsupportedOperationException - if this operation is not supported.

removeAllPropertySetDefinitions

void removeAllPropertySetDefinitions(IContext context,
                                     INamespaceName name)
                                     throws ObjectInUseException,
                                            OperationFailedException

Removes all the propertysetdefinitions associated with the given namespace name.

Parameters:

context - a property service context.

name - a namespace name referred by the one or more propertysetdefinitions.

Throws:

ObjectInUseException - if there are propertysets associated with at least one propertysetdefinition.

OperationFailedException - if the process of removing fails.

java.lang.UnsupportedOperationException - if this operation is not supported.

filter

IPagedList<IPropertySetDefinition> filter(IContext context,
                                          INamespaceName namespaceName,
                                          PropertySetDefinitionFilterContext filterContext)
                                          throws OperationFailedException

Filters propertysetdefinitions based on the given filterContext.

Parameters:

context - a property service context.

namespaceName - a namespace name referred by one or more propertysetdefinitions.

filterContext - a filter context that contains search expression and pagination context.

Returns:

A paged list of propertysetdefinitions 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,
          PropertySetDefinitionExpression expression)
          throws OperationFailedException

Returns the number of propertysetdefinitions that satisfy the given expression.

Parameters:

context - a property service context.

namespaceName - a namespace name.

expression - a propertysetdefinition expression.

Returns:

an integer indicating the number of the propertysetdefinitions that satisfy the given expression.

Throws:

OperationFailedException - if the process of counting fails.

java.lang.UnsupportedOperationException - if this operation is not supported.

loadPropertyDefinition

IPropertyDefinition loadPropertyDefinition(IContext context,
                                           INamespaceName namespaceName,
                                           IPropertyDefinitionName propertyDefinitionName)
                                           throws OperationFailedException

Returns the propertydefinition identified by the given propertyDefinitionName.

Parameters:

context - a property service context.

namespaceName - the namespace name referred by the propertydefinition.

propertyDefinitionName - a propertydefinition name.

Returns:

the propertydefinition if found, otherwise null.

Throws:

OperationFailedException - if the process of loading fails.

storePropertyDefinition

void storePropertyDefinition(IContext context,
                             IPropertyDefinition propertyDefinition)
                             throws OperationFailedException

Stores the given propertyDefinition.

Parameters:

context - a property service context.

propertyDefinition - a propertydefinition.

Throws:

OperationFailedException - if the process of storing fails.

java.lang.UnsupportedOperationException - if this operation is not supported.

remove

void remove(IContext context,
            INamespaceName namespaceName,
            PropertyDefinitionName propertyDefinitionName)
            throws ObjectInUseException,
                   OperationFailedException

Removes the propertydefinition identified by the given propertyDefinitionName.

Parameters:

context - a property service context.

namespaceName - the namespace name referred by the propertydefinition.

propertyDefinitionName - a propertydefinition name.

Throws:

ObjectInUseException - if there is a propertysetdefinition referring the propertydefinition identified by the given propertyDefinitionName

OperationFailedException - if the process of removing fails.

java.lang.UnsupportedOperationException - if this operation is not supported.

removeAllPropertyDefinitions

void removeAllPropertyDefinitions(IContext context,
                                  INamespaceName namespaceName)
                                  throws ObjectInUseException,
                                         OperationFailedException

Removes all the propertydefinitions within the given namespace namespaceName.

Parameters:

context - a property service context.

namespaceName - a namespace name.

Throws:

ObjectInUseException - if there is at least one propertysetdefinition referring at least one propertydefinition.

OperationFailedException - if the process of removing fails.

java.lang.UnsupportedOperationException - if this operation is not supported.

filter

IPagedList<IPropertyDefinition> filter(IContext context,
                                       INamespaceName namespaceName,
                                       PropertyDefinitionFilterContext filterContext)
                                       throws OperationFailedException

Filters propertydefinitions based on the given filterContext.

Parameters:

context - a property service context.

namespaceName - a namespace name.

filterContext - a filter context that contains search expression and pagination context.

Returns:

A paged list of propertydefinitions 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,
          PropertyDefinitionExpression expression)
          throws OperationFailedException

Returns the number of the propertydefinitions that satisfy the given expression.

Parameters:

context - a property service context.

namespaceName - a namespace name.

expression - a propertydefinition expression.

Returns:

an integer indicating the number of the propertydefinitions 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