org.jvoicexml

Class FetchAttributes

java.lang.Object

org.jvoicexml.FetchAttributes

All Implemented Interfaces:

java.lang.Cloneable

public final class FetchAttributes
extends java.lang.Object
implements java.lang.Cloneable

A VoiceXML interpreter context needs to fetch VoiceXML documents, and other resources, such as audio files, grammars, scripts, and objects. Each fetch of the content associated with a URI is governed by one of the attributes in this container.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HINT_PREFETCH Prefetch hint that indicates a file may be downloaded when the page is loaded.
static java.lang.String	HINT_SAFE Prefetch hint that indicates a file that should only be downloaded when actually needed.

Constructor Summary

Constructors

Constructor and Description
FetchAttributes() Construct a new object.
FetchAttributes(FetchAttributes attributes) Copy constructor.

Method Summary

Modifier and Type	Method and Description
java.net.URI	getFetchAudio() Retrieve the fetchAudio attribute.
java.lang.String	getFetchHint() Set the fetchhint attribute.
long	getFetchTimeout() Set the fetchtimeout attribute.
long	getMaxage() Set the maxage attribute.
long	getMaxstale() Set the maxstale attribute.
boolean	isFetchintPrefetch() Checks if the fetchint has a value of HINT_PREFETCH
boolean	isFetchintSafe() Checks if the fetchint has a value of HINT_SAFE
void	setFetchAudio(java.net.URI uri) Set the fetchAudio attribute.
void	setFetchHint(java.lang.String hint) Retrieve the fetchhint attribute.
void	setFetchTimeout(long seconds) Retrieve the fetchtimeout attribute.
void	setMaxage(long seconds) Retrieve the maxage attribute.
void	setMaxstale(long seconds) Retrieve the maxstale attribute.

Methods inherited from class java.lang.Object

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

Field Detail

HINT_PREFETCH

public static final java.lang.String HINT_PREFETCH

Prefetch hint that indicates a file may be downloaded when the page is loaded.

See Also:

fetchHint, Constant Field Values

HINT_SAFE

public static final java.lang.String HINT_SAFE

Prefetch hint that indicates a file that should only be downloaded when actually needed.

See Also:

fetchHint, Constant Field Values

Constructor Detail

FetchAttributes

public FetchAttributes()

Construct a new object.

FetchAttributes

public FetchAttributes(FetchAttributes attributes)

Copy constructor.

Parameters:

attributes - fetch attributes to copy from.

Method Detail

setFetchTimeout

public void setFetchTimeout(long seconds)

Retrieve the fetchtimeout attribute.

Parameters:

seconds - Number of seconds to wait.

See Also:

fetchTimeout

getFetchTimeout

public long getFetchTimeout()

Set the fetchtimeout attribute.

Returns:

Number of seconds to wait.

See Also:

fetchTimeout

setFetchHint

public void setFetchHint(java.lang.String hint)

Retrieve the fetchhint attribute.

Parameters:

hint - Hint when the interpreter context should retrieve content from the server.

See Also:

fetchHint

getFetchHint

public java.lang.String getFetchHint()

Set the fetchhint attribute.

Returns:

Hint when the interpreter context should retrieve content from the server.

See Also:

fetchHint

isFetchintPrefetch

public boolean isFetchintPrefetch()

Checks if the fetchint has a value of HINT_PREFETCH

Returns:

true if the it is OK to prefetch the document.

Since:

0.7.8

isFetchintSafe

public boolean isFetchintSafe()

Checks if the fetchint has a value of HINT_SAFE

Returns:

true if the document should be downloaded when actually needed.

Since:

0.7.8

setMaxage

public void setMaxage(long seconds)

Retrieve the maxage attribute.

Parameters:

seconds - Maximum age of documents in seconds.

See Also:

maxage

getMaxage

public long getMaxage()

Set the maxage attribute.

Returns:

Maximum age of documents in seconds.

See Also:

maxage

setMaxstale

public void setMaxstale(long seconds)

Retrieve the maxstale attribute.

Parameters:

seconds - Number of seconds to use content that has exceeded its expiration time.

See Also:

maxstale

getMaxstale

public long getMaxstale()

Set the maxstale attribute.

Returns:

Number of seconds to use content that has exceeded its expiration time.

See Also:

maxstale

setFetchAudio

public void setFetchAudio(java.net.URI uri)

Set the fetchAudio attribute.

Parameters:

uri - URI of the audio clip to play while the fetch is being done.

See Also:

fetchAudio

getFetchAudio

public java.net.URI getFetchAudio()

Retrieve the fetchAudio attribute.

Returns:

URI of the audio clip to play while the fetch is being done.