API
Class

Request ($UI/system/lib/base/request)

使用范围：UI2

Contents

class Request ($UI/system/lib/base/request)

请求相关

Constructor Top

  Request ()

Static Properties & Enumerations Top

ActionParam ActionParam

bizAction请求参对象
string bizExecuteUrl

[filed]biz action请求的url，$UI/system/service/common/bizAction.j
ListParam ListParam

List参数对象
MapParam MapParam

Map参数对象
ObjectParam ObjectParam

Object参数对象
string SESSION_TIMEOUT

[filed]BizServer session超时标志常量
SimpleParam SimpleParam

简单参数对象
TableParam TableParam

Table参数对象
TranslateParam TranslateParam

数据格式转换参数对象，主要用于table返回时，返回序列化的格式指定，主要bizData的newData、refreshData中使用
XMLParam XMLParam

XML参数对象

Static Methods Top

XMLHttpRequest beginBatch (string context)
void bizSessionOverdue (XMLHttpRequest XMLHttpRequest)
XMLHttpRequest cancelBatch ()
string createBizParam (object options)
XMLHttpRequest endBatch ()
void errorMessage (object responseData, string msg, string url, string requestParam)
string getCode (XMLHttpRequest XMLHttpRequest)
object getData (XMLHttpRequest XMLHttpRequest)
string getFlag (XMLHttpRequest XMLHttpRequest)
string getMessage (XMLHttpRequest XMLHttpRequest)
object getParamsFromURL (string url)
string getReason (XMLHttpRequest XMLHttpRequest)
string getServerError (Object responseData, string msg, string url, string requestParam)
boolean isBizSuccess (XMLHttpRequest XMLHttpRequest)
boolean isSuccess (XMLHttpRequest XMLHttpRequest)
XMLHttpRequest sendAsyncBizRequest (object options)
XMLHttpRequest sendAsyncHttpRequest (object options)
XMLHttpRequest sendBizRequest (object options)
XMLHttpRequest sendHttpRequest (object options)
string setBizParams (string url, string bsessionid, string process, string activity, string executor, string executeContext)

Constructor details Top

public Request ()

请求相关

Static Properties & Enumerations Detail Top

static public ActionParam ActionParam

bizAction请求参对象

static public string bizExecuteUrl

[filed]biz action请求的url，$UI/system/service/common/bizAction.j

static public ListParam ListParam

List参数对象

static public MapParam MapParam

Map参数对象

static public ObjectParam ObjectParam

Object参数对象

static public string SESSION_TIMEOUT

[filed]BizServer session超时标志常量

static public SimpleParam SimpleParam

简单参数对象

static public TableParam TableParam

Table参数对象

static public TranslateParam TranslateParam

数据格式转换参数对象，主要用于table返回时，返回序列化的格式指定，主要bizData的newData、refreshData中使用

static public XMLParam XMLParam

XML参数对象

Static Methods Detail Top

static public XMLHttpRequest beginBatch (string context)

启动批提交，支持嵌套

	
	//批提交
	Request.beginBatch();
	try{
		//发送biz请求
	 	...
	} catch (e) {
		Request.cancelBatch();
	 	...提示出错
	} 
	Request.endBatch();

See Request.endBatch

See Request.cancelBatch

Parameters

string context

当前的上下文

Return Value

XMLHttpRequest

static public void bizSessionOverdue (XMLHttpRequest XMLHttpRequest)

业务服务器请求的超时处理

Parameters

XMLHttpRequest XMLHttpRequest

[required]Request.sendBizRequest返回对象, 或bizAction返回的数据

Return Value

void

static public XMLHttpRequest cancelBatch ()

取消当前的批提交，所有批提交全部取消，案例参考：Request.beginBatch

See Request.beginBatch

See Request.endBatch

Return Value

XMLHttpRequest

static public string createBizParam (object options)

创建向Biz服务端发送Action请求的data，通常情况下不需主动调用此方法构造参数，直接使用Request.sendBizRequest发送请求

 
	
	var options = {};
	var param = new Request.ActionParam();
	param.setString('para_string', '');
	param.setInteger('para_integer', 11);
	param.setFloat('para_float', 1.345);
	param.setDateTime('para_datetime', new Data());
	var process = "/demo/misc/process/simpleAction/simpleActionProcess";
	var activity = "mainActivity";
	options.process = process;
	options.activity = activity;
	options.parameters = param;
	options.action = "demoparaAction";
	options.callback = function(data){
		...
	};	
	var result = Request.createBizParam(options);

See Request.sendBizRequest

See ActionParam

See TranslateParam

See RequestCallbackData

Parameters

object options

[required]请求属性
参数说明：

action：{string} [required] 执行的action; parameters：{$UI/system/lib/base/request#ActionParam} required Action参数对象 translateParam：{$UI/system/lib/base/request#TranslateParam} Action数据格式转换参数对象 callback：function 请求完成后的回调，function(RCD)，RCD为：RequestCallbackData directExecute：boolean 在批事务中是否立即执行 process：string 缺省取当前环境的 activity：string 缺省取当前环境的 executor： 执行者，缺省取当前环境里的 executeContext： 执行环境，缺省取环境里的 context: 当前的上下文，当process，activity，executor，executeContext没有给出时使用context中的相关参数

Return Value

string

static public XMLHttpRequest endBatch ()

执行批提交，支持嵌套，当执行了和Request.beginBatch对应次数才正式执行biz请求，案例参考：Request.beginBatch

See Request.beginBatch

See Request.cancelBatch

Return Value

XMLHttpRequest

static public void errorMessage (object responseData, string msg, string url, string requestParam)

Biz Action请求失败错误信息提示，可以在请求后的回调中处理请求错误

	
	Request.errorMessage(resultData, "加载数据失败！");

See Request.sendBizRequest

Parameters

object responseData

[required]请求返回对象或者回调参数
string msg

错误提示
string url

请求的url
string requestParam

请求的参数

Return Value

void

static public string getCode (XMLHttpRequest XMLHttpRequest)

获取响应的code

Parameters

XMLHttpRequest XMLHttpRequest

[required]Request.sendBizRequest返回对象

Return Value

string

static public object getData (XMLHttpRequest XMLHttpRequest)

获取响应的data数据

Parameters

XMLHttpRequest XMLHttpRequest

[required]Request.sendBizRequest返回对象

Return Value

object

返回请求的数据对象

static public string getFlag (XMLHttpRequest XMLHttpRequest)

获取响应的flag信息

Parameters

XMLHttpRequest XMLHttpRequest

[required]Request.sendBizRequest返回对象

Return Value

string

static public string getMessage (XMLHttpRequest XMLHttpRequest)

获取响应的message信息

Parameters

XMLHttpRequest XMLHttpRequest

[required]Request.sendBizRequest返回对象

Return Value

string

static public object getParamsFromURL (string url)

获取url中的参数，并返回对象

Parameters

string url

[required]URL

Return Value

object


格式：

{ 参数名: 值, 参数名: 值, ... }

static public string getReason (XMLHttpRequest XMLHttpRequest)

获取响应的reason

Parameters

XMLHttpRequest XMLHttpRequest

[required]Request.sendBizRequest返回对象

Return Value

string

static public string getServerError (Object responseData, string msg, string url, string requestParam)

获取Biz Action请求失败错误信息

	
	var msg = Request.getServerError(resultData, "加载数据失败！");

Parameters

Object responseData

[required]请求返回对象或者回调参数
string msg

错误提示
string url

请求的url
string requestParam

请求的参数

Return Value

string

static public boolean isBizSuccess (XMLHttpRequest XMLHttpRequest)

判断向Biz服务端发送Action请求是否成功，这是业务成功判断，也就是说http请求成功并且biz action成功返回

See Request.isSuccess

Parameters

XMLHttpRequest XMLHttpRequest

[required]Request.sendBizRequest返回对象

Return Value

boolean

static public boolean isSuccess (XMLHttpRequest XMLHttpRequest)

判断向服务端发送请求是否成功，代码示例参见：Request.sendHttpRequest

See Request.sendHttpRequest

See Request.isBizSuccess

Parameters

XMLHttpRequest XMLHttpRequest

[required]Request.sendHttpRequest返回对象

Return Value

boolean

static public XMLHttpRequest sendAsyncBizRequest (object options)

[推荐使用]向Biz服务端发送异步Action请求,使用json格式

 
	
	var options = {};
	var param = new Request.ActionParam();
	param.setString('para_string', '');
	param.setInteger('para_integer', 11);
	param.setFloat('para_float', 1.345);
	param.setDateTime('para_datetime', new Data());
	var process = "/demo/misc/process/simpleAction/simpleActionProcess";
	var activity = "mainActivity";
	options.contentType = 'application/json';
	options.process = process;
	options.activity = activity;
	options.dataType = "json";
	options.parameters = param;
	options.action = "demoparaAction";
	options.callback = function(data){
		if(data.state){
			//成功
		}else{
			//失败
			Request.errorMessage(resultData, "执行失败！", null, null);
		}			
	};	
	var result = Request.sendAsyncBizRequest(options);

See Request.createBizParam

See ActionParam

See TranslateParam

See RequestCallbackData

Parameters

object options

[required]请求参数
参数说明：

options参数说明： action：{string} [required] 执行的action; parameters：{$UI/system/lib/base/request#ActionParam} required Action参数对象 translateParam：{$UI/system/lib/base/request#TranslateParam} Action数据格式转换参数对象 callback：function 请求完成后的回调，function(RCD)，RCD为：RequestCallbackData，当设置了这个参数默认RequestCallbackData.ignoreError=true，即需要开发者处理错误；如果需要继续使用平台错误提示将RequestCallbackData.ignoreError=false; directExecute：boolean 在批事务中是否立即执行 process：string 缺省取当前环境的 activity：string 缺省取当前环境的 executor： 执行者，缺省取当前环境里的 executeContext： 执行环境，缺省取环境里的 context: 当前的上下文，当process，activity，executor，executeContext没有给出时使用context中的相关参数

Return Value

XMLHttpRequest

static public XMLHttpRequest sendAsyncHttpRequest (object options)

向服务端发送异步post请求,使用json格式

	 
	var param ={
		url: require.toUrl(('$UI/OA/test.j'), 
		postData: {
			param1 : 'beijing',
			param2 : 1
			},
		callback = function(xhr, ts){
			if(Request.isSuccess(xhr)) alert('ok');
			else alert('error');
		}	
	};
	Request.sendAsyncHttpRequest(param);

See Request.setBizParams

Parameters

object options

[required]请求属性
参数说明：

url : string URL postData : object 向服务端post的数据 process : string process activity : string activity executor : 执行者 executeContext : 执行环境 context : 当前的上下文，当process，activity，executor，executeContext没有给出时使用context中的相关参数 callback : 请求回调函数，callback(XHR, TS),XHR : XMLHttpRequest 对象, TS : 描述成功请求类型的字符串，参考jquery的ajax

Return Value

XMLHttpRequest

static public XMLHttpRequest sendBizRequest (object options)

[推荐使用]向Biz服务端发送同步Action请求,使用json格式

 
	
	var options = {};
	var param = new Request.ActionParam();
	param.setString('para_string', '');
	param.setInteger('para_integer', 11);
	param.setFloat('para_float', 1.345);
	param.setDateTime('para_datetime', new Data());
	var process = "/demo/misc/process/simpleAction/simpleActionProcess";
	var activity = "mainActivity";
	options.contentType = 'application/json';
	options.process = process;
	options.activity = activity;
	options.dataType = "json";
	options.parameters = param;
	options.action = "demoparaAction";
	options.callback = function(data){
		if(data.state){
			//成功
		}else{
			//失败
			Request.errorMessage(resultData, "执行失败！", null, null);
		}			
	};	
	var result = Request.sendBizRequest(options);

See Request.createBizParam

See ActionParam

See TranslateParam

See RequestCallbackData

Parameters

object options

[required]请求参数
参数说明：

options参数说明： action：{string} [required] 执行的action; parameters：{$UI/system/lib/base/request#ActionParam} required Action参数对象 translateParam：{$UI/system/lib/base/request#TranslateParam} Action数据格式转换参数对象 callback：function 请求完成后的回调，function(RCD)，RCD为：RequestCallbackData，当设置了这个参数默认RequestCallbackData.ignoreError=true，即需要开发者处理错误；如果需要继续使用平台错误提示将RequestCallbackData.ignoreError=false; directExecute：boolean 在批事务中是否立即执行 process：string 缺省取当前环境的 activity：string 缺省取当前环境的 executor： 执行者，缺省取当前环境里的 executeContext： 执行环境，缺省取环境里的 context: 当前的上下文，当process，activity，executor，executeContext没有给出时使用context中的相关参数

Return Value

XMLHttpRequest

static public XMLHttpRequest sendHttpRequest (object options)

向服务端发送同步post请求,使用json格式

	 
	var param ={
		url: require.toUrl('$UI/OA/test.j'), 
		postData: {
			param1 : 'beijing',
			param2 : 1
			},
		callback: function(xhr, ts){
			if(Request.isSuccess(xhr)) alert('ok');
			else alert('error');
		}	
	};
	Request.sendHttpRequest(param);

See Request.setBizParams

Parameters

object options

[required]请求属性
参数说明：

url : string URL postData : object 向服务端post的数据 process : string process activity : string activity executor : 执行者 executeContext : 执行环境 context : 当前的上下文 callback : 请求回调函数，callback(XHR, TS),XHR : XMLHttpRequest 对象, TS : 描述成功请求类型的字符串，参考jquery的ajax

Return Value

XMLHttpRequest

static public string setBizParams (string url, string bsessionid, string process, string activity, string executor, string executeContext)

URL上增加Bsessionid,process,activity,executor,executeContext等

Parameters

string url

[required]URL
string bsessionid

[required]bsessionid
string process
string activity
string executor

执行者
string executeContext

执行环境

Return Value

string