com.sapportals.wcm.repository.manager
Interface IPropertySearchManager

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.framework_api.jar]

public interface IPropertySearchManager

A property search manager provides the capability to search for resources in a repository.

Copyright (c) SAP AG 2001-2004

Method Summary

IResourceList	execute(IQueryExpression query, IResource resource, int depth, int maxResults, boolean includeVersions) Runs a query and returns a list of resource that matched the criteria
IQueryBuilder	getQueryBuilder() Retrieve a search manager specific query builder, which builds a IQueryExpression.
boolean	isUnderstood(IPropertyName propName) The manager has special knowledge how to handle this property.

Method Detail

isUnderstood

public boolean isUnderstood(IPropertyName propName)

The manager has special knowledge how to handle this property. This is interesting for a client to know, when queries about special, e.g. live properties like DAV:supported-method-set, are done. In case the search manager does not understand the property, the client might want to test this property himself.

Parameters:

propName - name of property

Returns:

true if manager undestands the properties semantics

getQueryBuilder

public IQueryBuilder getQueryBuilder()

Retrieve a search manager specific query builder, which builds a IQueryExpression.

Returns:

IQueryBuilder for constructing query

execute

public IResourceList execute(IQueryExpression query,
                             IResource resource,
                             int depth,
                             int maxResults,
                             boolean includeVersions)
                      throws ResourceException,
                             AccessDeniedException,
                             NotSupportedException

Runs a query and returns a list of resource that matched the criteria

Parameters:

query - The query object that specified the search criteria (may be null )

resource - to start the query on

depth - maximum depth in resource tree to query

maxResults - maximum number of results wanted

includeVersions - when set to true , also descend into version histories when present (independantly of depth)

Returns:

A list of resource that matched the search criteria