gboat2.web.service
接口 IWidgetService


public interface IWidgetService

桌面小控件服务接口,各个实现本接口

从以下版本开始:
jdk1.6
作者:
tanxw

方法摘要
 net.sf.json.JSONArray fetchMsgs(UserSession session, int count)
          获取桌面控件的显示消息
 String getId()
          取得标记本服务的唯一(不能与本服务的其他实现类返回的id重复)标识,本标识是可持久化的,如:可以用类名作为类的唯一标识
 String getTitle()
          widget服务标题
 net.sf.json.JSONObject getWidgetConfig(UserSession session)
          获取显示本服务消息的前端widget组件配置信息
 boolean hasMsg(UserSession session)
          是否有消息需要显示
 

方法详细信息

getId

String getId()
取得标记本服务的唯一(不能与本服务的其他实现类返回的id重复)标识,本标识是可持久化的,如:可以用类名作为类的唯一标识

返回:
本服务的id

hasMsg

boolean hasMsg(UserSession session)
是否有消息需要显示

返回:
true,如果有消息

getWidgetConfig

net.sf.json.JSONObject getWidgetConfig(UserSession session)
获取显示本服务消息的前端widget组件配置信息

参数:
session - 当前用户
返回:
JSONObject实例,如果返回null,表示采用widget的默认配置,对象格式为:
 {
         component : '前端widget组件名称,如Gboat2.desktop.widget.Info', //默认值为前端默认的widget
         url : 'widget消息数据的url地址', //默认值为WidgetAction.widgetMsgs()的url
   title : 'widget的标题', //为空表示无标题
   params : {请求url时,附加的参数}
 }
 

fetchMsgs

net.sf.json.JSONArray fetchMsgs(UserSession session,
                                int count)
获取桌面控件的显示消息

参数:
session -
count - 请求的消息记录条数的最大值,-1表示不限制记录条数
返回:
JsonArray,格式为:
 [{
        url : '打开模块的路径',
        text : '显示的标题',
  params : {url中的参数}
 },
 ...
 ]
 

getTitle

String getTitle()
widget服务标题

返回:


Copyright © 2014 广联达软件股份有限公司(Glodon Software Co., Ltd.). All rights reserved.