org.alfresco.service.cmr.repository
Class NodeService.FindNodeParameters

java.lang.Object
  extended by org.alfresco.service.cmr.repository.NodeService.FindNodeParameters
Enclosing interface:
NodeService

public static class NodeService.FindNodeParameters
extends java.lang.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

Constructor Summary
NodeService.FindNodeParameters()
          Defaults:
minNodeId: null
maxNodeId: null
nodeTypes: null
nodeAspects: null
sortAscending: true
limit: 10000
 
Method Summary
 int getLimit()
           
 java.lang.Long getMaxNodeId()
           
 java.lang.Long getMinNodeId()
           
 java.util.List getNodeAspects()
           
 java.util.List getNodeTypes()
           
 boolean isSortAscending()
           
 void setLimit(int limit)
          Set the number of results to return.
 void setMaxNodeId(java.lang.Long maxNodeId)
          The largest node ID (exclusive) to return
 void setMinNodeId(java.lang.Long minNodeId)
          The lowest node ID (inclusive) to return
 void setNodeAspects(java.util.List nodeAspects)
          Set the node aspects to find.
 void setNodeTypes(java.util.List nodeTypes)
          Set the node types to find.
 void setSortAscending(boolean sortAscending)
          Set the node-ID sort order.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NodeService.FindNodeParameters

public NodeService.FindNodeParameters()
Defaults:
minNodeId: null
maxNodeId: null
nodeTypes: null
nodeAspects: null
sortAscending: true
limit: 10000

Method Detail

getMinNodeId

public java.lang.Long getMinNodeId()

setMinNodeId

public void setMinNodeId(java.lang.Long minNodeId)
The lowest node ID (inclusive) to return

Parameters:
minNodeId - the minimum node ID or null to ignore

getMaxNodeId

public java.lang.Long getMaxNodeId()

setMaxNodeId

public void setMaxNodeId(java.lang.Long maxNodeId)
The largest node ID (exclusive) to return

Parameters:
maxNodeId - the maximum node ID or null to ignore

getNodeTypes

public java.util.List getNodeTypes()

setNodeTypes

public void setNodeTypes(java.util.List nodeTypes)
Set the node types to find. Subtypes will be included automatically.

Parameters:
nodeTypes - the node types or null to ignore

getNodeAspects

public java.util.List getNodeAspects()

setNodeAspects

public void setNodeAspects(java.util.List 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


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.