org.jvoicexml

Class DocumentDescriptor

java.lang.Object

org.jvoicexml.DocumentDescriptor

public final class DocumentDescriptor
extends java.lang.Object

Attributes describing a VoiceXML document to retrieve from the DocumentServer.

Since:

0.7

Constructor Summary

Constructors

Constructor and Description
DocumentDescriptor(java.net.URI documentUri) Constructs a new object with the request method set to RequestMethod.GET.
DocumentDescriptor(java.net.URI documentUri, org.jvoicexml.xml.vxml.RequestMethod requestMethod) Constructs a new object.
DocumentDescriptor(java.net.URI documentUri, org.jvoicexml.xml.vxml.RequestMethod requestMethod, boolean force) Constructs a new object.

Method Summary

Modifier and Type	Method and Description
void	addParamater(java.lang.String key, java.lang.Object value) Adds the given parameter to the list of known parameters.
void	addParameter(KeyValuePair pair) Adds the given parameter to the list of known parameters.
void	addParameters(java.util.Collection<KeyValuePair> pairs) Adds the given parameter to the list of known parameters.
void	addParameters(java.util.Map<java.lang.String,java.lang.Object> parameters) Adds the given parameters to the list of known parameters.
FetchAttributes	getAttributes() Retrieve the fetch attributes.
org.jvoicexml.xml.vxml.RequestMethod	getMethod() Retrieves the request method.
java.util.Collection<KeyValuePair>	getParameters() Retrieves the known parameter.
java.net.URI	getUri() Retrieves the URI of the document to fetch.
boolean	isForceLoad() Checks if the document has to be retrieved although the document is in the cache.
void	setAttributes(FetchAttributes value) Sets the fetch attributes.
void	setURI(java.net.URI value) Sets the URI of the document.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentDescriptor

public DocumentDescriptor(java.net.URI documentUri)

Constructs a new object with the request method set to RequestMethod.GET.

Parameters:

documentUri - the URI of the document.

DocumentDescriptor

public DocumentDescriptor(java.net.URI documentUri,
                          org.jvoicexml.xml.vxml.RequestMethod requestMethod)

Constructs a new object.

Parameters:

documentUri - the URI of the document.

requestMethod - the request method.

DocumentDescriptor

public DocumentDescriptor(java.net.URI documentUri,
                          org.jvoicexml.xml.vxml.RequestMethod requestMethod,
                          boolean force)

Constructs a new object.

Parameters:

documentUri - the URI of the document.

requestMethod - the request method.

force - true if the document must be loaded

Method Detail

setURI

public void setURI(java.net.URI value)

Sets the URI of the document.

Parameters:

value - URI of the document.

getUri

public java.net.URI getUri()

Retrieves the URI of the document to fetch.

Returns:

URI of the document.

isForceLoad

public boolean isForceLoad()

Checks if the document has to be retrieved although the document is in the cache.

Returns:

true if the document must be retrieved.

Since:

0.7.5

getMethod

public org.jvoicexml.xml.vxml.RequestMethod getMethod()

Retrieves the request method.

Returns:

the request method.

getAttributes

public FetchAttributes getAttributes()

Retrieve the fetch attributes.

Returns:

the attributes

setAttributes

public void setAttributes(FetchAttributes value)

Sets the fetch attributes.

Parameters:

value - the attributes to set

addParameters

public void addParameters(java.util.Collection<KeyValuePair> pairs)

Adds the given parameter to the list of known parameters.

Parameters:

pairs - the parameters to add

addParameter

public void addParameter(KeyValuePair pair)

Adds the given parameter to the list of known parameters.

Parameters:

pair - the parameter to add

addParamater

public void addParamater(java.lang.String key,
                         java.lang.Object value)

Adds the given parameter to the list of known parameters.

Parameters:

key - the name of the parameter to add

value - the value of the parameter to add

Since:

0.7.8

addParameters

public void addParameters(java.util.Map<java.lang.String,java.lang.Object> parameters)

Adds the given parameters to the list of known parameters.

Parameters:

parameters - the parameters to add

Since:

0.7.8

getParameters

public java.util.Collection<KeyValuePair> getParameters()

Retrieves the known parameter.

Returns:

known parameters