org.kuali.rice.kew.api.document.lookup
Class DocumentLookupResults

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.kew.api.document.lookup.DocumentLookupResults

All Implemented Interfaces:

Serializable, ModelObjectBasic, ModelObjectComplete, DocumentLookupResultsContract

public final class DocumentLookupResults
extends AbstractDataTransferObject
implements DocumentLookupResultsContract

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

Author:

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

See Also:

Serialized Form

Nested Class Summary

static class

DocumentLookupResults.Builder A builder which can be used to construct DocumentLookupResults instances.

Method Summary

DocumentLookupCriteria	getCriteria() Returns the criteria that was used to execute the lookup.
List<DocumentLookupResult>	getLookupResults() Returns the unmodifiable list of lookup results.
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 lookup did not have permissions to view them.
boolean	isCriteriaModified() Returns true if the criteria on this lookup result was modified from the original criteria submitted by the executor of the document lookup.
boolean	isOverThreshold() Returns true if the results of the lookup returned more rows then the document lookup 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, hashCode, toString

Methods inherited from class java.lang.Object

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

Method Detail

getLookupResults

public List<DocumentLookupResult> getLookupResults()

Description copied from interface: DocumentLookupResultsContract

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

Specified by:

getLookupResults in interface DocumentLookupResultsContract

Returns:

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

getCriteria

public DocumentLookupCriteria getCriteria()

Description copied from interface: DocumentLookupResultsContract

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

Specified by:

getCriteria in interface DocumentLookupResultsContract

Returns:

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

isCriteriaModified

public boolean isCriteriaModified()

Description copied from interface: DocumentLookupResultsContract

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

Specified by:

isCriteriaModified in interface DocumentLookupResultsContract

Returns:

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

isOverThreshold

public boolean isOverThreshold()

Description copied from interface: DocumentLookupResultsContract

Returns true if the results of the lookup returned more rows then the document lookup framework is allowed to return back to the caller of the api. The implementation of the document lookup 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 DocumentLookupResultsContract

Returns:

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

getNumberOfSecurityFilteredResults

public int getNumberOfSecurityFilteredResults()

Description copied from interface: DocumentLookupResultsContract

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

Specified by:

getNumberOfSecurityFilteredResults in interface DocumentLookupResultsContract

Returns:

the number of results that were filtered for security reasons