com.hcl.domino.dbdirectory

Interface DbDirectory

public interface DbDirectory

Very fast directory scanner

Method Summary

Modifier and Type	Method and Description
List<DirEntry>	listFiles(String server) Returns the content of the server directory at the top-level.
List<DirEntry>	listFiles(String server, String directory) Returns the content of a single directory on a Domino server
List<DirEntry>	listFiles(String server, String directory, String formula) Returns the content of a server directory, filtered via formula
DirectorySearchQuery	query() With this method you can create a more advanced query for files on any Domino server

Method Detail

listFiles

List<DirEntry> listFiles(String server)

Returns the content of the server directory at the top-level.

Parameters:

server - server name, either abbreviated, canonical or common name

Returns:

found file entries (either FolderData or DatabaseData instances)

listFiles

List<DirEntry> listFiles(String server,
                         String directory)

Returns the content of a single directory on a Domino server

Parameters:

server - server name, either abbreviated, canonical or common name

directory - directory name or empty string for top-level directory

Returns:

found file entries (either FolderData or DatabaseData instances)

listFiles

List<DirEntry> listFiles(String server,
                         String directory,
                         String formula)

Returns the content of a server directory, filtered via formula

Parameters:

server - server to scan

directory - directory name or empty string for top level directory

formula - optional search formula to filter the returned entries, see DirEntry.getProperties() for available fields, e.g. $path="mydb.nsf" or @Word($info;@char(10);2)="db category name"

Returns:

search result

query

DirectorySearchQuery query()

With this method you can create a more advanced query for files on any Domino server

Returns:

query object to refine and perform the search