Package org.alfresco.rest.framework.core
Class ResourceParameter
- java.lang.Object
-
- org.alfresco.rest.framework.core.ResourceParameter
-
public class ResourceParameter extends java.lang.Object
ResourceParameters are used on ResourceOperations The KIND is one of : QUERY_STRING - A query string parameter as part of the URL HTTP_BODY_OBJECT - A JSON object specified in a HTTP_BODY used by either a POST or PUT URL_PATH - Included as part of the actual url, e.g. entity id. (Does not support multiple values) HTTP_HEADER - Included in the request's HTTP Header- Author:
- Gethin James
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ResourceParameter.KIND
-
Field Summary
Fields Modifier and Type Field Description static ResourceParameter
ENTITY_PARAM
static ResourceParameter
MAX_ITEMS_PARAM
static ResourceParameter
PROPS_PARAM
static ResourceParameter
RELATIONS_PARAM
static ResourceParameter
RELATIONSHIP_PARAM
static ResourceParameter
SKIP_PARAM
static ResourceParameter
WHERE_PARAM
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Class<?>
getDataType()
java.lang.String
getDescription()
java.lang.String
getName()
ResourceParameter.KIND
getParamType()
java.lang.String
getTitle()
boolean
isAllowMultiple()
boolean
isRequired()
java.lang.String
toString()
protected static ResourceParameter
valueOf(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, ResourceParameter.KIND kind, boolean allowMultiple, java.lang.Class<?> dataType)
Creates a new ResourceParameter.
-
-
-
Field Detail
-
ENTITY_PARAM
public static final ResourceParameter ENTITY_PARAM
-
RELATIONSHIP_PARAM
public static final ResourceParameter RELATIONSHIP_PARAM
-
SKIP_PARAM
public static final ResourceParameter SKIP_PARAM
-
MAX_ITEMS_PARAM
public static final ResourceParameter MAX_ITEMS_PARAM
-
PROPS_PARAM
public static final ResourceParameter PROPS_PARAM
-
RELATIONS_PARAM
public static final ResourceParameter RELATIONS_PARAM
-
WHERE_PARAM
public static final ResourceParameter WHERE_PARAM
-
-
Method Detail
-
valueOf
protected static ResourceParameter valueOf(java.lang.String name, java.lang.String title, java.lang.String description, boolean required, ResourceParameter.KIND kind, boolean allowMultiple, java.lang.Class<?> dataType)
Creates a new ResourceParameter.- Parameters:
name
- - name used in the requesttitle
- - a short descriptiondescription
- - a long descriptionrequired
- - is it mandatory?kind
- - The kind of parameter it isallowMultiple
- - Can allow multiple values?dataType
- - The expected data type of the parameter- Returns:
- ResourceParameter
-
getName
public java.lang.String getName()
-
isRequired
public boolean isRequired()
-
getTitle
public java.lang.String getTitle()
-
getDescription
public java.lang.String getDescription()
-
getDataType
public java.lang.Class<?> getDataType()
-
isAllowMultiple
public boolean isAllowMultiple()
-
getParamType
public ResourceParameter.KIND getParamType()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-