org.alfresco.rest.framework.core

Class ResourceParameter

java.lang.Object

org.alfresco.rest.framework.core.ResourceParameter

public class ResourceParameter
extends 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 and Description
static class	ResourceParameter.KIND

Field Summary

Fields

Modifier and Type	Field and 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

Modifier and Type	Method and Description
Class<?>	getDataType()
String	getDescription()
String	getName()
ResourceParameter.KIND	getParamType()
String	getTitle()
boolean	isAllowMultiple()
boolean	isRequired()
String	toString()
protected static ResourceParameter	valueOf(String name, String title, String description, boolean required, ResourceParameter.KIND kind, boolean allowMultiple, Class<?> dataType) Creates a new ResourceParameter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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(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 request

title - - a short description

description - - a long description

required - - is it mandatory?

kind - - The kind of parameter it is

allowMultiple - - Can allow multiple values?

dataType - - The expected data type of the parameter

Returns:

ResourceParameter

getName

public String getName()

isRequired

public boolean isRequired()

getTitle

public String getTitle()

getDescription

public String getDescription()

getDataType

public Class<?> getDataType()

isAllowMultiple

public boolean isAllowMultiple()

getParamType

public ResourceParameter.KIND getParamType()

toString

public String toString()

Overrides:

toString in class Object