org.jvoicexml.interpreter.formitem
Class SubdialogFormItem

java.lang.Object
  org.jvoicexml.interpreter.formitem.AbstractFormItem
      org.jvoicexml.interpreter.formitem.InputItem
          org.jvoicexml.interpreter.formitem.SubdialogFormItem

All Implemented Interfaces:

DialogConstruct, FormItem, PromptCountable, FormItemVisitable

public final class SubdialogFormItem
extends InputItem

A <>subdialog> input item is roughly like a function call. It invokes another dialog on the current page, or invokes another VoiceXML document. It returns an ECMAScript Object as its result.

Version:

$Revision: 110 $

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

Author:

Dirk Schnelle

Constructor Summary

SubdialogFormItem(VoiceXmlInterpreterContext context, VoiceXmlNode voiceNode)
Create a new subdialog input item.

Method Summary

EventHandler	accept(FormItemVisitor visitor) Execute the specific method of the visitor.
Class<? extends Object>	getShadowVariableContainer() Retrieves the implementation of the shadow var container for this input item.

Methods inherited from class org.jvoicexml.interpreter.formitem.InputItem

createShadowVarContainer, getEventCount, getPromptCount, getShadowVarContainerName, incrementEventCounter, incrementPromptCount, resetEventCounter, resetPromptCount

Methods inherited from class org.jvoicexml.interpreter.formitem.AbstractFormItem

getCatchElements, getContext, getExpr, getFormItemVariable, getName, getNode, isSelectable, setFormItemVariable

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jvoicexml.interpreter.formitem.PromptCountable

getName, getNode

Constructor Detail

SubdialogFormItem

public SubdialogFormItem(VoiceXmlInterpreterContext context,
                         VoiceXmlNode voiceNode)

Create a new subdialog input item.

Parameters:

context - The current VoiceXmlInterpreterContext.

voiceNode - The corresponding xml node in the VoiceXML document.

Method Detail

accept

public EventHandler accept(FormItemVisitor visitor)
                    throws JVoiceXMLEvent

Execute the specific method of the visitor.

Parameters:

visitor - The visitor to use.

Returns:

The event handler to use for the processing.

Throws:

JVoiceXMLEvent - Error or event visiting the form item.

getShadowVariableContainer

public Class<? extends Object> getShadowVariableContainer()

Retrieves the implementation of the shadow var container for this input item.

Specified by:

getShadowVariableContainer in class InputItem

Returns:

Class of the shadow var container, null if there is no shadow var container.

Stuff to complete

Implement this method.