Package org.apache.olingo.odata2.api.annotation.edm

Annotation Interface EdmFunctionImport

@Retention(RUNTIME)
@Target(METHOD)
public @interface EdmFunctionImport

Annotation for definition of an method as an EdmFunctionImport call/endpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EdmFunctionImport.HttpMethod	Concrete HttpMethods for a function import as specified in OData.
static @interface	EdmFunctionImport.ReturnType	Annotation for definition of the return type of an EdmFunctionImport method.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
EdmFunctionImport.ReturnType	returnType	Define the return type of this function import

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
EdmDocumentation	documentation	Defines additional documentation for this function import.
String	entitySet	Define the name for the according entity set of the function import.
EdmFunctionImport.HttpMethod	httpMethod	Define the http method for which this function import is used If not set the default http method GET is used.
String	name	Define the name for the function import.

Element Details

name

String name

Define the name for the function import. If not set a default value has to be generated by the EDM provider.

Returns:

name for the function import

Default:

""

entitySet

String entitySet

Define the name for the according entity set of the function import. If not set a default value has to be generated by the EDM provider.

Returns:

name for the according entity set of the function import

Default:

""

returnType

EdmFunctionImport.ReturnType returnType

Define the return type of this function import

Returns:

return type of this function import

httpMethod

EdmFunctionImport.HttpMethod httpMethod

Define the http method for which this function import is used If not set the default http method GET is used.

Returns:

http method for which this function import is used

Default:

GET

documentation

EdmDocumentation documentation

Defines additional documentation for this function import.

Returns:

additional documentation for this function import.

Default:

@org.apache.olingo.odata2.api.annotation.edm.EdmDocumentation