org.opencastproject.util.doc.rest

Annotation Type RestResponse

@Retention(value=RUNTIME)
public @interface RestResponse

This annotation type is used for annotating responses for RESTful query. This annotation type needs to be kept until runtime.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	description
int	responseCode

Element Detail

responseCode

public abstract int responseCode

Returns:

a HTTP response code, such as 200, 400 etc. Developer should use constants in javax.servlet.http.HttpServletResponse instead of magic numbers.

description

public abstract String description

Returns:

a description of the response.