public interface Application
Application is a set of documents sharing the same
application root document.
Whenever the user interacts with a document in an application, its application root document is also loaded. The application root document remains loaded while the user is transitioning between other documents in the same application, and it is unloaded when the user transitions to a document that is not in the application. While it is loaded, the application root document's variables are available to the other documents as application variables, and its grammars remain active for the duration of the application.
| Modifier and Type | Method and Description |
|---|---|
void |
addDocument(java.net.URI uri,
org.jvoicexml.xml.vxml.VoiceXmlDocument doc)
Adds the given document to the application.
|
java.net.URI |
getApplication()
Retrieves the URI of the application.
|
org.jvoicexml.xml.vxml.VoiceXmlDocument |
getCurrentDocument()
Retrieves the current document.
|
java.util.List<LastResult> |
getLastResult()
Retrieves information about the last recognition to occur within this
application.
|
java.net.URI |
getXmlBase()
Retrieves the base URI.
|
boolean |
isLoaded(java.net.URI uri)
Checks, if the document with the given
uri is loaded. |
java.net.URI |
resolve(java.net.URI uri)
Converts the given
URI into a hierarchical URI. |
java.net.URI |
resolve(java.net.URI baseUri,
java.net.URI uri)
Converts the given
URI into a hierarchical URI. |
void |
setLastResult(java.util.List<LastResult> lastresult)
Sets the last result.
|
void |
setRootDocument(org.jvoicexml.xml.vxml.VoiceXmlDocument document)
Sets the new root document.
|
void addDocument(java.net.URI uri,
org.jvoicexml.xml.vxml.VoiceXmlDocument doc)
throws BadFetchError
uri - the URI of the document.doc - the document to add.BadFetchError - error in the document.org.jvoicexml.xml.vxml.VoiceXmlDocument getCurrentDocument()
java.net.URI getApplication()
void setRootDocument(org.jvoicexml.xml.vxml.VoiceXmlDocument document)
throws BadFetchError
document - the new root document.BadFetchError - error in the document.boolean isLoaded(java.net.URI uri)
uri is loaded.uri - the URI to check.true if the document is loaded.java.net.URI getXmlBase()
java.net.URI resolve(java.net.URI uri)
URI into a hierarchical URI. If the given
URI is a relative URI, it is expanded using the application URI.uri - the URI to resolve.java.net.URI resolve(java.net.URI baseUri,
java.net.URI uri)
URI into a hierarchical URI. If the given
URI is a relative URI, it is expanded using the
baseUri.baseUri - the base URI.uri - the URI to resolve.void setLastResult(java.util.List<LastResult> lastresult)
lastresult - the last result to set.java.util.List<LastResult> getLastResult()
null.