public class Params extends Object implements Parameters
Modifier and Type | Class and Description |
---|---|
static class |
Params.RecognizedParams
A formal set of params that any rest service could potentially have passed in as request params
|
Modifier | Constructor and Description |
---|---|
protected |
Params(String entityId,
String relationshipId,
Object passedIn,
InputStream stream,
String addressedProperty,
Params.RecognizedParams recognizedParams,
BasicContentInfo contentInfo,
org.springframework.extensions.webscripts.WebScriptRequest request) |
Modifier and Type | Method and Description |
---|---|
String |
getBinaryProperty()
Gets the name of the property that was requested.
|
BasicContentInfo |
getContentInfo()
Gets the basic information about content, typically taken from a HTTPServletRequest.
|
String |
getEntityId() |
BeanPropertiesFilter |
getFilter()
Returns a
BeanPropertiesFilter for filtering out properties. |
List<String> |
getInclude()
A list of property names passed in the request using the json pointer syntax
Specified by the "INCLUDE" request parameter.
|
Paging |
getPaging()
Returns a representation of the Paging of collections of resources, with skip count and max items.
|
String |
getParameter(String parameterName)
Gets a single request query parameter passed in by the user.
|
org.apache.poi.ss.formula.functions.T |
getParameter(String parameterName,
Class<org.apache.poi.ss.formula.functions.T> clazz)
Gets a single request parameter passed in by the user.
|
Object |
getPassedIn() |
Query |
getQuery()
Represents a Query specified by the client.
|
Map<String,BeanPropertiesFilter> |
getRelationsFilter() |
String |
getRelationshipId() |
org.springframework.extensions.webscripts.WebScriptRequest |
getRequest()
Gets access to the entire webscript request.
|
List<String> |
getSelectedProperties()
A list of property names passed in the request using the json pointer syntax
Specified by the "SELECT" request parameter.
|
List<SortColumn> |
getSorting()
Returns a List of
SortColumn for sorting properties. |
InputStream |
getStream() |
boolean |
hasBinaryProperty(String propertyName)
Indicates if the specified property was requested.
|
boolean |
includeSource()
Indicates if the source entity should be includes in the request.
|
String |
toString() |
static Params |
valueOf(BeanPropertiesFilter paramFilter,
String entityId,
org.springframework.extensions.webscripts.WebScriptRequest request) |
static Params |
valueOf(Params.RecognizedParams recognizedParams,
String entityId,
String relationshipId,
org.springframework.extensions.webscripts.WebScriptRequest request) |
static Params |
valueOf(String entityId,
Params.RecognizedParams recognizedParams,
Object passedIn,
org.springframework.extensions.webscripts.WebScriptRequest request) |
static Params |
valueOf(String entityId,
String relationshipId,
Object passedIn,
InputStream stream,
String addressedProperty,
Params.RecognizedParams recognizedParams,
BasicContentInfo contentInfo,
org.springframework.extensions.webscripts.WebScriptRequest request) |
static Params |
valueOf(String entityId,
String relationshipId,
Params.RecognizedParams recognizedParams,
Object passedIn,
org.springframework.extensions.webscripts.WebScriptRequest request) |
static Params |
valueOf(String entityId,
String relationshipId,
org.springframework.extensions.webscripts.WebScriptRequest request) |
protected Params(String entityId, String relationshipId, Object passedIn, InputStream stream, String addressedProperty, Params.RecognizedParams recognizedParams, BasicContentInfo contentInfo, org.springframework.extensions.webscripts.WebScriptRequest request)
public static Params valueOf(BeanPropertiesFilter paramFilter, String entityId, org.springframework.extensions.webscripts.WebScriptRequest request)
public static Params valueOf(String entityId, String relationshipId, org.springframework.extensions.webscripts.WebScriptRequest request)
public static Params valueOf(Params.RecognizedParams recognizedParams, String entityId, String relationshipId, org.springframework.extensions.webscripts.WebScriptRequest request)
public static Params valueOf(String entityId, Params.RecognizedParams recognizedParams, Object passedIn, org.springframework.extensions.webscripts.WebScriptRequest request)
public static Params valueOf(String entityId, String relationshipId, Params.RecognizedParams recognizedParams, Object passedIn, org.springframework.extensions.webscripts.WebScriptRequest request)
public static Params valueOf(String entityId, String relationshipId, Object passedIn, InputStream stream, String addressedProperty, Params.RecognizedParams recognizedParams, BasicContentInfo contentInfo, org.springframework.extensions.webscripts.WebScriptRequest request)
public String getEntityId()
public Object getPassedIn()
public String getRelationshipId()
public Query getQuery()
Parameters
getQuery
in interface Parameters
Query
public Paging getPaging()
Parameters
Paging
Specified by the "skipCount" and "maxItems" request parameters.getPaging
in interface Parameters
public BeanPropertiesFilter getFilter()
Parameters
BeanPropertiesFilter
for filtering out properties.
Specified by the "properties" request parameter.getFilter
in interface Parameters
BeanPropertiesFilter
public boolean includeSource()
Parameters
includeSource
in interface Parameters
public Map<String,BeanPropertiesFilter> getRelationsFilter()
public InputStream getStream()
public String getParameter(String parameterName)
Parameters
getParameter
in interface Parameters
parameterName
- Stringpublic org.apache.poi.ss.formula.functions.T getParameter(String parameterName, Class<org.apache.poi.ss.formula.functions.T> clazz) throws InvalidArgumentException
Parameters
getParameter
in interface Parameters
parameterName
- Stringclazz
- - type to use for conversion.InvalidArgumentException
public boolean hasBinaryProperty(String propertyName)
Parameters
hasBinaryProperty
in interface Parameters
propertyName
- the property
Specified as part of the url request.public List<SortColumn> getSorting()
Parameters
SortColumn
for sorting properties.
Specified by the "orderBy" request parameter.getSorting
in interface Parameters
SortColumn
public String getBinaryProperty()
Parameters
getBinaryProperty
in interface Parameters
public List<String> getSelectedProperties()
Parameters
getSelectedProperties
in interface Parameters
public List<String> getInclude()
Parameters
getInclude
in interface Parameters
public BasicContentInfo getContentInfo()
Parameters
getContentInfo
in interface Parameters
public org.springframework.extensions.webscripts.WebScriptRequest getRequest()
Parameters
getRequest
in interface Parameters
Copyright © 2005–2017 Alfresco Software. All rights reserved.