Package 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 TypeMethodDescriptiongetNode(NodeRef source, Map<String, Serializable> params) A list containing the parmameter defintions for thisNodeLocator.
-
Method Details
-
getNode
Finds aNodeRefgiven a startingNodeRefand aMapof parameters. Returnsnullif the specified node could not be found.- Parameters:
source- the starting point for locating a new node. The source node. Can benull.params- an arbitraryMapof parameters.Can benull.- Returns:
- the node to be found or
null.
-
getParameterDefinitions
List<ParameterDefinition> getParameterDefinitions()A list containing the parmameter defintions for thisNodeLocator.- Returns:
- a list of parameter definitions
-