public interface

WebCacheStatement

implements WebStatement
com.microstrategy.web.objects.WebCacheStatement

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

Class Overview

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.

Summary

Public Methods
abstract int getCacheCommand()
Returns the cache command property.
abstract int getCacheOptions()
Returns the cache options for a cache expiration request.
abstract WebObjectInfo getProjectInfo()
Returns the project which the statement applies to.
abstract WebObjectInfo getReportInfo()
Returns a WebObjectInfo object corresponding to the targert report object, if any, for this cache statement.
abstract void setCacheCommand(int cacheCommand)
Sets the cache command property.
abstract void setCacheOptions(int cacheOptions)
Sets the cache options for a cache expiration request.
abstract void setReportInfo(WebObjectInfo reportTarget)
Sets the target report.
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.WebStatement

Public Methods

public abstract int getCacheCommand ()

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 DssXmlCacheExpCommandInvalidate.

Returns

public abstract int getCacheOptions ()

Returns the cache options for a cache expiration request.

The default value of this flag is DssXmlCacheExpOptionsBoth.

Returns

public abstract WebObjectInfo getProjectInfo ()

Returns the project which the statement applies to.

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

public abstract WebObjectInfo getReportInfo ()

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.

public abstract void setCacheCommand (int cacheCommand)

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 DssXmlCacheExpCommandElementPurge defaults the cache option to DssXmlCacheExpReserved and ReportInfo to null.

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

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

public abstract void setCacheOptions (int cacheOptions)

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

Note

[1] With a cache option of DssXmlCacheExpReserved, a value of DssXmlCacheExpCommandInvalidate or 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 DssXmlCacheExpOptionsBoth with a value other than 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.

public abstract void setReportInfo (WebObjectInfo reportTarget)

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.