RefreshDocumentService Class Reference

#import <RefreshDocumentService.h>

Inheritance diagram for RefreshDocumentService:

Protected Attributes
MSIReportDisplayInfo *	document
Protected Attributes inherited from XMLAPIService
MSIProjectInfo *	project
NSInteger	resultFlags
BOOL	ignoreAccessProjectError
Protected Attributes inherited from MSIServiceImpl
NSInteger	state
id< MSINetworkRequest >	request
id< ServiceHandler > __weak	handler
TaskGroup *	taskGroup
TaskInfo *	taskInfo
id< Service > __weak	innerService
BOOL	suppressNetworkErrorAlerts
NSString *	incrementalFileLocation
double	priority
ClientRequestExecutionHandlerFlags	requestExeFlag
BOOL	makeIncrementalAvailable

Properties
RefreshDocumentOption	refreshDocumentOption
Properties inherited from XMLAPIService
BOOL	shouldReceiveBinaryData
Properties inherited from MSIServiceImpl
id< ServiceHandler >	handler
BOOL	suppressLoginPrompt
id< Service >	innerService

Additional Inherited Members
Instance Methods inherited from XMLAPIService
(NSString *)	- generateXMLCommand
(void)	- doXMLStartElement:namespaceURI:attributes:level:support:
(void)	- doXMLEndElement:namespaceURI:level:support:
(void)	- propagateSuccess
(void)	- sendXMLAPITaskRequest
Instance Methods inherited from MSIServiceImpl
(void)	- run
(NSString *)	- getBaseURL:task:
(void)	- handleData:request:
(void)	- handleError:request:
(void)	- handleDataProgress:Total:request:
(void)	- setTaskGroup:
(NSString *)	- sessionState:
(MSIProjectConfiguration *)	- projectConfigForReport:
(void)	- reportException:report:
(void)	- reportError:report:
(NSString *)	- getSessionState:
(MSIProjectConfiguration *)	- getProjectConfig:
(MSIDevicePreferences *)	- getDevicePrefs
(void)	- reportException:project:
(void)	- handleServiceFailedError:withProject:
(void)	- resetInnerService
(void)	- threadRun
(void)	- handleClientVersionError:
(void)	- handleObjectNotFoundError:
(void)	- handleSessionExpiredError:
Instance Methods inherited from <MSTRHandler>
(void)	- doStartElement:namespaceURI:attributes:level:support:
(void)	- doEndElement:namespaceURI:level:support:

Detailed Description

This service refreshes document (with its' message ID in working set) against data warehouse or iServer cache. This service maintains mainpulations performed on the document, which is different from document execution. This service is an asychronizd service, please use IPadPollStatusService to query its' execution status. To save&replay client manipulations, please save client manipulations with RWManipulationAndBinaryDataService

Member Data Documentation

document

- (MSIReportDisplayInfo *) document

readwritenonatomicstrongprotected

document to be refreshed. This is required property and cannot be nil. Document's currentMessageID is also required and cannot be nil.

Property Documentation

refreshDocumentOption

- (RefreshDocumentOption) refreshDocumentOption

readwritenonatomicassign

refresh option. default value is RefreshDocumentOptionAgainstCache if this value is not provided