Summary: Methods | [Expand All]
public interface

Cache

com.microstrategy.web.objects.admin.monitors.Cache
Known Indirect Subclasses

Class Overview

The interface Cache represents a real cache slot in the memory of the Intelligence Server.

Summary

Public Methods
abstract String getCacheSourceID()
Returns the ID of the source to which this cache belong, where source could be report or document.
abstract String getCacheSourceName()
Returns the name of the source to which this cache belong, where source could be report or document.
abstract Set<WebObjectCouple<WebDBRole, WebDBConnection>> getConnectionCouples()
Returns the set of WebObjectCouple objects coupling a WebDBRole object and a WebDBConnection object
abstract Date getCreationTime()
Returns the cache creation time.
abstract String getCreator()
Returns the creator user name
abstract Map<String, WebDBConnection> getDBConnections()
Returns a map of dbConnection objects associated with this cache.
abstract Map<String, WebDBLogin> getDBLogins()
Returns a map of dbLogin objects associated with this cache.
abstract Map<String, WebDBRole> getDBRoles()
Returns a map of dbRole objects associated with this cache.
abstract Date getExpirationTime()
Returns the cache expiration time
abstract int getHistoricHitCount()
Returns the historic hit count of the cache.
abstract int getHitCount()
Returns the hit count of the cache.
abstract String getID()
Returns the DSSID of the cache
abstract Date getLastHitTime()
Returns the last hit time of the cache.
abstract Date getLastUpdateTime()
Returns the last update time of the cache.
abstract Locale getLocale()
Returns the locale used to run the report for this cache.
abstract Set<WebObjectCouple<WebDBRole, WebDBLogin>> getLoginCouples()
Returns the set of WebObjectCouple objects coupling a WebDBRole object and a WebDBLogin object
abstract String getProjectName()
Returns the project name
abstract String getPromptAnswers()
Returns the prompt answers used to generate this cache's report.
abstract Map<String, WebMDSecurityFilter> getSecurityFilters()
Returns a map of security filters associated with this cache.
abstract int getStatus()
Returns the cache status, a value from EnumDSSXMLReportCacheStatus
abstract int getType()
Returns the cache type, a value from EnumDSSXMLReportCacheType
abstract WebUser getUser()
Returns the user associated with this cache.
abstract boolean hasDetails()
Returns whether or not the cache details are available.
abstract int size()
Returns the cache size in KB

Public Methods

public abstract String getCacheSourceID ()

Returns the ID of the source to which this cache belong, where source could be report or document.

Returns
  • the ID of the source to which this cache belong.

public abstract String getCacheSourceName ()

Returns the name of the source to which this cache belong, where source could be report or document.

Returns
  • the name of the source to which this cache belong.

public abstract Set<WebObjectCouple<WebDBRole, WebDBConnection>> getConnectionCouples ()

Returns the set of WebObjectCouple objects coupling a WebDBRole object and a WebDBConnection object

Returns

public abstract Date getCreationTime ()

Returns the cache creation time.

Returns
  • the cache creation time.

public abstract String getCreator ()

Returns the creator user name

public abstract Map<String, WebDBConnection> getDBConnections ()

Returns a map of dbConnection objects associated with this cache. Each object is mapped by its objectID. Objects may not be populated. Check before use.

Returns

public abstract Map<String, WebDBLogin> getDBLogins ()

Returns a map of dbLogin objects associated with this cache. Each object is mapped by its objectID. Objects may not be populated. Check before use.

Returns
  • Map of String objects (IDs) to WebDBLogin objects.

public abstract Map<String, WebDBRole> getDBRoles ()

Returns a map of dbRole objects associated with this cache. Each object is mapped by its objectID. Objects may not be populated. Check before use.

Returns
  • Map of String objects (IDs) to WebDBRole objects.

public abstract Date getExpirationTime ()

Returns the cache expiration time

Returns
  • the cache expiration time

public abstract int getHistoricHitCount ()

Returns the historic hit count of the cache.

Returns
  • the historic hit count of the cache

public abstract int getHitCount ()

Returns the hit count of the cache.

Returns
  • the hit count of the cache

public abstract String getID ()

Returns the DSSID of the cache

Returns
  • the DSSID of the cache

public abstract Date getLastHitTime ()

Returns the last hit time of the cache.

Returns
  • the last hit time of the cache

public abstract Date getLastUpdateTime ()

Returns the last update time of the cache.

Returns
  • the last update time of the cache.

public abstract Locale getLocale ()

Returns the locale used to run the report for this cache. If no locale is specified, returns null

Returns
  • Locale object for this cache

public abstract Set<WebObjectCouple<WebDBRole, WebDBLogin>> getLoginCouples ()

Returns the set of WebObjectCouple objects coupling a WebDBRole object and a WebDBLogin object

Returns

public abstract String getProjectName ()

Returns the project name

Returns
  • the project name

public abstract String getPromptAnswers ()

Returns the prompt answers used to generate this cache's report. Returns null if no answers were used.

Returns
  • String containing all prompt answers in format provided by IServer

public abstract Map<String, WebMDSecurityFilter> getSecurityFilters ()

Returns a map of security filters associated with this cache. Each filter is mapped by its ID. Objects may not be populated. Check before use

Returns

public abstract int getStatus ()

Returns the cache status, a value from EnumDSSXMLReportCacheStatus

Returns
  • the cache status

public abstract int getType ()

Returns the cache type, a value from EnumDSSXMLReportCacheType

Returns
  • the cache type

public abstract WebUser getUser ()

Returns the user associated with this cache. May return null if no user is associated with this cache. Object may not be populated. Check before use

Returns
  • WebUser associated with this cache or null

public abstract boolean hasDetails ()

Returns whether or not the cache details are available.

Returns
  • True if the cache details are available.

public abstract int size ()

Returns the cache size in KB

Returns
  • the cache size in KB