com.jivesoftware.community.webservices
Interface SearchService

public interface SearchService

Provides the ability to search for content.

Method Summary

int	countQuickMessageSearchResultsByCommunityID(long communityID, java.lang.String query, int[] contentTypes) Returns the number of possible results for the specified query.
int	countQuickSearchResults(java.lang.String query, int[] contentTypes) Returns the number of possible results for the specified query.
int	countSearchResults(WSQuery query, int[] contentTypes) Returns the number of possible results for the specified query.
int	countSearchResultsByCommunityID(long communityID, WSQuery query, int[] contentTypes) Returns the number of possible results for the specified query by category.
WSJiveObject[]	quickMessageSearchByCommunityID(long communityID, java.lang.String query, int[] contentTypes, int startIndex, int numResults) Provides the ability to do quick search queries based on the provided string.
WSJiveObject[]	quickSearch(java.lang.String query, int[] contentTypes, int startIndex, int numResults) Provides the ability to do quick search queries based on the provided string.
WSJiveObject[]	search(WSQuery query, int[] contentTypes, int startIndex, int numResults) Provides the ability to create complex search queries with the ability to change sorting, filtering, etc.
WSJiveObject[]	searchByCommunities(long communityID, WSQuery query, int[] contentTypes, int startIndex, int numResults) Provides the ability to create complex search queries with the ability to change sorting, filtering, etc. all by category.

Method Detail

search

WSJiveObject[] search(WSQuery query,
                      int[] contentTypes,
                      int startIndex,
                      int numResults)

Provides the ability to create complex search queries with the ability to change sorting, filtering, etc.

Parameters:

query - The query objects.

contentTypes - an array of jive content types

startIndex - Starting point of results to grab.

numResults - Ending point of results to grab.

Returns:

An array of message IDs.

quickSearch

WSJiveObject[] quickSearch(java.lang.String query,
                           int[] contentTypes,
                           int startIndex,
                           int numResults)

Provides the ability to do quick search queries based on the provided string.

Parameters:

query - The query string.

contentTypes - an array of jive content types

startIndex - Starting point of results to grab.

numResults - Ending point of results to grab. @return An array of message IDs.

Returns:

A list of objects that match the search criteria.

countSearchResults

int countSearchResults(WSQuery query,
                       int[] contentTypes)

Returns the number of possible results for the specified query.

Parameters:

query - The query to find the number of results for.

contentTypes - an array of jive content types

Returns:

The number of search results.

countQuickSearchResults

int countQuickSearchResults(java.lang.String query,
                            int[] contentTypes)

Returns the number of possible results for the specified query.

Parameters:

query - The query to find the number of results for.

contentTypes - an array of jive content types

Returns:

The number of search results.

searchByCommunities

WSJiveObject[] searchByCommunities(long communityID,
                                   WSQuery query,
                                   int[] contentTypes,
                                   int startIndex,
                                   int numResults)
                                   throws CommunityNotFoundException

Provides the ability to create complex search queries with the ability to change sorting, filtering, etc. all by category.

Parameters:

communityID - The id of the category

query - The query objects.

contentTypes - an array of jive content types

startIndex - Starting point of results to grab.

numResults - Ending point of results to grab. @return An array of message IDs.

Returns:

A list of objects that match the search criteria.

Throws:

CommunityNotFoundException - Thrown if the category does not exist

countSearchResultsByCommunityID

int countSearchResultsByCommunityID(long communityID,
                                    WSQuery query,
                                    int[] contentTypes)
                                    throws CommunityNotFoundException

Returns the number of possible results for the specified query by category.

Parameters:

communityID - The id of the category.

query - The query to find the number of results for.

contentTypes - an array of jive content types

Returns:

The number of search results.

Throws:

CommunityNotFoundException - Thrown if the community does not exist.

quickMessageSearchByCommunityID

WSJiveObject[] quickMessageSearchByCommunityID(long communityID,
                                               java.lang.String query,
                                               int[] contentTypes,
                                               int startIndex,
                                               int numResults)
                                               throws CommunityNotFoundException

Provides the ability to do quick search queries based on the provided string.

Parameters:

communityID - The id of the category.

query - The query string.

contentTypes - an array of jive content types

startIndex - Starting point of results to grab.

numResults - Ending point of results to grab. @return An array of message IDs.

Returns:

A list of objects that match the search criteria.

Throws:

CommunityNotFoundException - Thrown if the community specified does not exist.

countQuickMessageSearchResultsByCommunityID

int countQuickMessageSearchResultsByCommunityID(long communityID,
                                                java.lang.String query,
                                                int[] contentTypes)
                                                throws CommunityNotFoundException

Returns the number of possible results for the specified query.

Parameters:

communityID - The id of the category.

query - The query to find the number of results for.

contentTypes - an array of jive content types

Returns:

The number of search results.

Throws:

CommunityNotFoundException - Thrown if the community does not exist.