com.crystaldecisions.sdk.occa.infostore
Interface IQueryConfiguration

public interface IQueryConfiguration

Represents possible options that can be passed to the CMS during a query. The options are stateful when passed to the CMS, and as such only needs to be passed once.

Method Summary

java.lang.Integer	getCacheTimeout() Returns how long in seconds before the cached query expires on the CMS
boolean	isClearingCache() Whether to clear the query's cache.
java.lang.Boolean	isTimeoutResetOnQuery() If true, the TIMEOUT value is reset to its inital value on subsequent queries that don't specify a TIMEOUT option.
java.lang.Boolean	isTimerResetOnQuery() If true, the timer resets itself on every subsequent query.
void	setCacheTimeout(java.lang.Integer timeout) Sets how long in seconds before the cached query expires on the CMS
void	setClearCache(boolean clear) Sets whether the query's cache should be cleared.
void	setTimeoutResetOnQuery(java.lang.Boolean resetTimeout) Sets whether of or not the TIMEOUT should reset to it's inital value or not
void	setTimerResetOnQuery(java.lang.Boolean timerOnQuery) Sets whether the timer should reset on each subsequent query.

Method Detail

getCacheTimeout

java.lang.Integer getCacheTimeout()

Returns how long in seconds before the cached query expires on the CMS

Returns:

The TIMEOUT value for the next query. If null, the option is not specified.

setCacheTimeout

void setCacheTimeout(java.lang.Integer timeout)

Sets how long in seconds before the cached query expires on the CMS

Parameters:

timeout - The timeout value in seconds. If null, the TIMEOUT configuration is removed.

isTimeoutResetOnQuery

java.lang.Boolean isTimeoutResetOnQuery()

If true, the TIMEOUT value is reset to its inital value on subsequent queries that don't specify a TIMEOUT option. If false, the TIMEOUT value will reset to the most recent TIMEOUT value that was specified.

Returns:

True, if you want subsequent queries to revert to the the inital TIMEOUT value. False otherwise. If null, the option was not specified

setTimeoutResetOnQuery

void setTimeoutResetOnQuery(java.lang.Boolean resetTimeout)

Sets whether of or not the TIMEOUT should reset to it's inital value or not

Parameters:

timeoutOnQuery - Whether to reset the timeout value or not. If null, the RESETTIMEOUTONQUERY configuration is removed.

isTimerResetOnQuery

java.lang.Boolean isTimerResetOnQuery()

If true, the timer resets itself on every subsequent query. If false, the timer will not reset itself, and will time out x seconds after the cache was initially created. Note that setting this to true could result in stale objects if they are not given enough time to refresh/timeout

Returns:

True if the timer should reset itself on subsequent queries. False otherwise. Null if the option is not set

setTimerResetOnQuery

void setTimerResetOnQuery(java.lang.Boolean timerOnQuery)

Sets whether the timer should reset on each subsequent query.

Parameters:

timerOnQuery - Whether to reset the timer on each subsequent query or not. If null, the RESETTIMERONQUERY configuration is removed.

isClearingCache

boolean isClearingCache()

Whether to clear the query's cache. If true, the query's cache is removed and the current query will not generate any cache.

Returns:

setClearCache

void setClearCache(boolean clear)

Sets whether the query's cache should be cleared. If true, the query's cache is removed and the current query will not generate any cache. By default false.

Parameters:

clear -