org.jvoicexml.interpreter
Interface ExecutableForm

All Superinterfaces:

DialogConstruct

All Known Implementing Classes:

ExecutableMenuForm, ExecutablePlainForm

public interface ExecutableForm
extends DialogConstruct

ExecutableForms are either <form> or a <menu> and are interpreted via the FormInterpretationAlgorithm. They can contain FormItems.

Since:

0.4

Version:

$Revision: 216 $

Copyright © 2006-2007 JVoiceXML group - http://jvoicexml.sourceforge.net/

Author:

Dirk Schnelle

See Also:

FormInterpretationAlgorithm, FormItem

Field Summary

static String

UNNAMED_FORM Default name of an unnamed form.

Method Summary

NodeList	getChildNodes() Retrieves the child nodes of this executable form.
Collection<FormItem>	getFormItems(VoiceXmlInterpreterContext context) Retrieves all FormItems, defined in this form.
String	getId() Retrieves the identifier of this ExecutableForm.

Field Detail

UNNAMED_FORM

static final String UNNAMED_FORM

Default name of an unnamed form.

See Also:

Constant Field Values

Method Detail

getId

String getId()

Retrieves the identifier of this ExecutableForm. It allows the ExecutableForm to be target of a <goto> or a <submit>.

If the related form or menu does not provide an id, UNNAMED_FORM is returned as the id for this form.

Returns:

Identifier for this form.

See Also:

UNNAMED_FORM

getChildNodes

NodeList getChildNodes()

Retrieves the child nodes of this executable form.

Returns:

Child nodes of this executable form

Stuff to complete

Check if this can be replaced by a collection.

getFormItems

Collection<FormItem> getFormItems(VoiceXmlInterpreterContext context)

Retrieves all FormItems, defined in this form.

Parameters:

context - The current context.

Returns:

Collection of FormItems.