org.jivesoftware.smackx.workgroup.packet

Class AgentWorkgroups

java.lang.Object

org.jivesoftware.smack.packet.Stanza

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.workgroup.packet.AgentWorkgroups

All Implemented Interfaces:

Element, Packet, TopLevelStreamElement

public class AgentWorkgroups
extends IQ

Represents a request for getting the jid of the workgroups where an agent can work or could represent the result of such request which will contain the list of workgroups JIDs where the agent can work.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AgentWorkgroups.Provider An IQProvider for AgentWorkgroups packets.

Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ

IQ.IQChildElementXmlStringBuilder, IQ.Type

Field Summary

Fields inherited from class org.jivesoftware.smack.packet.IQ

IQ_ELEMENT, QUERY_ELEMENT

Fields inherited from class org.jivesoftware.smack.packet.Stanza

DEFAULT_LANGUAGE, ITEM, language, TEXT

Constructor Summary

Constructors

Constructor and Description
AgentWorkgroups(String agentJID) Creates an AgentWorkgroups request for the given agent.
AgentWorkgroups(String agentJID, List<String> workgroups) Creates an AgentWorkgroups which will contain the JIDs of the workgroups where an agent can work.

Method Summary

Modifier and Type	Method and Description
String	getAgentJID()
protected IQ.IQChildElementXmlStringBuilder	getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder buf) This method must be overwritten by IQ subclasses to create their child content.
List<String>	getWorkgroups() Returns a list of workgroup JIDs where the agent can work.

Methods inherited from class org.jivesoftware.smack.packet.IQ

createErrorResponse, createResultIQ, getChildElementName, getChildElementNamespace, getChildElementXML, getType, isRequestIQ, setType, toXML

Methods inherited from class org.jivesoftware.smack.packet.Stanza

addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensions, getExtensionsXML, getFrom, getLanguage, getPacketID, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, overrideExtension, removeExtension, removeExtension, setError, setFrom, setLanguage, setPacketID, setStanzaId, setTo, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentWorkgroups

public AgentWorkgroups(String agentJID)

Creates an AgentWorkgroups request for the given agent. This IQ will be sent and an answer will be received with the jid of the workgroups where the agent can work.

Parameters:

agentJID - the id of the agent to get his workgroups.

AgentWorkgroups

public AgentWorkgroups(String agentJID,
                       List<String> workgroups)

Creates an AgentWorkgroups which will contain the JIDs of the workgroups where an agent can work.

Parameters:

agentJID - the id of the agent that can work in the list of workgroups.

workgroups - the list of workgroup JIDs where the agent can work.

Method Detail

getAgentJID

public String getAgentJID()

getWorkgroups

public List<String> getWorkgroups()

Returns a list of workgroup JIDs where the agent can work.

Returns:

a list of workgroup JIDs where the agent can work.

getIQChildElementBuilder

protected IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder buf)

Description copied from class: IQ

This method must be overwritten by IQ subclasses to create their child content. It is important that the builder does not include the final end element. This will be done automatically by IQChildelementXmlStringBuilder after eventual existing stanza(/packet) extensions have been added.

For example to create an IQ with a extra attribute and an additional child element

 
 <iq to='foo@example.org' id='123'>
   <bar xmlns='example:bar' extraAttribute='blaz'>
      <extraElement>elementText</extraElement>
   </bar>
 </iq>
 
 

the body of the getIQChildElementBuilder looks like

 
 // The builder 'xml' will already have the child element and the 'xmlns' attribute added
 // So the current builder state is "<bar xmlns='example:bar'"
 xml.attribute("extraAttribute", "blaz");
 xml.rightAngleBracket();
 xml.element("extraElement", "elementText");
 // Do not close the 'bar' attribute by calling xml.closeElement('bar')
 
 

If your IQ only contains attributes and no child elements, i.e. it can be represented as empty element, then you can mark it as such.

 xml.attribute("myAttribute", "myAttributeValue");
 xml.setEmptyElement();
 

If your IQ does not contain any attributes or child elements (besides stanza(/packet) extensions), consider sub-classing SimpleIQ instead.

Specified by:

getIQChildElementBuilder in class IQ

Parameters:

buf - a pre-created builder which already has the child element and the 'xmlns' attribute set.

Returns:

the build to create the IQ child content.