com.valhalla.jbother.jabber.smack
Class Search

java.lang.Object
  extended by org.jivesoftware.smack.packet.Packet
      extended by org.jivesoftware.smack.packet.IQ
          extended by com.valhalla.jbother.jabber.smack.Search

public class Search
extends org.jivesoftware.smack.packet.IQ

class implementing packets used to search Jabber User Directory searching process, according to JEP-0055 looks as following: 1) query the information repository regarding the possible search fields 2) send search query 3) receive search results Because search fields are not standard, they are kept in hash map: keys are names of the fields and values are, well, values of those fields :-) TODO: search using data forms

Version:
1.0
Author:
Lukasz Wiechec

Nested Class Summary
static class Search.Item
          inner class for representing "items", ie.
 
Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ
org.jivesoftware.smack.packet.IQ.Type
 
Field Summary
 java.lang.String NAMESPACE
           
 
Fields inherited from class org.jivesoftware.smack.packet.Packet
ID_NOT_AVAILABLE
 
Constructor Summary
Search()
           
Search(java.lang.String aInstructions, java.util.HashMap aSearchFields)
           
 
Method Summary
 void addItem(Search.Item aItem)
           
 java.lang.String getChildElementXML()
           
 java.lang.String getInstructions()
           
 java.util.ArrayList getItems()
           
 org.jivesoftware.smackx.packet.DataForm getSearchDataForm()
           
 java.util.HashMap getSearchFields()
           
 void setInstructions(java.lang.String instructions)
           
 void setItems(java.util.ArrayList items)
           
 void setSearchDataForm(org.jivesoftware.smackx.packet.DataForm searchDataForm)
           
 void setSearchFields(java.util.HashMap searchFields)
           
 
Methods inherited from class org.jivesoftware.smack.packet.IQ
getType, setType, toXML
 
Methods inherited from class org.jivesoftware.smack.packet.Packet
addExtension, deleteProperty, getError, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getProperty, getPropertyNames, getTo, removeExtension, setError, setFrom, setPacketID, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setTo
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NAMESPACE

public final java.lang.String NAMESPACE
See Also:
Constant Field Values
Constructor Detail

Search

public Search(java.lang.String aInstructions,
              java.util.HashMap aSearchFields)

Search

public Search()
Method Detail

getInstructions

public java.lang.String getInstructions()

setInstructions

public void setInstructions(java.lang.String instructions)

getSearchFields

public java.util.HashMap getSearchFields()

setSearchFields

public void setSearchFields(java.util.HashMap searchFields)

getItems

public java.util.ArrayList getItems()

setItems

public void setItems(java.util.ArrayList items)

getSearchDataForm

public org.jivesoftware.smackx.packet.DataForm getSearchDataForm()

setSearchDataForm

public void setSearchDataForm(org.jivesoftware.smackx.packet.DataForm searchDataForm)

addItem

public void addItem(Search.Item aItem)

getChildElementXML

public java.lang.String getChildElementXML()
Specified by:
getChildElementXML in class org.jivesoftware.smack.packet.IQ