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 transcriptsgetSearchForm(DomainBareJid)
or to submit a search form and return the results of the searchsubmitSearch(DomainBareJid, FillableForm)
.
-
-
Constructor Summary
Constructors Constructor Description TranscriptSearchManager(org.jivesoftware.smack.XMPPConnection connection)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.jivesoftware.smackx.xdata.form.Form
getSearchForm(org.jxmpp.jid.DomainBareJid serviceJID)
Returns the Form to use for searching transcripts.org.jivesoftware.smackx.search.ReportedData
submitSearch(org.jxmpp.jid.DomainBareJid serviceJID, org.jivesoftware.smackx.xdata.form.FillableForm completedForm)
Submits the completed form and returns the result of the transcript search.
-
-
-
Method Detail
-
getSearchForm
public org.jivesoftware.smackx.xdata.form.Form getSearchForm(org.jxmpp.jid.DomainBareJid serviceJID) throws org.jivesoftware.smack.SmackException.NoResponseException, org.jivesoftware.smack.XMPPException.XMPPErrorException, org.jivesoftware.smack.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:
org.jivesoftware.smack.XMPPException.XMPPErrorException
- if there was an XMPP error returned.org.jivesoftware.smack.SmackException.NoResponseException
- if there was no response from the remote entity.org.jivesoftware.smack.SmackException.NotConnectedException
- if the XMPP connection is not connected.java.lang.InterruptedException
- if the calling thread was interrupted.
-
submitSearch
public org.jivesoftware.smackx.search.ReportedData submitSearch(org.jxmpp.jid.DomainBareJid serviceJID, org.jivesoftware.smackx.xdata.form.FillableForm completedForm) throws org.jivesoftware.smack.SmackException.NoResponseException, org.jivesoftware.smack.XMPPException.XMPPErrorException, org.jivesoftware.smack.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:
org.jivesoftware.smack.XMPPException.XMPPErrorException
- if there was an XMPP error returned.org.jivesoftware.smack.SmackException.NoResponseException
- if there was no response from the remote entity.org.jivesoftware.smack.SmackException.NotConnectedException
- if the XMPP connection is not connected.java.lang.InterruptedException
- if the calling thread was interrupted.
-
-