org.eclipse.stardust.engine.api.query
Class SubFolderPolicy

java.lang.Object
  extended by org.eclipse.stardust.engine.api.query.SubFolderPolicy
All Implemented Interfaces:
Serializable, EvaluationPolicy

public class SubFolderPolicy
extends Object
implements EvaluationPolicy

Allows to limit a DocumentQuery to a specified subfolder.

Author:
roland.stamm
See Also:
Serialized Form

Constructor Summary
SubFolderPolicy(String limitSubFolder)
          Limits the search to the specified subfolder and its subfolders.
SubFolderPolicy(String limitSubFolder, boolean recursive)
          Limits the search to the specified subfolder and optionally its subfolders.
 
Method Summary
 String getLimitSubFolder()
           
 boolean isRecursive()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SubFolderPolicy

public SubFolderPolicy(String limitSubFolder)
Limits the search to the specified subfolder and its subfolders.

Examples: "/subfolder1", "/subfolder1/subfolder2", "/subfolder1//subfolder5"

Parameters:
limitSubFolder - The folder name or path that the query should be limited to.

SubFolderPolicy

public SubFolderPolicy(String limitSubFolder,
                       boolean recursive)
Limits the search to the specified subfolder and optionally its subfolders.

With recursive set to false the search includes only documents in the specified subfolder.

Examples: "/subfolder1", "/subfolder1/subfolder2", "/subfolder1//subfolder5"

Parameters:
limitSubFolder - The folder name or path that the query should be limited to.
recursive - Specifies if folders below the limited subfolder should be included in the search.
Method Detail

getLimitSubFolder

public String getLimitSubFolder()
Returns:
The folder name or path that the query should be limited to.

isRecursive

public boolean isRecursive()


Copyright © 2017 Eclipse Stardust. All Rights Reserved.