org.jivesoftware.smackx.packet
Class DataForm

java.lang.Object
  org.jivesoftware.smackx.packet.DataForm

All Implemented Interfaces:

PacketExtension

public class DataForm
extends Object
implements PacketExtension

Represents a form that could be use for gathering data as well as for reporting data returned from a search.

Author:

Gaston Dombiak

Nested Class Summary

static class	DataForm.Item Represents items of reported data.
static class	DataForm.ReportedData Represents the fields that will be returned from a search.

Constructor Summary

DataForm(String type)

Method Summary

void	addField(FormField field) Adds a new field as part of the form.
void	addInstruction(String instruction) Adds a new instruction to the list of instructions that explain how to fill out the form and what the form is about.
void	addItem(DataForm.Item item) Adds a new item returned from a search.
String	getElementName() Returns the root element name.
Iterator<FormField>	getFields() Returns an Iterator for the fields that are part of the form.
Iterator<String>	getInstructions() Returns an Iterator for the list of instructions that explain how to fill out the form and what the form is about.
Iterator<DataForm.Item>	getItems() Returns an Iterator for the items returned from a search.
String	getNamespace() Returns the root element XML namespace.
DataForm.ReportedData	getReportedData() Returns the fields that will be returned from a search.
String	getTitle() Returns the description of the data.
String	getType() Returns the meaning of the data within the context.
void	setInstructions(List<String> instructions) Sets the list of instructions that explain how to fill out the form and what the form is about.
void	setReportedData(DataForm.ReportedData reportedData) Sets the fields that will be returned from a search.
void	setTitle(String title) Sets the description of the data.
String	toXML() Returns the XML reppresentation of the PacketExtension.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataForm

public DataForm(String type)

Method Detail

getType

public String getType()

Returns the meaning of the data within the context. The data could be part of a form to fill out, a form submission or data results.

Possible form types are:

• form -> This packet contains a form to fill out. Display it to the user (if your program can).
• submit -> The form is filled out, and this is the data that is being returned from the form.
• cancel -> The form was cancelled. Tell the asker that piece of information.
• result -> Data results being returned from a search, or some other query.

Returns:

the form's type.

getTitle

public String getTitle()

Returns the description of the data. It is similar to the title on a web page or an X window. You can put a