org.jvoicexml.interpreter.form
Class ExecutableMenuForm

java.lang.Object
  org.jvoicexml.interpreter.form.ExecutableMenuForm

All Implemented Interfaces:

DialogConstruct, ExecutableForm

public final class ExecutableMenuForm
extends Object
implements ExecutableForm

Implementation of an ExecutableForm for the <menu> tag.

Since:

0.4

Version:

$Revision: 216 $

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

Author:

Dirk Schnelle

See Also:

Menu

Field Summary

Fields inherited from interface org.jvoicexml.interpreter.ExecutableForm

UNNAMED_FORM

Constructor Summary

ExecutableMenuForm(Menu tag)
Constructs a new object.

Method Summary

NodeList	getChildNodes() Retrieves the child nodes of this executable form.
Collection<FormItem>	getFormItems(VoiceXmlInterpreterContext context) Retrieves all FormItems, defined in this form. Creates an anonymous field, which does not exist in the document.
String	getId() Retrieves the identifier of this ExecutableForm.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutableMenuForm

public ExecutableMenuForm(Menu tag)

Constructs a new object.

Parameters:

tag - The menu tag.

Method Detail

getId

public 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.

Specified by:

getId in interface ExecutableForm

Returns:

Identifier for this form.

See Also:

ExecutableForm.UNNAMED_FORM

getChildNodes

public NodeList getChildNodes()

Retrieves the child nodes of this executable form.

Specified by:

getChildNodes in interface ExecutableForm

Returns:

Child nodes of this executable form

getFormItems

public Collection<FormItem> getFormItems(VoiceXmlInterpreterContext context)

Retrieves all FormItems, defined in this form. Creates an anonymous field, which does not exist in the document.

Specified by:

getFormItems in interface ExecutableForm

Parameters:

context - The current context.

Returns:

Collection of FormItems.