Package com.microstrategy.web.objects

Interface WebCacheStatement

All Superinterfaces:

WebStatement

public interface WebCacheStatement
extends WebStatement

Deprecated.

Starting with version 9.0 and the advent of Distribution Services, all schedule objects are replaced by subscriptions.

This object defines a statement which is used to identify a server command within a schedule that targets a Cache. Corresponding to a cache schedule(pre-existing and read from IServer or one to be newly created on IServer) a WebCacheStatement holds such information as the cache command, cache options, target report/project. This object cannot be directly instantiated, and can only be obtained indirectly from the other scheduling-related objects.

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

Modifier and Type	Method	Description
int	getCacheCommand()	Deprecated. Returns the cache command property.
int	getCacheOptions()	Deprecated. Returns the cache options for a cache expiration request.
WebObjectInfo	getProjectInfo()	Deprecated. Returns the project which the statement applies to.
WebObjectInfo	getReportInfo()	Deprecated. Returns a WebObjectInfo object corresponding to the targert report object, if any, for this cache statement.
void	setCacheCommand(int cacheCommand)	Deprecated. Sets the cache command property.
void	setCacheOptions(int cacheOptions)	Deprecated. Sets the cache options for a cache expiration request.
void	setReportInfo(WebObjectInfo reportTarget)	Deprecated. Sets the target report.

Methods inherited from interface com.microstrategy.web.objects.WebStatement

getStatementType

Method Detail

getReportInfo

WebObjectInfo getReportInfo()

Deprecated.

Returns a WebObjectInfo object corresponding to the targert report object, if any, for this cache statement.

Returns:

A WebObjectInfo, populated with relevant information about this statement object.The object returned can be null, if the cache statement does not correspond to a single report.

setReportInfo

void setReportInfo(WebObjectInfo reportTarget)

Deprecated.

Sets the target report. It is used to identify the report cache to expire.

Parameters:

reportTarget - The target WebObjectInfo. A value of null is valid for this type of statement.

getCacheCommand

int getCacheCommand()

Deprecated.

Returns the cache command property. Cache command is a value from the enumeration EnumDSSXMLCacheExpCommand which describes the cache expiration request for cache schedule.

The default value of this property is EnumDSSXMLCacheExpCommand.DssXmlCacheExpCommandInvalidate.

Returns:

The current setting for a cache command, from EnumDSSXMLCacheExpCommand.

setCacheCommand

void setCacheCommand(int cacheCommand)

Deprecated.

Sets the cache command property. Cache command is a value from the enumeration EnumDSSXMLCacheExpCommand which describes the cache expiration request for cache schedule.

Note

[1] Setting the cache command to EnumDSSXMLCacheExpCommand.DssXmlCacheExpCommandElementPurge defaults the cache option to EnumDSSXMLCacheExpOptions.DssXmlCacheExpReserved and ReportInfo to null.

[2] Setting the cache command to EnumDSSXMLCacheExpCommand.DssXmlCacheExpCommandInvalidate or EnumDSSXMLCacheExpCommand.DssXmlCacheExpCommandDelete defaults the cache option to EnumDSSXMLCacheExpOptions.DssXmlCacheExpOptionsBoth.

Parameters:

cacheCommand - The setting to use for a cache expiration command, from EnumDSSXMLCacheExpCommand.

getCacheOptions

int getCacheOptions()

Deprecated.

Returns the cache options for a cache expiration request.

The default value of this flag is EnumDSSXMLCacheExpOptions.DssXmlCacheExpOptionsBoth.

Returns:

A value from the enumeration EnumDSSXMLCacheExpOptions, describing the current CacheOptions flag.

setCacheOptions

void setCacheOptions(int cacheOptions)

Deprecated.

Sets the cache options for a cache expiration request. Possible values are enumerated in EnumDSSXMLCacheExpOptions.

Note

[1] With a cache option of EnumDSSXMLCacheExpOptions.DssXmlCacheExpReserved, a value of EnumDSSXMLCacheExpCommand.DssXmlCacheExpCommandInvalidate or EnumDSSXMLCacheExpCommand.DssXmlCacheExpCommandDelete for the cache command value is erroneous and will throw error on trying to save such a schedule.

[2] Similarly, a cache option of EnumDSSXMLCacheExpOptions.DssXmlCacheExpOptionsBoth with a value other than EnumDSSXMLCacheExpCommand.DssXmlCacheExpCommandElementPurge for the cache command is erroneous and will throw error on trying to save such a schedule.

Parameters:

cacheOptions - A value from the enumeration EnumDSSXMLCacheExpOptions.

getProjectInfo

WebObjectInfo getProjectInfo()

Deprecated.

Returns the project which the statement applies to.

Returns:

The WebObjectInfo object corresponding to the project which this cache-related statement should apply to.