Interface Cache
- 
- All Known Subinterfaces:
- CacheDetails,- CubeCache,- RWDCache
 
 public interface CacheThe interfaceCacherepresents a real cache slot in the memory of the Intelligence Server.- Since:
- MicroStrategy Web 9.0.0
 
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetCacheSourceID()Returns the ID of the source to which this cache belong, where source could be report or document.java.lang.StringgetCacheSourceName()Returns the name of the source to which this cache belong, where source could be report or document.java.util.Set<WebObjectCouple<WebDBRole,WebDBConnection>>getConnectionCouples()java.util.DategetCreationTime()Returns the cache creation time.java.lang.StringgetCreator()Returns the creator user namejava.util.Map<java.lang.String,WebDBConnection>getDBConnections()Returns a map of dbConnection objects associated with this cache.java.util.Map<java.lang.String,WebDBLogin>getDBLogins()Returns a map of dbLogin objects associated with this cache.java.util.Map<java.lang.String,WebDBRole>getDBRoles()Returns a map of dbRole objects associated with this cache.java.util.DategetExpirationTime()Returns the cache expiration timeintgetHistoricHitCount()Returns the historic hit count of the cache.intgetHitCount()Returns the hit count of the cache.java.lang.StringgetID()Returns the DSSID of the cachejava.util.DategetLastHitTime()Returns the last hit time of the cache.java.util.DategetLastUpdateTime()Returns the last update time of the cache.java.util.LocalegetLocale()Returns the locale used to run the report for this cache.java.util.Set<WebObjectCouple<WebDBRole,WebDBLogin>>getLoginCouples()java.lang.StringgetProjectDSSID()Returns the project DSS IDjava.lang.StringgetProjectName()Returns the project namejava.lang.StringgetPromptAnswers()Returns the prompt answers used to generate this cache's report.java.util.Map<java.lang.String,WebMDSecurityFilter>getSecurityFilters()Returns a map of security filters associated with this cache.intgetStatus()Returns the cache status, a value fromEnumDSSXMLReportCacheStatusintgetType()Returns the cache type, a value fromEnumDSSXMLReportCacheTypeWebUsergetUser()Returns the user associated with this cache.booleanhasDetails()Returns whether or not the cache details are available.intsize()Returns the cache size in KB
 
- 
- 
- 
Method Detail- 
getCacheSourceNamejava.lang.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.
 
 - 
getCacheSourceIDjava.lang.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.
 
 - 
getProjectNamejava.lang.String getProjectName() Returns the project name- Returns:
- the project name
 
 - 
getProjectDSSIDjava.lang.String getProjectDSSID() Returns the project DSS ID- Returns:
- the project DSS ID
 
 - 
getCreatorjava.lang.String getCreator() Returns the creator user name- Returns:
 
 - 
getStatusint getStatus() Returns the cache status, a value fromEnumDSSXMLReportCacheStatus- Returns:
- the cache status
 
 - 
getLastUpdateTimejava.util.Date getLastUpdateTime() Returns the last update time of the cache.- Returns:
- the last update time of the cache.
 
 - 
sizeint size() Returns the cache size in KB- Returns:
- the cache size in KB
 
 - 
getLastHitTimejava.util.Date getLastHitTime() Returns the last hit time of the cache.- Returns:
- the last hit time of the cache
 
 - 
getHitCountint getHitCount() Returns the hit count of the cache.- Returns:
- the hit count of the cache
 
 - 
getHistoricHitCountint getHistoricHitCount() Returns the historic hit count of the cache.- Returns:
- the historic hit count of the cache
 
 - 
getExpirationTimejava.util.Date getExpirationTime() Returns the cache expiration time- Returns:
- the cache expiration time
 
 - 
getTypeint getType() Returns the cache type, a value fromEnumDSSXMLReportCacheType- Returns:
- the cache type
 
 - 
getCreationTimejava.util.Date getCreationTime() Returns the cache creation time.- Returns:
- the cache creation time.
 
 - 
getIDjava.lang.String getID() Returns the DSSID of the cache- Returns:
- the DSSID of the cache
 
 - 
hasDetailsboolean hasDetails() Returns whether or not the cache details are available.- Returns:
- Trueif the cache details are available.
 
 - 
getSecurityFiltersjava.util.Map<java.lang.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:
- Map of Stringobjects toWebMDSecurityFilterobjects
 
 - 
getUserWebUser 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:
- WebUserassociated with this cache or null
 
 - 
getDBLoginsjava.util.Map<java.lang.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 Stringobjects (IDs) toWebDBLoginobjects.
 
 - 
getDBConnectionsjava.util.Map<java.lang.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:
- Map of Stringobjects (IDs) toWebDBConnectionobjects.
 
 - 
getDBRolesjava.util.Map<java.lang.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 Stringobjects (IDs) toWebDBRoleobjects.
 
 - 
getLocalejava.util.Locale getLocale() Returns the locale used to run the report for this cache. If no locale is specified, returns null- Returns:
- Localeobject for this cache
 
 - 
getPromptAnswersjava.lang.String getPromptAnswers() Returns the prompt answers used to generate this cache's report. Returns null if no answers were used.- Returns:
- Stringcontaining all prompt answers in format provided by IServer
 
 - 
getConnectionCouplesjava.util.Set<WebObjectCouple<WebDBRole,WebDBConnection>> getConnectionCouples() - Returns:
- set of WebObjectCoupleobjects
 
 - 
getLoginCouplesjava.util.Set<WebObjectCouple<WebDBRole,WebDBLogin>> getLoginCouples() - Returns:
- set of WebObjectCoupleobjects
 
 
- 
 
-