com.jivesoftware.community
Enum SearchQueryResult.ResultType

java.lang.Object
  java.lang.Enum<SearchQueryResult.ResultType>
      com.jivesoftware.community.SearchQueryResult.ResultType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SearchQueryResult.ResultType>

Enclosing interface:

SearchQueryResult

public static enum SearchQueryResult.ResultType
extends java.lang.Enum<SearchQueryResult.ResultType>

Represents the different types of results that can be queried upon

Enum Constant Summary

BLOG
Blog query result

BLOG_POST
Blog post query result

COMMUNITY
Community query result

DOCUMENT
Document query result

MESSAGE
Message query result

Method Summary

int	getKey()
static SearchQueryResult.ResultType	getResultType(int key) A helper method to get a specific ResultType object from its key
static SearchQueryResult.ResultType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SearchQueryResult.ResultType[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

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

Enum Constant Detail

BLOG_POST

public static final SearchQueryResult.ResultType BLOG_POST

Blog post query result

DOCUMENT

public static final SearchQueryResult.ResultType DOCUMENT

Document query result

MESSAGE

public static final SearchQueryResult.ResultType MESSAGE

Message query result

BLOG

public static final SearchQueryResult.ResultType BLOG

Blog query result

COMMUNITY

public static final SearchQueryResult.ResultType COMMUNITY

Community query result

Method Detail

values

public static final SearchQueryResult.ResultType[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(SearchQueryResult.ResultType c : SearchQueryResult.ResultType.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static SearchQueryResult.ResultType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

getKey

public int getKey()

getResultType

public static SearchQueryResult.ResultType getResultType(int key)

A helper method to get a specific ResultType object from its key

Parameters:

key - the key value of the ResultType object

Returns:

the ResultType object corresponding to the key value. NULL if the key is invalid.