rocks.xmpp.extensions.search.model

Class Search

java.lang.Object

rocks.xmpp.extensions.search.model.Search

public final class Search
extends Object

The implementation of the <query/> element in the jabber:iq:search namespace.

This class is immutable.

See Also:

XEP-0055: Jabber Search, XML Schema

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Search.Item The implementation of a search result item.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAMESPACE jabber:iq:search

Constructor Summary

Constructors

Constructor and Description
Search() Creates an empty search request.
Search(String first, String last, String nick, String email) Creates a search request, consisting of multiple search parameters.
Search(String first, String last, String nick, String email, ResultSetManagement resultSet, String instructions, DataForm dataForm) Creates a search request, consisting of multiple search parameters.

Method Summary

Modifier and Type	Method and Description
DataForm	getAdditionalInformation() Gets additional information for the search, e.g. for gender.
String	getEmail() Gets the email address.
String	getFirst() Gets the first name.
String	getInstructions() Gets the search instructions.
List<Search.Item>	getItems() Gets the items of a search result.
String	getLast() Gets the last name.
String	getNick() Gets the nick name.
ResultSetManagement	getResultSet() Gets the result set information.

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE

public static final String NAMESPACE

jabber:iq:search

See Also:

Constant Field Values

Constructor Detail

Search

public Search()

Creates an empty search request.

Search

public Search(String first,
              String last,
              String nick,
              String email)

Creates a search request, consisting of multiple search parameters.

Parameters:

first - The first name.

last - The last name.

nick - The nick name.

email - The email.

Search

public Search(String first,
              String last,
              String nick,
              String email,
              ResultSetManagement resultSet,
              String instructions,
              DataForm dataForm)

Creates a search request, consisting of multiple search parameters.

Parameters:

first - The first name.

last - The last name.

nick - The nick name.

email - The email.

resultSet - The result set information.

instructions - The instructions.

dataForm - The data form.

Method Detail

getInstructions

public final String getInstructions()

Gets the search instructions.

Returns:

The search instructions.

getFirst

public final String getFirst()

Gets the first name.

Returns:

The first name.

getLast

public final String getLast()

Gets the last name.

Returns:

The last name.

getNick

public final String getNick()

Gets the nick name.

Returns:

The nick name.

getEmail

public final String getEmail()

Gets the email address.

Returns:

The email address.

getItems

public final List<Search.Item> getItems()

Gets the items of a search result.

Returns:

The items.

getAdditionalInformation

public final DataForm getAdditionalInformation()

Gets additional information for the search, e.g. for gender.

3. Extensibility

The fields defined in the 'jabber:iq:search' namespace are strictly limited to those specified in the schema. If a host needs to gather additional information, Data Forms SHOULD be used; a host MUST NOT add new fields to the 'jabber:iq:search' namespace. Support for extensibility via Data Forms is RECOMMENDED, but is not required for compliance with this document.

Returns:

The data form, which contains additional information.

getResultSet

public final ResultSetManagement getResultSet()

Gets the result set information.

Returns:

The result set.

See Also:

XEP-0059: Result Set Management