com.plumtree.remote.prc.collaboration.document
Interface IDocumentFilter

All Superinterfaces:

IFilter

public interface IDocumentFilter

extends IFilter

Interface for filters used for querying Collaboration documents.

Method Summary

DocumentFilterType	getFilterType() Returns the type of document filter.
DocumentQueryOrder[]	getQueryOrders() Returns the DocumentQueryOrder that specifies the order in which the results will be returned.
void	setFilterType(DocumentFilterType filterType) Sets the type of document filter.
void	setQueryOrders(DocumentQueryOrder[] queryOrders) Sets the DocumentQueryOrder for the rows to return.

Methods inherited from interface com.plumtree.remote.prc.collaboration.query.IFilter

getMaximumResults, isRestoreSecurity, setMaximumResults, setRestoreSecurity

Method Detail

getFilterType

public DocumentFilterType getFilterType()

Returns the type of document filter.

Returns:

the type of document filter

getQueryOrders

public DocumentQueryOrder[] getQueryOrders()

Returns the DocumentQueryOrder that specifies the order in which the results will be returned.

Returns:

queryField - a DocumentQueryOrder array describing how the returned results should be ordered

setFilterType

public void setFilterType(DocumentFilterType filterType)

Sets the type of document filter.

Parameters:

filterType - the type of document filter; cannot be null

setQueryOrders

public void setQueryOrders(DocumentQueryOrder[] queryOrders)

Sets the DocumentQueryOrder for the rows to return. The rows will be returned ordered as specified by the DocumentQueryOrder array.

Parameters:

queryOrders - a DocumentQueryOrder array describing how the returned results should be ordered; cannot be null or zero-length