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.

Author:

Christian Schudt

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.

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, ResultSet resultSet) 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.
ResultSet	getResultSet() Gets the result set information.
void	setEmail(String email) Sets the email address.
void	setFirst(String first) Sets the first name.
void	setLast(String last) Sets the last name.
void	setNick(String nick) Sets the nick name.
void	setResultSet(ResultSet resultSet) Sets the result set information.

Methods inherited from class java.lang.Object

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

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,
              ResultSet resultSet)

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.

Method Detail

getInstructions

public String getInstructions()

Gets the search instructions.

Returns:

The search instructions.

getFirst

public String getFirst()

Gets the first name.

Returns:

The first name.

See Also:

setFirst(String)

setFirst

public void setFirst(String first)

Sets the first name.

Parameters:

first - The first name.

See Also:

getFirst()

getLast

public String getLast()

Gets the last name.

Returns:

The last name.

See Also:

setLast(String)

setLast

public void setLast(String last)

Sets the last name.

Parameters:

last - The last name.

See Also:

getLast()

getNick

public String getNick()

Gets the nick name.

Returns:

The nick name.

See Also:

setNick(String)

setNick

public void setNick(String nick)

Sets the nick name.

Parameters:

nick - The nick name.

See Also:

getNick()

getEmail

public String getEmail()

Gets the email address.

Returns:

The email address.

See Also:

setEmail(String)

setEmail

public void setEmail(String email)

Sets the email address.

Parameters:

email - The email address.

See Also:

getEmail()

getItems

public List<Search.Item> getItems()

Gets the items of a search result.

Returns:

The items.

getAdditionalInformation

public 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 ResultSet getResultSet()

Gets the result set information.

Returns:

The result set.

See Also:

XEP-0059: Result Set Management

setResultSet

public void setResultSet(ResultSet resultSet)

Sets the result set information.

Parameters:

resultSet - The result set.

See Also:

XEP-0059: Result Set Management