org.jivesoftware.smackx.commands.packet

Class AdHocCommandData

java.lang.Object

org.jivesoftware.smack.packet.Packet

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.commands.packet.AdHocCommandData

public class AdHocCommandData
extends IQ

Represents the state and the request of the execution of an adhoc command.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdHocCommandData.SpecificError

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

IQ.Type

Field Summary

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

DEFAULT_LANGUAGE, ID_NOT_AVAILABLE

Constructor Summary

Constructors

Constructor and Description
AdHocCommandData()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAction(AdHocCommand.Action action)
void	addNote(AdHocCommandNote note)
AdHocCommand.Action	getAction() Returns the action to execute.
java.util.List<AdHocCommand.Action>	getActions()
java.lang.String	getChildElementXML() Returns the sub-element XML section of the IQ packet, or null if there isn't one.
AdHocCommand.Action	getExecuteAction()
DataForm	getForm() Returns the form of the command.
java.lang.String	getId() Returns the JID of the command host.
java.lang.String	getName() Returns the human name of the command
java.lang.String	getNode() Returns the identifier of the command
java.util.List<AdHocCommandNote>	getNotes() Returns the list of notes that the command has.
java.lang.String	getSessionID()
AdHocCommand.Status	getStatus() Returns the status of the execution.
void	remveNote(AdHocCommandNote note)
void	setAction(AdHocCommand.Action action)
void	setExecuteAction(AdHocCommand.Action executeAction)
void	setForm(DataForm form)
void	setId(java.lang.String id)
void	setName(java.lang.String name)
void	setNode(java.lang.String node)
void	setSessionID(java.lang.String sessionID)
void	setStatus(AdHocCommand.Status status)

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

createErrorResponse, createResultIQ, getType, setType, toXML

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

addCommonAttributes, addExtension, addExtensions, equals, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getTo, getXmlns, hashCode, nextID, removeExtension, setDefaultXmlns, setError, setFrom, setPacketID, setTo, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AdHocCommandData

public AdHocCommandData()

Method Detail

getChildElementXML

public java.lang.String getChildElementXML()

Description copied from class: IQ

Returns the sub-element XML section of the IQ packet, or null if there isn't one. Packet extensions must be included, if any are defined.

Extensions of this class must override this method.

Specified by:

getChildElementXML in class IQ

Returns:

the child element section of the IQ XML.

getId

public java.lang.String getId()

Returns the JID of the command host.

Returns:

the JID of the command host.

setId

public void setId(java.lang.String id)

getName

public java.lang.String getName()

Returns the human name of the command

Returns:

the name of the command.

setName

public void setName(java.lang.String name)

getNode

public java.lang.String getNode()

Returns the identifier of the command

Returns:

the node.

setNode

public void setNode(java.lang.String node)

getNotes

public java.util.List<AdHocCommandNote> getNotes()

Returns the list of notes that the command has.

Returns:

the notes.

addNote

public void addNote(AdHocCommandNote note)

remveNote

public void remveNote(AdHocCommandNote note)

getForm

public DataForm getForm()

Returns the form of the command.

Returns:

the data form associated with the command.

setForm

public void setForm(DataForm form)

getAction

public AdHocCommand.Action getAction()

Returns the action to execute. The action is set only on a request.

Returns:

the action to execute.

setAction

public void setAction(AdHocCommand.Action action)

getStatus

public AdHocCommand.Status getStatus()

Returns the status of the execution.

Returns:

the status.

setStatus

public void setStatus(AdHocCommand.Status status)

getActions

public java.util.List<AdHocCommand.Action> getActions()

addAction

public void addAction(AdHocCommand.Action action)

setExecuteAction

public void setExecuteAction(AdHocCommand.Action executeAction)

getExecuteAction

public AdHocCommand.Action getExecuteAction()

setSessionID

public void setSessionID(java.lang.String sessionID)

getSessionID

public java.lang.String getSessionID()