Class NodeService.FindNodeParameters

  • Enclosing interface:
    NodeService

    public static class NodeService.FindNodeParameters
    extends Object
    General node-find parameters. There may be some combinations of parameters that are not valid; look at the specific setter methods to get more information.
    Since:
    3.4.0b
    Author:
    Derek Hulley
    • Constructor Detail

      • FindNodeParameters

        public FindNodeParameters()
        Defaults:
        minNodeId: null
        maxNodeId: null
        nodeTypes: null
        nodeAspects: null
        sortAscending: true
        limit: 10000
    • Method Detail

      • getMinNodeId

        public Long getMinNodeId()
      • setMinNodeId

        public void setMinNodeId​(Long minNodeId)
        The lowest node ID (inclusive) to return
        Parameters:
        minNodeId - the minimum node ID or null to ignore
      • getMaxNodeId

        public Long getMaxNodeId()
      • setMaxNodeId

        public void setMaxNodeId​(Long maxNodeId)
        The largest node ID (exclusive) to return
        Parameters:
        maxNodeId - the maximum node ID or null to ignore
      • getNodeTypes

        public List<QName> getNodeTypes()
      • setNodeTypes

        public void setNodeTypes​(List<QName> nodeTypes)
        Set the node types to find. Subtypes will be included automatically.
        Parameters:
        nodeTypes - the node types or null to ignore
      • getNodeAspects

        public List<QName> getNodeAspects()
      • setNodeAspects

        public void setNodeAspects​(List<QName> nodeAspects)
        Set the node aspects to find. Subtypes will be included automatically.
        Parameters:
        nodeAspects - the node aspects or null to ignore
      • isSortAscending

        public boolean isSortAscending()
      • setSortAscending

        public void setSortAscending​(boolean sortAscending)
        Set the node-ID sort order.
        Parameters:
        sortAscending - true to retrieve the nodes in ascending ID order
      • getLimit

        public int getLimit()
      • setLimit

        public void setLimit​(int limit)
        Set the number of results to return. If this too large, then results will be trimmed by wrapping classes or might cause excessive resource usage; limit the results and requery using the ID-bases limiters.
        Parameters:
        limit - the maximum number of results to return