org.huihoo.ofbiz.smart.service.annotation

Annotation Type ServiceDefinition

@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface ServiceDefinition

具体的服务定义

Since:

1.0

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name 服务的名称

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<ServiceCallback>[]	callback
String	description 服务的描述
String	entityName 实体的名称(如果有)
boolean	export 是否对外提供远程调用
InParameter[]	inParameters 输入参数集合
OutParameter[]	outParameters 输出参数集合
boolean	persist 是否持久化
boolean	requireAuth 是否需要身份认证
String	responseJsonExample JSON格式的返回示例
String	responseXmlExample XML格式的返回示例
boolean	transaction 是否启用事务
String	type 服务的类型

Element Detail

name

public abstract String name

服务的名称

type

public abstract String type

服务的类型

Default:

"java"

description

public abstract String description

服务的描述

Default:

""

transaction

public abstract boolean transaction

是否启用事务

Default:

false

persist

public abstract boolean persist

是否持久化

Default:

true

requireAuth

public abstract boolean requireAuth

是否需要身份认证

Default:

false

export

public abstract boolean export

是否对外提供远程调用

Default:

false

entityName

public abstract String entityName

实体的名称(如果有)

Default:

""

callback

public abstract Class<ServiceCallback>[] callback

Default:

{}

inParameters

public abstract InParameter[] inParameters

输入参数集合

Default:

@org.huihoo.ofbiz.smart.service.annotation.InParameter(name="")

outParameters

public abstract OutParameter[] outParameters

输出参数集合

Default:

@org.huihoo.ofbiz.smart.service.annotation.OutParameter(name="")

responseJsonExample

public abstract String responseJsonExample

JSON格式的返回示例

Default:

""

responseXmlExample

public abstract String responseXmlExample

XML格式的返回示例

Default:

""