Package org.alfresco.rest.framework.core
Class ResourceParameter
java.lang.Object
org.alfresco.rest.framework.core.ResourceParameter
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 -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ResourceParameter
static final ResourceParameter
static final ResourceParameter
static final ResourceParameter
static final ResourceParameter
static final ResourceParameter
static final ResourceParameter
-
Method Summary
Modifier and TypeMethodDescriptionClass<?>
getName()
getTitle()
boolean
boolean
toString()
protected static ResourceParameter
valueOf
(String name, String title, String description, boolean required, ResourceParameter.KIND kind, boolean allowMultiple, Class<?> dataType) Creates a new ResourceParameter.
-
Field Details
-
ENTITY_PARAM
-
RELATIONSHIP_PARAM
-
SKIP_PARAM
-
MAX_ITEMS_PARAM
-
PROPS_PARAM
-
RELATIONS_PARAM
-
WHERE_PARAM
-
-
Method Details
-
valueOf
protected static ResourceParameter valueOf(String name, String title, String description, boolean required, ResourceParameter.KIND kind, boolean allowMultiple, 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
-
isRequired
public boolean isRequired() -
getTitle
-
getDescription
-
getDataType
-
isAllowMultiple
public boolean isAllowMultiple() -
getParamType
-
toString
-