org.alfresco.repo.nodelocator

Interface NodeLocator

All Known Implementing Classes:

AbstractNodeLocator, AncestorNodeLocator, CompanyHomeNodeLocator, DocLibNodeLocator, SelfNodeLocator, SharedHomeNodeLocator, SitesHomeNodeLocator, UserHomeNodeLocator, XPathNodeLocator

public interface NodeLocator

A strategy for locating a NodeRef in the repository, given a source node and an arbitrary set of parameters.

Since:

4.0

Author:

Nick Smith

Method Summary

Modifier and Type	Method and Description
org.alfresco.service.cmr.repository.NodeRef	getNode(org.alfresco.service.cmr.repository.NodeRef source, Map<String,Serializable> params) Finds a NodeRef given a starting NodeRef and a Map of parameters.
List<ParameterDefinition>	getParameterDefinitions() A list containing the parmameter defintions for this NodeLocator.

Method Detail

getNode

org.alfresco.service.cmr.repository.NodeRef getNode(org.alfresco.service.cmr.repository.NodeRef source,
                                                    Map<String,Serializable> params)

Finds a NodeRef given a starting NodeRef and a Map of parameters. Returns null if the specified node could not be found.

Parameters:

source - the starting point for locating a new node. The source node. Can be null.

params - an arbitrary Map of parameters.Can be null.

Returns:

the node to be found or null.

getParameterDefinitions

List<ParameterDefinition> getParameterDefinitions()

A list containing the parmameter defintions for this NodeLocator.

Returns:

a list of parameter definitions