1 /*
2 * Licensed to The Apereo Foundation under one or more contributor license
3 * agreements. See the NOTICE file distributed with this work for additional
4 * information regarding copyright ownership.
5 *
6 *
7 * The Apereo Foundation licenses this file to you under the Educational
8 * Community License, Version 2.0 (the "License"); you may not use this file
9 * except in compliance with the License. You may obtain a copy of the License
10 * at:
11 *
12 * http://opensource.org/licenses/ecl2.txt
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 * License for the specific language governing permissions and limitations under
18 * the License.
19 *
20 */
21
22 package org.opencastproject.util.doc.rest;
23
24 import java.lang.annotation.Retention;
25 import java.lang.annotation.RetentionPolicy;
26
27 /**
28 * This annotation type is used for annotating parameters for RESTful query. This annotation type needs to be kept until
29 * runtime.
30 */
31 @Retention(RetentionPolicy.RUNTIME)
32 public @interface RestParameter {
33
34 enum Type {
35 NO_PARAMETER, // This is a special type to represent that there is no parameter. We need this because java
36 // annotation cannot be set to null.
37 BOOLEAN, FILE, STRING, TEXT, INTEGER, FLOAT, LONG
38 };
39
40 /**
41 * @return a name of the parameter.
42 */
43 String name();
44
45 /**
46 * @return a description of the parameter.
47 */
48 String description();
49
50 /**
51 * @return a default value of the parameter.
52 */
53 String defaultValue() default "";
54
55 /**
56 * @return a RestParameter.Type enum specifying the type of the parameter.
57 */
58 Type type();
59
60 /**
61 * @return the {@link javax.xml.bind.annotation.XmlType} or {@link javax.xml.bind.annotation.XmlRootElement} annotated
62 * class that models this parameter.
63 */
64 Class<?> jaxbClass() default Object.class;
65
66 /**
67 * @return a boolean indicating whether this parameter is required.
68 */
69 boolean isRequired();
70 }