com.viaoa.remote.rest.annotation

Annotation Type OARestParam

@Documented
 @Target(value=PARAMETER)
 @Retention(value=RUNTIME)
public @interface OARestParam

Information about remote method parameters.

Important: this annotation needs to be added to the Interface, not the Impl class.

Author:

vvia

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	format
String	includePropertyPath property path to include when serializing this value.
String[]	includePropertyPaths property paths to include when serializing this value.
int	includeReferenceLevelAmount property path levels to include when serializing this value.
String	name default is to use the name of the param defined in the method.
Class	paramClass
OARestParam.ParamType	type The type of param that this is used for.

Element Detail

name

public abstract String name

default is to use the name of the param defined in the method.
Note: param names are lost and will be named arg#, unless compiled with option to save names.

Default:

""

paramClass

public abstract Class paramClass

Default:

java.lang.Void.class

format

public abstract String format

Default:

""

includePropertyPath

public abstract String includePropertyPath

property path to include when serializing this value.

Default:

""

includePropertyPaths

public abstract String[] includePropertyPaths

property paths to include when serializing this value.

Default:

{}

includeReferenceLevelAmount

public abstract int includeReferenceLevelAmount

property path levels to include when serializing this value.

Default:

0

type

public abstract OARestParam.ParamType type

The type of param that this is used for.

Default:

com.viaoa.remote.rest.annotation.OARestParam.ParamType.Unassigned