DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

 



Method Summary
void
addFoundSet(fs)
Exposes an unrelated foundset to the mobile client.
void
addFoundSet(fs, relationNamesToTraverse)
Exposes an unrelated foundset to the mobile client.



Method Details

addFoundSet

void
addFoundSet
(fs)
Exposes an unrelated foundset to the mobile client. If service solution has a module of type Mobile shared module all possible relations from that module are traversed automatically.

Parameters

{JSFoundSet} fs - the foundset

Returns

void

Sample

var retval = plugins.mobileservice.createOfflineDataDescription('data_');
var ff = databaseManager.getFoundSet('bug_db','mytable');
ff.loadAllRecords();
retval.addFoundSet(ff);
 

addFoundSet

void
addFoundSet
(fs, relationNamesToTraverse)
Exposes an unrelated foundset to the mobile client.
which can be used in the mobile client in an unrelated way like in a (first) form or databaseManager.getFoundset(...).
For each record in the provided (unrelated) foundset the specified relation names are traversed and all data taken. Providing the relation names to traverse overrides the automatic traversal of the relations found in the "Mobile Shared Module".

Parameters

{JSFoundSet} fs - the root foundset
{String[]} relationNamesToTraverse - the relations to traverse from records found in root root foundset

Returns

void

Sample

var data = plugins.mobileservice.createOfflineDataDescription('data_');
var fs_contact = globals.accountmanager_contacts; //contains the account manager contact
var traverse = new Array();
traverse.push('accountmanager_to_companies');
data.addFoundSet(fs_contact, traverse);