Interface CacheResultsOnServerLevel
-
- All Superinterfaces:
MonitorResults
public interface CacheResultsOnServerLevel extends MonitorResults
The interfaceCacheResults
represents the result of a cache retrieval.- Since:
- MicroStrategy Web 9.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
alter(Cache[] caches, int action)
Manipulates the caches with the specified cache administration action.CacheManipulationStatus
getCacheManipulationStatus()
Returns the cache manipulation status.int
getLoadedTotalCount()
Returns the total loaded cache counts on IServer level.int
getUnloadedTotalCount()
Returns the total unloaded cache counts on IServer level.boolean
isServerLevel()
Returns flag for control fetching caches on IServer level or not.int
size()
Returns the number ofCaches
in the current collection.-
Methods inherited from interface com.microstrategy.web.objects.admin.monitors.MonitorResults
elements, getCount, getCountSummary, getLevel, getServerBusyIndicator, getTotal
-
-
-
-
Method Detail
-
alter
void alter(Cache[] caches, int action) throws MonitorManipulationException, WebObjectsAdminException
Manipulates the caches with the specified cache administration action.- Parameters:
caches
- an array ofCache
to be manipulatedaction
- indicates cache administration action, a value fromEnumDSSXMLCacheAdminAction
- 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.
-
size
int size()
Returns the number ofCaches
in the current collection.- Returns:
- the number of
Caches
in the collection.
-
getLoadedTotalCount
int getLoadedTotalCount()
Returns the total loaded cache counts on IServer level.
-
getUnloadedTotalCount
int getUnloadedTotalCount()
Returns the total unloaded cache counts on IServer level.
-
isServerLevel
boolean isServerLevel()
Returns flag for control fetching caches on IServer level or not.
-
getCacheManipulationStatus
CacheManipulationStatus getCacheManipulationStatus()
Returns the cache manipulation status. Notes: The cache asynchronous manipulation process: step1: use the "mcbs" xml command with async flag to manipulate cache, IServer will return request id back. step2: use the "gcui" xml command with request id to get the above manipulation status info(ready, failure, or still processing).
-
-