com.adobe.livecycle.crc.sharepoint.client.types
Class SearchQueryResultType

java.lang.Object
  com.adobe.livecycle.crc.sharepoint.client.types.SearchQueryResultType

All Implemented Interfaces:

java.io.Serializable

public class SearchQueryResultType
extends java.lang.Object
implements java.io.Serializable

Contains searched documents list, number of search results returned, number of search results available in SharePoint, and a Boolean flag indicating success of the operation.

See Also:

Serialized Form

Nested Class Summary

static class

SearchQueryResultType.DocumentProperty

Constructor Summary

SearchQueryResultType()

Method Summary

void	addSearchDocument(SearchDocument document) Adds a document to the search result.
int	getSearchCount() Retrieves the number of search results.
java.util.List	getSearchDocuments() Retrieves a list containing search results.
java.lang.String	getSearchStatus() Retrieves the status of the search operation.
int	getTotalAvailable() Returns the number of total available results, for a query executed on SharePoint.
void	setSearchStatus(java.lang.String searchStatus) Sets the status of the search operation.
void	setTotalAvailable(int totalAvailable) Sets the number of total available results, for a query executed on SharePoint.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchQueryResultType

public SearchQueryResultType()

Method Detail

getSearchDocuments

public java.util.List getSearchDocuments()

Retrieves a list containing search results.

Returns:

list of all the documents obtained as result of search.

addSearchDocument

public void addSearchDocument(SearchDocument document)

Adds a document to the search result.

getSearchCount

public int getSearchCount()

Retrieves the number of search results. This value may differ from the total available results, if SharePoint has a greater number of results than the maximum limit you applied to search results.

Returns:

Total number of results returned for the search operation.

getSearchStatus

public java.lang.String getSearchStatus()

Retrieves the status of the search operation.

Returns:

Returns true if the search is successful. Returns false if the search failed.

setSearchStatus

public void setSearchStatus(java.lang.String searchStatus)

Sets the status of the search operation.

getTotalAvailable

public int getTotalAvailable()

Returns the number of total available results, for a query executed on SharePoint.

setTotalAvailable

public void setTotalAvailable(int totalAvailable)

Sets the number of total available results, for a query executed on SharePoint.

Parameters:

totalAvailable -