public interface

CacheResults

implements MonitorResults
com.microstrategy.web.objects.admin.monitors.CacheResults

Class Overview

The interface CacheResults represents the result of a cache retrieval.

Summary

Public Methods
abstract void alter(Cache[] caches, int action)
Manipulates the caches with the specified cache administration action.
abstract Caches get(int i)
Returns the Caches object at the specified index.
abstract Caches item(String projectDSSID)
Returns the Caches object by the specified project DSSID.
abstract int size()
Returns the number of Caches in the current collection.
[Expand]
Inherited Methods
From interface com.microstrategy.web.objects.admin.monitors.MonitorResults

Public Methods

public abstract void alter (Cache[] caches, int action)

Manipulates the caches with the specified cache administration action.

Parameters
caches an array of Cache to be manipulated
action indicates cache administration action, a value from EnumDSSXMLCacheAdminAction
Throws
MonitorManipulationException thrown if there are failures to manipilate caches.
WebObjectsAdminException throwns if there is any fatal error preventing this operation, such as network error, server crash, etc.

public abstract Caches get (int i)

Returns the Caches object at the specified index.

Parameters
i the index of a Caches object
Returns
  • the Caches object at the specified index.

public abstract Caches item (String projectDSSID)

Returns the Caches object by the specified project DSSID. Caches are aggregated at the project level.

Parameters
projectDSSID the project DSSID.
Returns
  • the Caches object

public abstract int size ()

Returns the number of Caches in the current collection.

Returns
  • the number of Caches in the collection.