Modifying Identified Patterns in the Existing Code Base

There are certain identified patterns in the existing code base that must be modified when migrating Siebel Mobile disconnected from an asynchronous to a synchronous programming model, and the purpose of this topic is to highlight those patterns.

Patterns in the existing code that must be modified include the following:

Add a return value to the end of all asynchronous functions, for example, as follows:

BusComp.prototype.SetFieldValueX = function (fieldName, fieldData, 
SkipValidate, bSkipMvgCheck, bSkipED) { var currRetValue={err:false}, retObj;
// code body return(currRetValue);
}

Asynchronous functions typically declare the local function.

The Return value in asynchronous functions must return the currRetValue.
For example, change the following:
```
return;
```
To the following:
```
return currRetValue;
```
If the return value already returns an object (obj), it raises a conflict and must be manually fixed, for example, as follows:
```
return someObj; 
```

The setReturnValue value must set the currRetValue value.

For example, change the following:

$.setReturnValue({ err: true, retVal: data });

To the following:

currRetValue={ err: true, retVal: data };

If setReturnValue returns the current function, then change the following for example:

$.setReturnValue({ err: true, retVal: data });
return;

To the following:

currRetValue={ err: true, retVal: data };
return currRetValue;

If setReturnValue passes the value to the next $.callback, then change the following:

$.setReturnValue({ err: true, retVal: data });
...//some code branch $.callback(this, function(retObj) {
...//some code in call back
});

To the following:

currRetValue={ err: true, retVal: data };
 ..//some code branch
retObj = currRetValue;
. .//some code in call back

All calls to the asynchronous function must receive the synchronous value.
For example, change the following:
```
asyncFunc(args); 
```
To the following:
```
currRetValue=asyncFunc(args); 
```
Remove all $.callbacks, for example, as follows:
```
someAsyncFunc();
$.callback(scope, function(retObj) {
...//some code in call back
});
```
1. If there is a retObj argument, then change the $.callback to the following for example:
```
currRetValue=someAsyncFunc();
retObj=currRetValue;
...//some code in call back
```
2. If there is no retObj argument, then change the $.callback from the following:
```
someAsyncFunc();
$.callback(scope, function() {
...//some code in call back
});
```
  To the following:
```
currRetValue=someAsyncFunc();
...//some code in call back 
```
3. Most $.callback functions take an argument with the retObj name, but if the argument has a different retObj name, then declare a new local variable for example as follows:
```
var someOtherRetObj = currRetValue; 
```
4. If the $.callback function is a handler, then change the following for example:
```
someAsyncFunc();
$.callback(this, doneHandler); 
```
  To the following:
```
currRetValue=someAsyncFunc();
retObj=currRetValue;
currRetValue=doneHandler.call(this,retObj)
```

Remove nested functions in asynchronous functions.

Reuse currRetValue/retObj in nested functions.
Replace nested functions using $.setReturnValue and $.callback with currRetValue/retObj.

For example, migrate the following:

BusComp.prototype.SetFieldValueX = function (fieldName, fieldData, bSkipValidate, 
bSkipMvgCheck, bSkipED) {

	if (this.IsDeletePending()) { 
		this.WriteRecord(); 
		$.callback(this,function(retObj){ 
			if(retObj.err){ 
				$.setReturnValue(retObj);//sync:remove:continue
			}else{ 

	SetFieldValueUpdate.call(this,fieldName,bPicked,fieldData);
			} 
		}); 
	}else{ 
			SetFieldValueUpdate.call(this,fieldName,bPicked,fieldData); 
	}
	$.callback(this, function (retObj) { 
			if(!retObj.err){ 

	SetFieldValuePostCall.call(this,fieldName,bPicked,inputObj,psInputArgs); 
				$.callback(this,function(retObj){
						$.setReturnValue(retObj);
				}); 
			}else{ 
				$.setReturnValue(retObj);
			} 
	});   
}

To the following:

BusComp.prototype.SetFieldValueX = function (fieldName, fieldData, bSkipValidate, bSkipMvgCheck, bSkipED) {

	var currRetValue={err:false}, retObj;
		if (this.IsDeletePending()) {
			currRetValue=this.WriteRecord();
			retObj=currRetValue;
			//$.callback(this,function(retObj){ 
				if(retObj.err){ 
					currRetValue=(retObj); 
				}else{ 

currRetValue=SetFieldValueUpdate.call(this,fieldName,bPicked,fieldData);
				} 
			//}); 
		}else{ 

currRetValue=SetFieldValueUpdate.call(this,fieldName,bPicked,fieldData);
		} 
		retObj=currRetValue; 
		//$.callback(this, function (retObj) { 
			if(!retObj.err){ 

currRetValue=SetFieldValuePostCall.call(this,fieldName,bPicked,inputObj,psInputArgs);
					retObj=currRetValue; 
					currRetValue=(retObj); 
			}else{ 
					currRetValue=(retObj); 
			} 
		//});  
		return(currRetValue); 
	}