org.kuali.rice.kew.api.document.search

Class DocumentSearchResults

java.lang.Object

org.kuali.rice.core.api.mo.AbstractDataTransferObject

org.kuali.rice.kew.api.document.search.DocumentSearchResults

All Implemented Interfaces:

Serializable, ModelObjectBasic, ModelObjectComplete, DocumentSearchResultsContract

public final class DocumentSearchResults
extends AbstractDataTransferObject
implements DocumentSearchResultsContract

An immutable data transfer object implementation of the DocumentSearchResultsContract. Instances of this class should be constructed using the nested DocumentSearchResults.Builder class.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentSearchResults.Builder A builder which can be used to construct DocumentSearchResults instances.

Method Summary

Methods

Modifier and Type	Method and Description
DocumentSearchCriteria	getCriteria() Returns the criteria that was used to execute the search.
int	getNumberOfSecurityFilteredResults() Return the number of results that matched the criteria but are not included on this results instance because they principal executing the document search did not have permissions to view them.
List<DocumentSearchResult>	getSearchResults() Returns the unmodifiable list of search results.
boolean	isCriteriaModified() Returns true if the criteria on this search result was modified from the original criteria submitted by the executor of the document search.
boolean	isOverThreshold() Returns true if the results of the search returned more rows then the document search framework is allowed to return back to the caller of the api.

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getSearchResults

public List<DocumentSearchResult> getSearchResults()

Description copied from interface: DocumentSearchResultsContract

Returns the unmodifiable list of search results. Each of these result objects represents a document returned from the search.

Specified by:

getSearchResults in interface DocumentSearchResultsContract

Returns:

an unmodifiable list of search results, will never be null but may be null

getCriteria

public DocumentSearchCriteria getCriteria()

Description copied from interface: DocumentSearchResultsContract

Returns the criteria that was used to execute the search. This may not be the same criteria that was submitted to the document search api since it is possible for criteria to be modified by backend processing of the submitted criteria. See DocumentSearchResultsContract.isCriteriaModified() for more information.

Specified by:

getCriteria in interface DocumentSearchResultsContract

Returns:

the criteria used to execute this search, will never be null

isCriteriaModified

public boolean isCriteriaModified()

Description copied from interface: DocumentSearchResultsContract

Returns true if the criteria on this search result was modified from the original criteria submitted by the executor of the document search. This may happen in cases where the document search implementation modifies the given criteria. This may be possible through document search customization hooks, or may happen as part of a process of "defaulting" certain portions of the criteria.

Specified by:

isCriteriaModified in interface DocumentSearchResultsContract

Returns:

a boolean indicating whether or not the criteria was modified from it's original form prior to search execution

isOverThreshold

public boolean isOverThreshold()

Description copied from interface: DocumentSearchResultsContract

Returns true if the results of the search returned more rows then the document search framework is allowed to return back to the caller of the api. The implementation of the document search is permitted to cap the number of results returned and a result cap can also be specified on the criteria itself.

Specified by:

isOverThreshold in interface DocumentSearchResultsContract

Returns:

true if there are more results available for the requested search then can be included in the list of results

getNumberOfSecurityFilteredResults

public int getNumberOfSecurityFilteredResults()

Description copied from interface: DocumentSearchResultsContract

Return the number of results that matched the criteria but are not included on this results instance because they principal executing the document search did not have permissions to view them.

Specified by:

getNumberOfSecurityFilteredResults in interface DocumentSearchResultsContract

Returns:

the number of results that were filtered for security reasons