public final class DocumentDescriptor
extends java.lang.Object
DocumentServer.| 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.
|
| 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.
|
public DocumentDescriptor(java.net.URI documentUri)
RequestMethod.GET.documentUri - the URI of the document.public DocumentDescriptor(java.net.URI documentUri,
org.jvoicexml.xml.vxml.RequestMethod requestMethod)
documentUri - the URI of the document.requestMethod - the request method.public DocumentDescriptor(java.net.URI documentUri,
org.jvoicexml.xml.vxml.RequestMethod requestMethod,
boolean force)
documentUri - the URI of the document.requestMethod - the request method.force - true if the document must be loadedpublic void setURI(java.net.URI value)
value - URI of the document.public java.net.URI getUri()
public boolean isForceLoad()
true if the document must be retrieved.public org.jvoicexml.xml.vxml.RequestMethod getMethod()
public FetchAttributes getAttributes()
public void setAttributes(FetchAttributes value)
value - the attributes to setpublic void addParameters(java.util.Collection<KeyValuePair> pairs)
pairs - the parameters to addpublic void addParameter(KeyValuePair pair)
pair - the parameter to addpublic void addParamater(java.lang.String key,
java.lang.Object value)
key - the name of the parameter to addvalue - the value of the parameter to addpublic void addParameters(java.util.Map<java.lang.String,java.lang.Object> parameters)
parameters - the parameters to addpublic java.util.Collection<KeyValuePair> getParameters()