Class TranscriptSearchManager
java.lang.Object
org.jivesoftware.smackx.workgroup.agent.TranscriptSearchManager
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
-
Method Summary
Modifier and TypeMethodDescriptiongetSearchForm
(DomainBareJid serviceJID) Returns the Form to use for searching transcripts.submitSearch
(DomainBareJid serviceJID, FillableForm completedForm) Submits the completed form and returns the result of the transcript search.
-
Constructor Details
-
TranscriptSearchManager
-
-
Method Details
-
getSearchForm
public Form getSearchForm(DomainBareJid serviceJID) throws SmackException.NoResponseException, XMPPException.XMPPErrorException, SmackException.NotConnectedException, 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.InterruptedException
- if the calling thread was interrupted.
-
submitSearch
public ReportedData submitSearch(DomainBareJid serviceJID, FillableForm completedForm) throws SmackException.NoResponseException, XMPPException.XMPPErrorException, SmackException.NotConnectedException, 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.InterruptedException
- if the calling thread was interrupted.
-