com.viaoa.remote.rest.annotation

Annotation Type OARestMethod

@Documented
 @Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface OARestMethod

Remoting information about remote methods using HTTP(S).

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

Author:

vvia

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	includePropertyPath PropertyPath to include in OAGraph result.
String[]	includePropertyPaths PropertyPath to include in OAGraph result.
int	includeReferenceLevelAmount Number of reference levels to include in OAGraph result.
String	methodName The method name for remote method calls.
OARestMethod.MethodType	methodType
String	name
int	pageSize value used as the page size for returns that are collection of values (zero or more). A value <= 0 will use the servers default pagesize.
Class	returnClass Type of return class.
String	searchOrderBy Search Query OrderBy to use.
String	searchWhere search Query to use, with ?tags from param(s) with type=SearchWhereTagValue.
String	urlPath URL path for endpoint.
String	urlQuery http query string.

Element Detail

methodType

public abstract OARestMethod.MethodType methodType

Default:

com.viaoa.remote.rest.annotation.OARestMethod.MethodType.Unassigned

name

public abstract String name

Default:

""

urlPath

public abstract String urlPath

URL path for endpoint. If it does not include "://", then the OARestClient.baseUrl will be used as prefix.

Supports path template names, example: "/emp/{id}/{name}"
tags (case insensitive) are filled in from method params with paramType==UrlPathValue, and must have the @RestParam.name defined to match name used in template.

Used by non-OA* method types

Supports path template {name}, example: "/emp/{id}"
Supports path template ?tags, example: "/emp/?/?"
? tags will use method params with paramType==UrlPathValue, to fill in from left to right.

verify: if tags names, that there are matching param(s) with matching name for all {x} tags
verify: if ?tags, that there are matching paramType==UrlPathValue
verify: cant mix {} and ? tags

Default:

""

urlQuery

public abstract String urlQuery

http query string.

verify: ignores leading '?'

Default:

""

searchWhere

public abstract String searchWhere

search Query to use, with ?tags from param(s) with type=SearchWhereTagValue.

only used when methodType=OASearch

verify: query ?tags having mathcing params with type=SearchWhereTagValue

Default:

""

searchOrderBy

public abstract String searchOrderBy

Search Query OrderBy to use.

only used when methodType=OASearch

verify: RestMethod.queryWhere is not empty, and param type=MethodQueryOrderBy is not empty

Default:

""

includePropertyPath

public abstract String includePropertyPath

PropertyPath to include in OAGraph result.

only used when methodType=OA*

Default:

""

includePropertyPaths

public abstract String[] includePropertyPaths

PropertyPath to include in OAGraph result.

only used when methodType=OA*

Default:

{}

includeReferenceLevelAmount

public abstract int includeReferenceLevelAmount

Number of reference levels to include in OAGraph result.

only used when methodType=OA*

Default:

0

methodName

public abstract String methodName

The method name for remote method calls.

only used by methodType=OAObjectMethodCall, or methodType=OARemote

Default:

""

pageSize

public abstract int pageSize

value used as the page size for returns that are collection of values (zero or more).
A value <= 0 will use the servers default pagesize.

This will be added as an http query value "pageSize"

verify: only needed when return value is array,List,Hub
verify: pageNumber is required if pageSize>0

Default:

0

returnClass

public abstract Class returnClass

Type of return class. This is used/needed when it can't be determined what the actual return class is.
For example: if using a List or Hub and the actual objects can not be discovered using generics.

Note: generics are able to be discovered for return values (not affected by generics erasure).
Note: calling OARestMethodInfo.verify() will check to see if returnClass is needed or not.

Default:

java.lang.Void.class