com.jivesoftware.community
Enum BlogPostSearchQueryCriteria.BlogPostSortType

java.lang.Object
  java.lang.Enum<BlogPostSearchQueryCriteria.BlogPostSortType>
      com.jivesoftware.community.BlogPostSearchQueryCriteria.BlogPostSortType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BlogPostSearchQueryCriteria.BlogPostSortType>

Enclosing interface:

BlogPostSearchQueryCriteria

public static enum BlogPostSearchQueryCriteria.BlogPostSortType
extends java.lang.Enum<BlogPostSearchQueryCriteria.BlogPostSortType>

Represents how message blog post queries will be sorted

Enum Constant Summary

DATE
Sort by date

RATING
Sort by rating

RELEVANCE
Sort by relevance

SUBJECT
Sort by subject

Method Summary

static BlogPostSearchQueryCriteria.BlogPostSortType	getBlogPostSortType(int key) A helper method to get a specific BlogSortType object from its key
int	getKey()
static BlogPostSearchQueryCriteria.BlogPostSortType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BlogPostSearchQueryCriteria.BlogPostSortType[]	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

RELEVANCE

public static final BlogPostSearchQueryCriteria.BlogPostSortType RELEVANCE

Sort by relevance

RATING

public static final BlogPostSearchQueryCriteria.BlogPostSortType RATING

Sort by rating

SUBJECT

public static final BlogPostSearchQueryCriteria.BlogPostSortType SUBJECT

Sort by subject

DATE

public static final BlogPostSearchQueryCriteria.BlogPostSortType DATE

Sort by date

Method Detail

values

public static final BlogPostSearchQueryCriteria.BlogPostSortType[] 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(BlogPostSearchQueryCriteria.BlogPostSortType c : BlogPostSearchQueryCriteria.BlogPostSortType.values())
        System.out.println(c);

Returns:

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

valueOf

public static BlogPostSearchQueryCriteria.BlogPostSortType 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()

getBlogPostSortType

public static BlogPostSearchQueryCriteria.BlogPostSortType getBlogPostSortType(int key)

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

Parameters:

key - the key value of the BlogSortType object

Returns:

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