Plumtree EDK (Enterprise Web Development Kit) 5.4.0

IDocumentManager.QueryDocuments Method (IDocumentFolder, IDocumentFilter)

Queries for documents contained in the specified document folder, and returns an array of IDocuments that satisfies the query filter.

IDocument[] QueryDocuments(
   IDocumentFolder documentFolder,
   IDocumentFilter documentFilter
);

Parameters

documentFolder
The document folder to query from. The query will be restricted to documents contained in the given folder. Cannot be null.
documentFilter
A IDocumentFilter instance specifying which query to perform, the desired sort order of the query result, and the maximum number of rows to return. Cannot be null.

Return Value

An array of IDocuments satisfying the filter, in the specified document folder.

Exceptions

Exception Type Condition
CollaborationException The method call resulted in an error.
SoapException There is a communication problem during the execution of the remote method call.
InvalidOperationException The document folder has not yet been inserted or has already been removed.

See Also

IDocumentManager Interface | Plumtree.Remote.PRC.Collaboration.Document Namespace | IDocumentManager.QueryDocuments Overload List