API参考>服务端>扩展服务API

 


Principal




方法摘要
LonggetId()
           获取操作员ID

      return: 操作员ID
StringgetName()
           获取操作员姓名

      return: 操作员姓名
StringgetLoginId()
           获取操作员登入帐户名称

      return: 登入帐户名称
StringgetEmail()
           获取操作员邮箱地址

      return: 邮箱地址


ScriptService




方法摘要
voidbeginTransaction()
           启动数据库事务
 
voidcommit()
           提交数据库事务
 
voidrollback()
           回滚数据库事务
 
JSEntitycreateEntity(String entityName)
           创建实体对象
     参数:
        entityName (类型:String)   实体名称

      return: 创建的实体对象
voidsaveEntity(JSEntity entity)
           保存实体对象
     参数:
        entity (类型:JSEntity)   实体对象
 
voidremoveEntity(String entityName, int entityId)
           删除实体对象
     参数:
        entityName (类型:String)   实体名称
        entityId (类型:int)   实体对象ID
 
JSEntityfindEntity(String entityName, int entityId)
           根据实体ID查找实体对象
     参数:
        entityName (类型:String)   实体名称
        entityId (类型:int)   实体对象ID

      return: 找到的实体对象或null
ArrayqueryHQL(String hql)
           执行Hibernate查询语句并返回查询结果
     参数:
        hql (类型:String)   Hibernate查询语句

      return: 查询结果
intexecuteHQL(String hql)
           执行Hibernate查询语句并返回执行结果
     参数:
        hql (类型:String)   Hibernate查询语句

      return: 执行结果
ArrayquerySQL(String sql)
           执行SQL语句并返回查询结果
     参数:
        sql (类型:String)   SQL语句

      return: 查询结果
intexecuteSQL(String sql)
           执行SQL语句并返回执行结果
     参数:
        sql (类型:String)   SQL语句

      return: 执行结果
ScriptQuerycreateSQLQuery(String sql)
           创建SQL查询对象
     参数:
        sql (类型:String)   SQL语句

      return: SQL查询对象
ScriptQuerycreateHQLQuery(String sql)
           创建HQL查询对象
     参数:
        sql (类型:String)   HQL语句

      return: HQL查询对象
ArrayqueryEntity(String hql)
           执行实体查询语句
     参数:
        hql (类型:String)   实体查询语句

      return: 实体对象数组 每条记录对象类型为JSEntity
StringgetDomainProperty(String name)
           获取当前登入域的属性值
     参数:
        name (类型:String)   属性名称

      return: 属性值
PrincipalgetPrincipal(Object id)
           根据ID获取登入用户对象
     参数:
        id (类型:Object)   类型为String或Long的操作员ID

      return: 操作员对象
StringgetLoginId(Object id)
           根据ID获取登入用户的完整帐户名称
     参数:
        id (类型:Object)   类型为String或Long的操作员ID

      return: 完整帐户名称
voidsendNotifyMessage(String userLoginId, String title, String body)
           向用户发送通知消息
     参数:
        userLoginId (类型:String)   用户的完整登入名
        title (类型:String)   消息标题
        body (类型:String)   消息内容
 
voidsendMessage(String userLoginId, String messageXml)
           向用户发送消息
     参数:
        userLoginId (类型:String)   用户的完整登入名
        messageXml (类型:String)   消息
 

 


ScriptQuery




方法摘要
voidsetString(String name, String value)
           设置字符串参数
     参数:
        name (类型:String)   参数名称
        value (类型:String)   参数值
 
voidsetInt(String name, int value)
           设置整数参数
     参数:
        name (类型:String)   参数名称
        value (类型:int)   参数值
 
voidsetLong(String name, long value)
           设置长整数参数
     参数:
        name (类型:String)   参数名称
        value (类型:long)   参数值
 
voidsetBoolean(String name, boolean value)
           设置布尔值参数
     参数:
        name (类型:String)   参数名称
        value (类型:boolean)   参数值
 
voidsetTimestamp(String name, Date value)
           设置时间参数
     参数:
        name (类型:String)   参数名称
        value (类型:Date)   参数值
 
intexecuteUpdate()
           执行Update语句并返回影响的记录数

      return: 执行Update语句后影响的记录数
ArrayexecuteQuery()
           执行查询语句并返回查询结果

      return: 查询结果


ScriptLogger




方法摘要
voidinfo(String message)
           记录日志信息,日志信息将记录到日志文件中
     参数:
        message (类型:String)   日志内容
 
voidwarn(String message)
           记录警告日志,警告日志将记录到日志文件中
     参数:
        message (类型:String)   日志内容
 
voiderror(String message)
           记录错误日志,错误日志将记录到日志文件中
     参数:
        message (类型:String)   日志内容
 
voidtrace(String message)
           输出打印日志,打印日志将返回给客户端,打印日志只在调试时输出
     参数:
        message (类型:String)   日志内容
 


JSEntity




方法摘要
Objectget(String name)
           获取实体属性
     参数:
        name (类型:String)   属性名称

      return: 属性值
voidset(String name, Object value)
           设置实体属性
     参数:
        name (类型:String)   属性名称
        value (类型:Object)   属性值
 
StringgetEntityName()
           获取实体名称

      return: 实体名称
voidsave()
           保存实体对象
 


ScriptEvent




方法摘要
JSEntitygetEntity()
           获取事件对应的实体对象

      return: 实体对象
StringgetSubmitMode()
           获取提交方式名称

      return: 提交方式名称
StringgetSubmitNote()
           获取提交备注内容

      return: 提交备注内容
StringgetName()
           获取事件名称

      return: 事件名称
BooleanisDefaultPrevented()
           默认行为是否已取消

      return: true/false
voidpreventedDefault()
           取消服务处理的默认行为
 
voidstopPropagation()
           阻止消息向其他消息处理器分发
 
BooleanisPropagationStoped()
           消息分发是否已中止

      return: true/false
ObjectgetAttribute(String name)
           获取事件相关属性
     参数:
        name (类型:String)   名称

      return: 事件相关属性
voidsetAttribute(String name, Obejct value)
           设置事件相关属性
     参数:
        name (类型:String)   名称
        value (类型:Obejct)   值