Interface Cache
-
- All Known Subinterfaces:
CacheDetails
,CubeCache
,RWDCache
public interface Cache
The interfaceCache
represents a real cache slot in the memory of the Intelligence Server.- Since:
- MicroStrategy Web 9.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getCacheSourceID()
Returns the ID of the source to which this cache belong, where source could be report or document.java.lang.String
getCacheSourceName()
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.Date
getCreationTime()
Returns the cache creation time.java.lang.String
getCreator()
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.Date
getExpirationTime()
Returns the cache expiration timeint
getHistoricHitCount()
Returns the historic hit count of the cache.int
getHitCount()
Returns the hit count of the cache.java.lang.String
getID()
Returns the DSSID of the cachejava.util.Date
getLastHitTime()
Returns the last hit time of the cache.java.util.Date
getLastUpdateTime()
Returns the last update time of the cache.java.util.Locale
getLocale()
Returns the locale used to run the report for this cache.java.util.Set<WebObjectCouple<WebDBRole,WebDBLogin>>
getLoginCouples()
java.lang.String
getProjectDSSID()
Returns the project DSS IDjava.lang.String
getProjectName()
Returns the project namejava.lang.String
getPromptAnswers()
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.int
getStatus()
Returns the cache status, a value fromEnumDSSXMLReportCacheStatus
int
getType()
Returns the cache type, a value fromEnumDSSXMLReportCacheType
WebUser
getUser()
Returns the user associated with this cache.boolean
hasDetails()
Returns whether or not the cache details are available.int
size()
Returns the cache size in KB
-
-
-
Method Detail
-
getCacheSourceName
java.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.
-
getCacheSourceID
java.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.
-
getProjectName
java.lang.String getProjectName()
Returns the project name- Returns:
- the project name
-
getProjectDSSID
java.lang.String getProjectDSSID()
Returns the project DSS ID- Returns:
- the project DSS ID
-
getCreator
java.lang.String getCreator()
Returns the creator user name- Returns:
-
getStatus
int getStatus()
Returns the cache status, a value fromEnumDSSXMLReportCacheStatus
- Returns:
- the cache status
-
getLastUpdateTime
java.util.Date getLastUpdateTime()
Returns the last update time of the cache.- Returns:
- the last update time of the cache.
-
size
int size()
Returns the cache size in KB- Returns:
- the cache size in KB
-
getLastHitTime
java.util.Date getLastHitTime()
Returns the last hit time of the cache.- Returns:
- the last hit time of the cache
-
getHitCount
int getHitCount()
Returns the hit count of the cache.- Returns:
- the hit count of the cache
-
getHistoricHitCount
int getHistoricHitCount()
Returns the historic hit count of the cache.- Returns:
- the historic hit count of the cache
-
getExpirationTime
java.util.Date getExpirationTime()
Returns the cache expiration time- Returns:
- the cache expiration time
-
getType
int getType()
Returns the cache type, a value fromEnumDSSXMLReportCacheType
- Returns:
- the cache type
-
getCreationTime
java.util.Date getCreationTime()
Returns the cache creation time.- Returns:
- the cache creation time.
-
getID
java.lang.String getID()
Returns the DSSID of the cache- Returns:
- the DSSID of the cache
-
hasDetails
boolean hasDetails()
Returns whether or not the cache details are available.- Returns:
True
if the cache details are available.
-
getSecurityFilters
java.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
String
objects toWebMDSecurityFilter
objects
-
getUser
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
-
getDBLogins
java.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
String
objects (IDs) toWebDBLogin
objects.
-
getDBConnections
java.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
String
objects (IDs) toWebDBConnection
objects.
-
getDBRoles
java.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
String
objects (IDs) toWebDBRole
objects.
-
getLocale
java.util.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
-
getPromptAnswers
java.lang.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
-
getConnectionCouples
java.util.Set<WebObjectCouple<WebDBRole,WebDBConnection>> getConnectionCouples()
- Returns:
- set of
WebObjectCouple
objects
-
getLoginCouples
java.util.Set<WebObjectCouple<WebDBRole,WebDBLogin>> getLoginCouples()
- Returns:
- set of
WebObjectCouple
objects
-
-