Mobile API Reference  MicroStrategy 2019
RWDataServiceResult Class Reference

#import <RWDataServiceResult.h>

Inheritance diagram for RWDataServiceResult:

Instance Methods

(RWDataServiceResult *) - initWithLayout:groupBy:data:currentGroupBy:
 
(RWDataServiceResult *) - initWithLayout2:groupBy:data:currentGroupBy:
 
(RWDataServiceResult *) - initWithLayout:pageByInfo:data:currentGroupBy:
 
(RWDataServiceResult *) - initWithLayout2:groupBy:data:dataPath:images:
 
(RWDataServiceResult *) - initWithDrilledReport:binaryPath:
 
(RWDataServiceResult *) - initWithBinaryPath:binaryArray:binaryData:images:
 
(void) - setReportName:
 
(void) - setHasPageBy:
 
(void) - setNeedApplyToDI:
 
(void) - setNeedReDoManipulation:
 
(void) - setNeedRenderDoc:
 
(void) - setNeedEvaluateViews:
 
(void) - releaseContentData
 
(BOOL- isCSIResult
 

Properties

NSData * layoutXML
 
NSData * groupByXML
 
NSData * contentData
 
NSString * contentDataPath
 
NSData * reportInfoXML
 
NSDictionary * images
 
PageByInfo * pageByInfo
 
BOOL needApplyToDI
 
BOOL needReDoManipulation
 
BOOL needRenderDoc
 
NSString * requestedLayoutKey
 
MSIReportDisplayInfodrilledReportInfo
 
NSArray * separatedBinaries
 
BOOL needEvaluateViews
 
id groupByData
 
NSString * reportName
 stores document name More...
 
BOOL hasPageBy
 indicates whether this RWD has group-by or not More...
 
BOOL renderDirectly
 

Method Documentation

◆ initWithBinaryPath:binaryArray:binaryData:images:()

- (RWDataServiceResult *) initWithBinaryPath: (NSString *)  iBinDataPath
binaryArray: (NSArray *)  iBinaryArray
binaryData: (NSData *)  iBinData
images: (id)  iImages 

Initialization Method

Parameters
iBinDataPathbinary data path
iBinaryArrayAn array of binaries
iBinDatabinary data
iImagespreview images
Returns
New instance created

◆ initWithDrilledReport:binaryPath:()

- (RWDataServiceResult *) initWithDrilledReport: (MSIReportDisplayInfo *)  iReportInfo
binaryPath: (NSString *)  iBinDataPath 

Initialization Method for linked drill results

Parameters
iReportInfodrill target report/document
iBinDataPathbinary data path
Returns
New instance created

◆ initWithLayout2:groupBy:data:currentGroupBy:()

- (RWDataServiceResult *) initWithLayout2: (NSData *)  layoutXML
groupBy: (NSData *)  groupByXML
data: (NSData *)  pdfData
currentGroupBy: (id)  currentGroupBy 

Initialization Method

Parameters
layoutXMLlayout XML
groupByXMLgrouby XML
pdfDataPDF data
currentGroupBycurrent groupby data
Returns
New instance created

◆ initWithLayout2:groupBy:data:dataPath:images:()

- (RWDataServiceResult *) initWithLayout2: (NSData *)  layoutXML
groupBy: (NSData *)  groupByXML
data: (NSData *)  binData
dataPath: (NSString *)  binDataPath
images: (id)  pImages 

Initialization Method

Parameters
layoutXMLlayout XML
groupByXMLgrouby XML
binDatabinary data
binDataPathbinary data path
pImagespreview images
Returns
New instance created

◆ initWithLayout:groupBy:data:currentGroupBy:()

- (RWDataServiceResult *) initWithLayout: (NSData *)  layoutXML
groupBy: (NSData *)  groupByXML
data: (NSData *)  pdfData
currentGroupBy: (NSData *)  currentGroupBy 

Initialization Method

Parameters
layoutXMLlayout XML
groupByXMLgrouby XML
pdfDataPDF data
currentGroupBycurrent groupby data
Returns
New instance created

◆ initWithLayout:pageByInfo:data:currentGroupBy:()

- (RWDataServiceResult *) initWithLayout: (NSData *)  layoutXML
pageByInfo: (PageByInfo *)  pageByInfo
data: (NSData *)  pdfData
currentGroupBy: (NSData *)  currentGroupBy 

Initialization Method

Parameters
layoutXMLlayout XML
pageByInfopageby info
pdfDataPDF data
currentGroupBycurrent groupby data
Returns
New instance created

◆ isCSIResult()

- (BOOL) isCSIResult

is CSI binary result

◆ releaseContentData()

- (void) releaseContentData

Release content data

◆ setHasPageBy:()

- (void) setHasPageBy: (BOOL hasPageBy

Set true if it has PageBy.

Parameters
hasPageByif has pageby

◆ setNeedApplyToDI:()

- (void) setNeedApplyToDI: (BOOL value

Set NeedApplyToDI

Parameters
valueUse true if we need to apply data to document instance.

◆ setNeedEvaluateViews:()

- (void) setNeedEvaluateViews: (BOOL value

Set NeedEvaluateViews

Parameters
valueIf we need evaluate views after applying datasets and before rendering.

◆ setNeedReDoManipulation:()

- (void) setNeedReDoManipulation: (BOOL value

Set NeedReDoManipulation

Parameters
valueIf we need to redo manipulation after data is passed in.

◆ setNeedRenderDoc:()

- (void) setNeedRenderDoc: (BOOL value

Set NeedRenderDoc

Parameters
valueIf we need render the document after data is passed in.

◆ setReportName:()

- (void) setReportName: (NSString *)  reportName

Set report name

Parameters
reportNamereport name

Property Documentation

◆ contentData

- (NSData *) contentData
readnonatomicassign

◆ contentDataPath

- (NSString *) contentDataPath
readnonatomicassign

◆ drilledReportInfo

- (MSIReportDisplayInfo *) drilledReportInfo
readwritenonatomicstrong

◆ groupByData

- (id) groupByData
readnonatomicweak

This property may return either PageByInfo or NSData containing page by XML

◆ groupByXML

- (NSData *) groupByXML
readnonatomicassign

◆ hasPageBy

- (BOOL) hasPageBy
readnonatomicassign

indicates whether this RWD has group-by or not

Not populated from the data; this is due to the fact that groupByXML is not always fetched for better performance.

◆ images

- (NSDictionary *) images
readnonatomicassign

◆ layoutXML

- (NSData *) layoutXML
readnonatomicassign

◆ needApplyToDI

- (BOOL) needApplyToDI
readnonatomicassign

◆ needEvaluateViews

- (BOOL) needEvaluateViews
readnonatomicassign

◆ needReDoManipulation

- (BOOL) needReDoManipulation
readnonatomicassign

◆ needRenderDoc

- (BOOL) needRenderDoc
readnonatomicassign

◆ pageByInfo

- (PageByInfo *) pageByInfo
readnonatomicassign

◆ renderDirectly

- (BOOL) renderDirectly
readwritenonatomicassign

◆ reportInfoXML

- (NSData *) reportInfoXML
readnonatomicassign

◆ reportName

- (NSString *) reportName
readnonatomicweak

stores document name

Doesn't get populated from data, but rather by RWDataController. This is because XML parsing is not the responsibility of RWDataServiceResult.

◆ requestedLayoutKey

- (NSString *) requestedLayoutKey
readwritenonatomicstrong

◆ separatedBinaries

- (NSArray *) separatedBinaries
readnonatomicassign