<IPadDataController> Protocol Reference

#import <IPadDataController.h>

Instance Methods
(void)	- displayError:
(void)	- setDataViewerVisibility:
(void)	- dataViewLoaded
(void)	- setReport:
(MSIReportDisplayInfo *)	- report
(NSString *)	- baseURL
(void)	- displayPromptWithAttribute:searchRequired:multiSelect:
(void)	- handleEventWithParameters:
(void)	- handleEventWithParameters:withLocationContext:
(LayoutManagerController *)	- layoutManagerController
(int)	- getWebServerType
(void)	- addLayoutIndicator:
(short)	- getCurrentLayoutIndex
(BOOL)	- restoreContents
(void)	- restoreTransactionContents:andTime:
(void)	- getEmptyGridDisplay:display:
(void)	- resubmitDataService:
(void)	- resubmitDataService:suppressNetworkErrorAlerts:ignoreDeviceCache:
(void)	- setHomeButton:
(void)	- disableViewerCache
(void)	- handleRenderFinishTime:
(void)	- handleManipulationCount
(void)	- handleManipRenderStartTime:
(void)	- setReportQueueRecall:
(void)	- executeManipulationSelections:
(void)	- displayConferences:
(CarryOverSelectionsSet *)	- getCurrentCarryOverSelections:
(void)	- rerunDocument:

Method Documentation

addLayoutIndicator:()

- (void) addLayoutIndicator: (UIView *)  layoutIndicator

optional

Add layout indicator

Parameters

layoutIndicator

Layout indicator view

baseURL()

- (NSString*) baseURL

Return base URL

Returns

Base URL

dataViewLoaded()

- (void) dataViewLoaded

This should be triggered when the data view is loaded or is set to be visible.

disableViewerCache()

- (void) disableViewerCache

optional

Disable viewers cache. This will sacrifice performance for memory

displayConferences:()

- (void) displayConferences: (NSArray *)  servers

optional

Display a list of conference servers for user to join

Parameters

servers

A list of server names

displayError:()

- (void) displayError:

(NSString *)

errorMessage

Display error

Parameters

errorMessage

Error message to be displayed

displayPromptWithAttribute:searchRequired:multiSelect:()

- (void) displayPromptWithAttribute:		(MSIObjectInfo *)	attribute
searchRequired:		(NSInteger)	searchRequired
multiSelect:		(NSInteger)	multiSelect

Show reprompt interface

Parameters

attribute	Prompt info
searchRequired	If require search
multiSelect	Allow multiselect

executeManipulationSelections:()

- (void) executeManipulationSelections: (NSData *)  iSelections

optional

Apply a manipulation selection to the document

Parameters

iSelections

An archived carryover selection set

getCurrentCarryOverSelections:()

- (CarryOverSelectionsSet*) getCurrentCarryOverSelections: (CarryOverSelectedMode)  mode

optional

Return the current selections from the document

Parameters

mode	Whether to carry over by name or ID

Returns

The set of selections in the current document

getCurrentLayoutIndex()

- (short) getCurrentLayoutIndex

optional

Get current layout index

Returns

Current layout index

getEmptyGridDisplay:display:()

- (void) getEmptyGridDisplay: (NSString **)  emptyMessage display: (BOOL *)  displayEmptyMsg

optional

Get settings for display message in grid when grid is empty

Parameters

emptyMessage	Message to be displayed when grid is empty
displayEmptyMsg	If we will display the message

getWebServerType()

- (int) getWebServerType

optional

Get web server type (J2EE or ASP)

Returns

Web server type

See also

WebServerTypes

handleEventWithParameters:()

- (void) handleEventWithParameters:

(NSDictionary *)

urlParameters

Handle URL event

Parameters

urlParameters

URL dictionary

handleEventWithParameters:withLocationContext:()

- (void) handleEventWithParameters:		(NSDictionary *)	urlParameters
withLocationContext:		(LocationContext *)	locationContext

Handle URL event

Parameters

urlParameters	URL dictionary
locationContext	Context of the URL event

handleManipRenderStartTime:()

- (void) handleManipRenderStartTime: (NSDate *)  date

optional

handleManipulationCount()

- (void) handleManipulationCount

optional

handleRenderFinishTime:()

- (void) handleRenderFinishTime: (NSDate *)  date

optional

layoutManagerController()

- (LayoutManagerController*) layoutManagerController

Return layout manager controller for mobile VI

Returns

The layout manager controller

report()

- (MSIReportDisplayInfo*) report

rerunDocument:()

- (void) rerunDocument: (NSNumber *)  ignoreDeviceCache

optional

Rerun the document

Parameters

ignoreDeviceCache

Whether we want to reuse device document cache or ignore it

restoreContents()

- (BOOL) restoreContents

optional

Restore data controller state

Returns

If restore succeed

restoreTransactionContents:andTime:()

- (void) restoreTransactionContents: (NSString *)  docID andTime: (NSString *)  timeStamp

optional

Restore offline transaction content

Parameters

docID	Report/Document ID
timeStamp	Offline transaction timestamp

resubmitDataService:()

- (void) resubmitDataService: (BOOL)  showMessage

optional

Resubmit binary data service for refreshing

Parameters

showMessage

Prompt user about the refreshing or not

resubmitDataService:suppressNetworkErrorAlerts:ignoreDeviceCache:()

- (void) resubmitDataService: (BOOL)  showMessage suppressNetworkErrorAlerts: (BOOL)  suppressNetworkErrorAlerts ignoreDeviceCache: (BOOL)  ignoreCache

optional

Resubmit binary data service for refreshing

Parameters

showMessage	Prompt user about the refreshing or not
suppressNetworkErrorAlerts	Suppressing error message
ignoreCache	Should refreshing ignore device cache

setDataViewerVisibility:()

- (void) setDataViewerVisibility:

(BOOL)

visibility

Show or hide data viewer

Parameters

visibility

Boolean for visibility

setHomeButton:()

- (void) setHomeButton: (UIBarButtonItem *)  homeButton

optional

This method will setup the left bar button of the navigation bar for this controller.

Parameters

homeButton

ignore.

setReport:()

- (void) setReport:

(MSIReportDisplayInfo *)

report

Set the report or document

Parameters

report

Document or report to be displayed

setReportQueueRecall:()

- (void) setReportQueueRecall: (BOOL)  isRecall

optional