org.jivesoftware.openfire.forms
Interface DataForm

public interface DataForm

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

The form could be of the following types:

• form -> Indicates a form to fill out.
• 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.

In case the form represents a search, the report will be structured in columns and rows. Use addReportedField(FormField) to set the columns of the report whilst the report's rows can be configured using addItemFields(ArrayList).

Author:

gdombiak

Field Summary

static String	TYPE_CANCEL
static String	TYPE_FORM
static String	TYPE_RESULT
static String	TYPE_SUBMIT

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	addItemFields(ArrayList itemFields) Adds a new row of items of reported data.
void	addReportedField(FormField field) Adds a field to the list of fields that will be returned from a search.
FormField	getField(String variable) Returns the field of the form whose variable matches the specified variable.
Iterator	getFields() Returns an Iterator for the fields that are part of the form.
int	getFieldsSize() Returns the number of fields included in the form.
Iterator	getInstructions() Returns an Iterator for the list of instructions that explain how to fill out the form and what the form is about.
String	getTitle() Returns the description of the data.
String	getType() Returns the meaning of the data within the context.
void	setInstructions(List instructions) Sets the list of instructions that explain how to fill out the form and what the form is about.
void	setTitle(String title) Sets the description of the data.

Field Detail

TYPE_FORM

static final String TYPE_FORM

See Also:

Constant Field Values

TYPE_SUBMIT

static final String TYPE_SUBMIT

See Also:

Constant Field Values

TYPE_CANCEL

static final String TYPE_CANCEL

See Also:

Constant Field Values

TYPE_RESULT

static final String TYPE_RESULT

See Also:

Constant Field Values

Method Detail

setTitle

void setTitle(String title)

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