Mobile API Reference  MicroStrategy 2019
Instance Methods | Class Methods | List of all members
ReportStore Class Reference

#import <ReportStore.h>

Inheritance diagram for ReportStore:

Instance Methods

(NSDictionary *) - getCacheSetKeys:
 
(NSDictionary *) - getCacheSetKeysForLinkDrill:promptAnswer:
 
(NSInteger) - addReport:error:
 
(NSInteger) - updateReport:deleteData:error:
 
(NSInteger) - deleteReport:error:
 
(NSArray *) - reportListCopy
 
(NSArray *) - allReportsCopy
 
(NSArray *) - reportListCopyForProject:
 
(NSArray *) - liveReportListCopyForProject:
 
(NSArray *) - DatasetListCopyForProject:
 
(MSIReportDisplayInfo *) - reportCopyBySubscriptionID:
 
(MSIReportDisplayInfo *) - reportCopyByTargetID:type:
 
(MSIReportDisplayInfo *) - reportCopyBySubscriptionID:projectID:
 
(MSIReportDisplayInfo *) - reportCopyByTargetID:type:projectID:
 
(MSIReportDisplayInfo *) - reportCopyByTargetID:type:projectID:promptAnswer:
 
(NSArray *) - reportsCopyByTargetID:type:projectID:
 
(MSIReportDisplayInfo *) - deferExecReportCopyBySubscriptionID:projectID:
 
(NSInteger) - addReportCache:cacheID:data:error:
 
(NSInteger) - addReportCache:cacheID:moveFileAtLocation:error:
 
(NSInteger) - addReportCache:cacheID:data:moveFileAtLocation:withServerCache:error:
 
(NSInteger) - addReportCache:cacheID:data:moveFileAtLocation:withServerCache:isBackground:error:
 
(NSData *) - getReportCache:cacheID:
 
(NSInteger) - moveReportCache:oldCacheID:newCacheID:error:
 
(NSInteger) - deleteReportCache:cacheID:error:
 
(BOOL) - reportCacheExists:cacheID:
 
(BOOL) - datasetCacheExists:
 
(void) - deleteDrillCaches
 
(NSString *) - getPath
 
(void) - initializeCacheSetMap
 
(void) - moveCacheSet:forReport:
 
(void) - copyCacheSet:forReport:
 
(MSILiveReportInfo *) - newLiveReport:projectInfo:
 
(MSILiveReportInfo *) - newLiveReport:type:projectInfo:
 
(MSILiveReportInfo *) - liveReportCopyByTargetID:type:project:
 
(DerivedReportInfo *) - newDerivedReport:
 
(void) - setFullyCached:bytesLoaded:toReport:
 
(void) - setFullyCached:bytesLoaded:updateTime:toReport:
 
(BOOL) - isFullyCached:projectID:
 
(void) - setPreloadingStateForReport:layoutID:sliceCount:
 
(NSMutableArray *) - newUncachedReportsList
 
(BOOL) - hasReportCache:cacheID:
 
(void) - setInitialPageForReport:identifier:values:
 
(BOOL) - isSubscriptionReport:
 
(NSInteger) - deleteProjectCaches:error:
 
(NSInteger) - cacheSetSizeForReport:
 
(NSInteger) - invalidateReportCacheSet:cacheRootID:project:error:
 
(NSInteger) - invalidateReportCache:cacheSet:cacheRootID:project:error:
 
(NSInteger) - deleteReportCacheSet:cacheRootID:project:status:error:
 
(NSInteger) - deleteReportCacheSet:cacheRootID:project:status:isBackground:error:
 
(NSData *) - getReportCache:cacheID:status:
 
(NSInteger) - updateReport:dataAction:error:
 
(NSString *) - getReportCachePath:cacheID:status:
 
(NSString *) - getReportCachePath:cacheID:status:updated:
 
(NSInteger) - invalidateReportCache:error:
 
(void) - setDocument:locked:
 
(NSArray *) - getLockedDocuments
 
(void) - handlePromptQuestionUpdate:data:
 
(NSString *) - getMappedCacheSetID:
 

Class Methods

(ReportStore *) + getReportStore
 
(void) + resetReportStore
 
(NSString *) + reportsRootPath
 
(void) + performUpgradeCleanup
 
(void) + dropAllReportCaches:clearSubscribedReportInfo:
 
(BOOL) + clearOnClose
 
(BOOL) + isPredefinedCacheID:
 

Detailed Description

ReportStore holds reports that have been received from the server and can then be accessed locally.

Method Documentation

◆ addReport:error:()

- (NSInteger) addReport: (MSIReportDisplayInfo *)  aReport
error: (NSError **)  error 

◆ addReportCache:cacheID:data:error:()

- (NSInteger) addReportCache: (MSIReportDisplayInfo *)  aReport
cacheID: (NSString *)  cacheID
data: (NSData *)  data
error: (NSError **)  error 

◆ addReportCache:cacheID:data:moveFileAtLocation:withServerCache:error:()

- (NSInteger) addReportCache: (MSIReportDisplayInfo *)  aReport
cacheID: (NSString *)  cacheID
data: (NSData *)  data
moveFileAtLocation: (NSString *)  fileName
withServerCache: (IServerCacheInfo *)  isci
error: (NSError **)  error 

◆ addReportCache:cacheID:data:moveFileAtLocation:withServerCache:isBackground:error:()

- (NSInteger) addReportCache: (MSIReportDisplayInfo *)  aReport
cacheID: (NSString *)  cacheID
data: (NSData *)  data
moveFileAtLocation: (NSString *)  fileName
withServerCache: (IServerCacheInfo *)  isci
isBackground: (BOOL)  background
error: (NSError **)  error 

◆ addReportCache:cacheID:moveFileAtLocation:error:()

- (NSInteger) addReportCache: (MSIReportDisplayInfo *)  aReport
cacheID: (NSString *)  cacheID
moveFileAtLocation: (NSString *)  fileName
error: (NSError **)  error 

◆ allReportsCopy()

- (NSArray*) allReportsCopy

◆ cacheSetSizeForReport:()

- (NSInteger) cacheSetSizeForReport: (MSIReportDisplayInfo *)  report

◆ clearOnClose()

+ (BOOL) clearOnClose

◆ copyCacheSet:forReport:()

- (void) copyCacheSet: (NSString *)  setID
forReport: (MSIReportDisplayInfo *)  aReport 

◆ datasetCacheExists:()

- (BOOL) datasetCacheExists: (DataSetInfo *)  aDatasetInfo

◆ DatasetListCopyForProject:()

- (NSArray*) DatasetListCopyForProject: (MSIProjectInfo *)  project

◆ deferExecReportCopyBySubscriptionID:projectID:()

- (MSIReportDisplayInfo*) deferExecReportCopyBySubscriptionID: (NSString *)  subscriptionID
projectID: (NSString *)  projectID 

◆ deleteDrillCaches()

- (void) deleteDrillCaches

◆ deleteProjectCaches:error:()

- (NSInteger) deleteProjectCaches: (MSIProjectInfo *)  project
error: (NSError **)  error 

◆ deleteReport:error:()

- (NSInteger) deleteReport: (MSIReportDisplayInfo *)  aReport
error: (NSError **)  error 

◆ deleteReportCache:cacheID:error:()

- (NSInteger) deleteReportCache: (MSIReportDisplayInfo *)  aReport
cacheID: (NSString *)  cacheID
error: (NSError **)  error 

◆ deleteReportCacheSet:cacheRootID:project:status:error:()

- (NSInteger) deleteReportCacheSet: (NSString *)  cacheSetID
cacheRootID: (NSString *)  cacheRootID
project: (MSIProjectInfo *)  project
status: (int)  status
error: (NSError **)  error 

◆ deleteReportCacheSet:cacheRootID:project:status:isBackground:error:()

- (NSInteger) deleteReportCacheSet: (NSString *)  cacheSetID
cacheRootID: (NSString *)  cacheRootID
project: (MSIProjectInfo *)  project
status: (int)  status
isBackground: (BOOL)  background
error: (NSError **)  error 

◆ dropAllReportCaches:clearSubscribedReportInfo:()

+ (void) dropAllReportCaches: (BOOL)  clearLiveReportInfo
clearSubscribedReportInfo: (BOOL)  clearSubscribedReportInfo 

When debugging reports, It can be useful to have them start fresh, with no cached info, prompt answers, etc. Use this method to clear out all the cahced info.

◆ getCacheSetKeys:()

- (NSDictionary *) getCacheSetKeys: (MSIReportDisplayInfo *)  aReport

◆ getCacheSetKeysForLinkDrill:promptAnswer:()

- (NSDictionary *) getCacheSetKeysForLinkDrill: (MSIReportDisplayInfo *)  aReport
promptAnswer: (NSString *)  promptAnswer 

◆ getLockedDocuments()

- (NSArray*) getLockedDocuments

◆ getMappedCacheSetID:()

- (NSString *) getMappedCacheSetID: (MSIReportDisplayInfo *)  aReport

◆ getPath()

- (NSString*) getPath

◆ getReportCache:cacheID:()

- (NSData*) getReportCache: (MSIReportDisplayInfo *)  aReport
cacheID: (NSString *)  cacheID 

◆ getReportCache:cacheID:status:()

- (NSData*) getReportCache: (MSIReportDisplayInfo *)  aReport
cacheID: (NSString *)  cacheID
status: (NSInteger *)  oStatus 

◆ getReportCachePath:cacheID:status:()

- (NSString*) getReportCachePath: (MSIReportDisplayInfo *)  aReport
cacheID: (NSString *)  cacheID
status: (NSInteger *)  oStatus 

◆ getReportCachePath:cacheID:status:updated:()

- (NSString*) getReportCachePath: (MSIReportDisplayInfo *)  document
cacheID: (NSString *)  cacheID
status: (NSInteger *)  oStatus
updated: (BOOL)  isUpdated 

◆ getReportStore()

+ (ReportStore*) getReportStore

◆ handlePromptQuestionUpdate:data:()

- (void) handlePromptQuestionUpdate: (MSIReportDisplayInfo *)  aReport
data: (NSData *)  data 

◆ hasReportCache:cacheID:()

- (BOOL) hasReportCache: (MSIReportDisplayInfo *)  aReport
cacheID: (NSString *)  cacheID 

◆ initializeCacheSetMap()

- (void) initializeCacheSetMap

◆ invalidateReportCache:cacheSet:cacheRootID:project:error:()

- (NSInteger) invalidateReportCache: (NSString *)  serverCacheID
cacheSet: (NSString *)  cacheSetID
cacheRootID: (NSString *)  cacheRootID
project: (MSIProjectInfo *)  project
error: (NSError **)  error 

◆ invalidateReportCache:error:()

- (NSInteger) invalidateReportCache: (MSIReportDisplayInfo *)  aReport
error: (NSError **)  error 

◆ invalidateReportCacheSet:cacheRootID:project:error:()

- (NSInteger) invalidateReportCacheSet: (NSString *)  cacheSetID
cacheRootID: (NSString *)  cacheRootID
project: (MSIProjectInfo *)  project
error: (NSError **)  error 

◆ isFullyCached:projectID:()

- (BOOL) isFullyCached: (NSString *)  subscriptionID
projectID: (NSString *)  projectID 

◆ isPredefinedCacheID:()

+ (BOOL) isPredefinedCacheID: (NSString *)  cacheID

◆ isSubscriptionReport:()

- (BOOL) isSubscriptionReport: (MSIReportDisplayInfo *)  report

◆ liveReportCopyByTargetID:type:project:()

- (MSILiveReportInfo*) liveReportCopyByTargetID: (NSString *)  targetID
type: (NSInteger)  targetType
project: (MSIProjectInfo *)  projectInfo 

◆ liveReportListCopyForProject:()

- (NSArray*) liveReportListCopyForProject: (MSIProjectInfo *)  project

◆ moveCacheSet:forReport:()

- (void) moveCacheSet: (NSString *)  setID
forReport: (MSIReportDisplayInfo *)  aReport 

◆ moveReportCache:oldCacheID:newCacheID:error:()

- (NSInteger) moveReportCache: (MSIReportDisplayInfo *)  aReport
oldCacheID: (NSString *)  oldCacheID
newCacheID: (NSString *)  newCacheID
error: (NSError **)  error 

◆ newDerivedReport:()

- (DerivedReportInfo*) newDerivedReport: (MSIReportDisplayInfo *)  baseReport

◆ newLiveReport:projectInfo:()

- (MSILiveReportInfo*) newLiveReport: (MSIObjectInfo *)  object
projectInfo: (MSIProjectInfo *)  projectInfo 

◆ newLiveReport:type:projectInfo:()

- (MSILiveReportInfo*) newLiveReport: (NSString *)  objID
type: (NSInteger)  type
projectInfo: (MSIProjectInfo *)  projectInfo 

◆ newUncachedReportsList()

- (NSMutableArray*) newUncachedReportsList

◆ performUpgradeCleanup()

+ (void) performUpgradeCleanup

◆ reportCacheExists:cacheID:()

- (BOOL) reportCacheExists: (MSIReportDisplayInfo *)  aReport
cacheID: (NSString *)  cacheID 

◆ reportCopyBySubscriptionID:()

- (MSIReportDisplayInfo*) reportCopyBySubscriptionID: (NSString *)  subscriptionID

◆ reportCopyBySubscriptionID:projectID:()

- (MSIReportDisplayInfo*) reportCopyBySubscriptionID: (NSString *)  subscriptionID
projectID: (NSString *)  projectID 

◆ reportCopyByTargetID:type:()

- (MSIReportDisplayInfo*) reportCopyByTargetID: (NSString *)  targetID
type: (NSInteger)  targetType 

◆ reportCopyByTargetID:type:projectID:()

- (MSIReportDisplayInfo*) reportCopyByTargetID: (NSString *)  targetID
type: (NSInteger)  targetType
projectID: (NSString *)  projectID 

◆ reportCopyByTargetID:type:projectID:promptAnswer:()

- (MSIReportDisplayInfo*) reportCopyByTargetID: (NSString *)  targetID
type: (NSInteger)  targetType
projectID: (NSString *)  projectID
promptAnswer: (NSString *)  promptAnswer 

◆ reportListCopy()

- (NSArray*) reportListCopy

◆ reportListCopyForProject:()

- (NSArray*) reportListCopyForProject: (MSIProjectInfo *)  project

◆ reportsCopyByTargetID:type:projectID:()

- (NSArray*) reportsCopyByTargetID: (NSString *)  targetID
type: (NSInteger)  targetType
projectID: (NSString *)  projectID 

◆ reportsRootPath()

+ (NSString*) reportsRootPath

◆ resetReportStore()

+ (void) resetReportStore

◆ setDocument:locked:()

- (void) setDocument: (MSIReportDisplayInfo *)  document
locked: (BOOL)  locked 

◆ setFullyCached:bytesLoaded:toReport:()

- (void) setFullyCached: (BOOL)  value
bytesLoaded: (NSInteger)  bytesLoaded
toReport: (MSIReportDisplayInfo *)  report 

◆ setFullyCached:bytesLoaded:updateTime:toReport:()

- (void) setFullyCached: (BOOL)  value
bytesLoaded: (NSInteger)  bytesLoaded
updateTime: (BOOL)  updateTime
toReport: (MSIReportDisplayInfo *)  report 

◆ setInitialPageForReport:identifier:values:()

- (void) setInitialPageForReport: (MSIReportDisplayInfo *)  report
identifier: (NSString *)  identifier
values: (NSArray *)  values 

◆ setPreloadingStateForReport:layoutID:sliceCount:()

- (void) setPreloadingStateForReport: (MSIReportDisplayInfo *)  report
layoutID: (NSInteger)  layoutID
sliceCount: (NSInteger)  sliceCount 

◆ updateReport:dataAction:error:()

- (NSInteger) updateReport: (MSIReportDisplayInfo *)  aReport
dataAction: (NSInteger)  action
error: (NSError **)  error 

◆ updateReport:deleteData:error:()

- (NSInteger) updateReport: (MSIReportDisplayInfo *)  aReport
deleteData: (bool)  deleteData
error: (NSError **)  error