Clearspace API (2.0.15) Web Services Client Javadocs

com.jivesoftware.community.webservices
Class WSDocumentResultFilter

java.lang.Object
  extended by com.jivesoftware.community.webservices.WSResultFilter
      extended by com.jivesoftware.community.webservices.WSDocumentResultFilter

public class WSDocumentResultFilter
extends WSResultFilter

Filters and sorts lists of WSDocuments.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.jivesoftware.community.webservices.WSResultFilter
WSResultFilter.ResolutionState
 
Field Summary
 
Fields inherited from class com.jivesoftware.community.webservices.WSResultFilter
ASCENDING, DESCENDING, NULL_INT
 
Constructor Summary
WSDocumentResultFilter()
           
 
Method Summary
static WSDocumentResultFilter createDefaultFilter()
           
static WSDocumentResultFilter createRecentDocumentsFilter(int numResults)
          Creates a filter for the latest documents by creation date, with the number of results defined by numResults
 
Methods inherited from class com.jivesoftware.community.webservices.WSResultFilter
createDefaultMessageFilter, createDefaultThreadFilter, createDefaultUserMessagesFilter, getCreationDateRangeMax, getCreationDateRangeMin, getModerationRangeMax, getModerationRangeMin, getModificationDateRangeMax, getModificationDateRangeMin, getNumResults, getResolutionDateRangeMin, getResolutionnDateRangeMax, getResolutionStates, getSortField, getSortOrder, getStartIndex, getTags, getUserID, isRecursive, setCreationDateRangeMax, setCreationDateRangeMin, setModerationRangeMax, setModerationRangeMin, setModificationDateRangeMax, setModificationDateRangeMin, setNumResults, setRecursive, setResolutionDateRangeMin, setResolutionnDateRangeMax, setResolutionStates, setSortField, setSortOrder, setStartIndex, setTags, setUserID
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WSDocumentResultFilter

public WSDocumentResultFilter()
Method Detail

createDefaultFilter

public static WSDocumentResultFilter createDefaultFilter()

createRecentDocumentsFilter

public static WSDocumentResultFilter createRecentDocumentsFilter(int numResults)
Creates a filter for the latest documents by creation date, with the number of results defined by numResults

Parameters:
numResults - number of results to return
Returns:
a filter that will get the latest documents by creation date

Clearspace Project Page

Copyright © 1999-2007 Jive Software.