Package org.jivesoftware.smackx.workgroup.agent

Class TranscriptSearchManager

java.lang.Object

org.jivesoftware.smackx.workgroup.agent.TranscriptSearchManager

public class TranscriptSearchManager
extends java.lang.Object

A TranscriptSearchManager helps to retrieve the form to use for searching transcripts getSearchForm(DomainBareJid) or to submit a search form and return the results of the search submitSearch(DomainBareJid, FillableForm).

Constructor Summary

Constructors

Constructor	Description
TranscriptSearchManager(XMPPConnection connection)

Method Summary

Modifier and Type	Method	Description
Form	getSearchForm(DomainBareJid serviceJID)	Returns the Form to use for searching transcripts.
ReportedData	submitSearch(DomainBareJid serviceJID, FillableForm completedForm)	Submits the completed form and returns the result of the transcript search.

Methods inherited from class java.lang.Object

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

Constructor Detail

TranscriptSearchManager

public TranscriptSearchManager(XMPPConnection connection)

Method Detail

getSearchForm

public Form getSearchForm(DomainBareJid serviceJID)
                   throws SmackException.NoResponseException,
                          XMPPException.XMPPErrorException,
                          SmackException.NotConnectedException,
                          java.lang.InterruptedException

Returns the Form to use for searching transcripts. It is unlikely that the server will change the form (without a restart) so it is safe to keep the returned form for future submissions.

Parameters:

serviceJID - the address of the workgroup service.

Returns:

the Form to use for searching transcripts.

Throws:

XMPPException.XMPPErrorException - if there was an XMPP error returned.

SmackException.NoResponseException - if there was no response from the remote entity.

SmackException.NotConnectedException - if the XMPP connection is not connected.

java.lang.InterruptedException - if the calling thread was interrupted.

submitSearch

public ReportedData submitSearch(DomainBareJid serviceJID,
                                 FillableForm completedForm)
                          throws SmackException.NoResponseException,
                                 XMPPException.XMPPErrorException,
                                 SmackException.NotConnectedException,
                                 java.lang.InterruptedException

Submits the completed form and returns the result of the transcript search. The result will include all the data returned from the server so be careful with the amount of data that the search may return.

Parameters:

serviceJID - the address of the workgroup service.

completedForm - the filled out search form.

Returns:

the result of the transcript search.

Throws:

XMPPException.XMPPErrorException - if there was an XMPP error returned.

SmackException.NoResponseException - if there was no response from the remote entity.

SmackException.NotConnectedException - if the XMPP connection is not connected.

java.lang.InterruptedException - if the calling thread was interrupted.