Package org.alfresco.repo.nodelocator
Interface NodeLocator
-
- All Known Implementing Classes:
AbstractNodeLocator,AncestorNodeLocator,CompanyHomeNodeLocator,DocLibNodeLocator,SelfNodeLocator,SharedHomeNodeLocator,SitesHomeNodeLocator,UserHomeNodeLocator,XPathNodeLocator
public interface NodeLocatorA strategy for locating aNodeRefin the repository, given a source node and an arbitrary set of parameters.- Since:
- 4.0
- Author:
- Nick Smith
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description org.alfresco.service.cmr.repository.NodeRefgetNode(org.alfresco.service.cmr.repository.NodeRef source, java.util.Map<java.lang.String,java.io.Serializable> params)Finds aNodeRefgiven a startingNodeRefand aMapof parameters.java.util.List<ParameterDefinition>getParameterDefinitions()A list containing the parmameter defintions for thisNodeLocator.
-
-
-
Method Detail
-
getNode
org.alfresco.service.cmr.repository.NodeRef getNode(org.alfresco.service.cmr.repository.NodeRef source, java.util.Map<java.lang.String,java.io.Serializable> params)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
java.util.List<ParameterDefinition> getParameterDefinitions()
A list containing the parmameter defintions for thisNodeLocator.- Returns:
- a list of parameter definitions
-
-