public class Params extends java.lang.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(java.lang.String entityId,
java.lang.String relationshipId,
java.lang.Object passedIn,
java.io.InputStream stream,
java.lang.String addressedProperty,
Params.RecognizedParams recognizedParams,
BasicContentInfo contentInfo) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getBinaryProperty()
Gets the name of the property that was requested.
|
BasicContentInfo |
getContentInfo()
Gets the basic information about content, typically taken from a HTTPServletRequest.
|
java.lang.String |
getEntityId() |
BeanPropertiesFilter |
getFilter()
Returns a
BeanPropertiesFilter for filtering out properties. |
Paging |
getPaging()
Returns a representation of the Paging of collections of resources, with skip count and max items.
|
java.lang.String |
getParameter(java.lang.String parameterName)
Gets a single request parameter passed in by the user.
|
org.apache.poi.ss.formula.functions.T |
getParameter(java.lang.String parameterName,
java.lang.Class clazz)
Gets a single request parameter passed in by the user.
|
java.lang.Object |
getPassedIn() |
Query |
getQuery()
Represents a Query specified by the client.
|
java.util.Map |
getRelationsFilter() |
java.lang.String |
getRelationshipId() |
java.util.List |
getSelectedProperties()
A list of property names passed in the request using the json pointer syntax
Specified by the "SELECT" request parameter.
|
java.util.List |
getSorting()
Returns a List of
SortColumn for sorting properties. |
java.io.InputStream |
getStream() |
boolean |
hasBinaryProperty(java.lang.String propertyName)
Indicates if the specified property was requested.
|
java.lang.String |
toString() |
static Params |
valueOf(BeanPropertiesFilter paramFilter,
java.lang.String entityId) |
static Params |
valueOf(Params.RecognizedParams recognizedParams,
java.lang.String entityId,
java.lang.String relationshipId) |
static Params |
valueOf(java.lang.String entityId,
Params.RecognizedParams recognizedParams,
java.lang.Object passedIn) |
static Params |
valueOf(java.lang.String entityId,
java.lang.String relationshipId) |
static Params |
valueOf(java.lang.String entityId,
java.lang.String relationshipId,
java.lang.Object passedIn,
java.io.InputStream stream,
java.lang.String addressedProperty,
Params.RecognizedParams recognizedParams,
BasicContentInfo contentInfo) |
protected Params(java.lang.String entityId, java.lang.String relationshipId, java.lang.Object passedIn, java.io.InputStream stream, java.lang.String addressedProperty, Params.RecognizedParams recognizedParams, BasicContentInfo contentInfo)
public static Params valueOf(BeanPropertiesFilter paramFilter, java.lang.String entityId)
public static Params valueOf(java.lang.String entityId, java.lang.String relationshipId)
public static Params valueOf(Params.RecognizedParams recognizedParams, java.lang.String entityId, java.lang.String relationshipId)
public static Params valueOf(java.lang.String entityId, Params.RecognizedParams recognizedParams, java.lang.Object passedIn)
public static Params valueOf(java.lang.String entityId, java.lang.String relationshipId, java.lang.Object passedIn, java.io.InputStream stream, java.lang.String addressedProperty, Params.RecognizedParams recognizedParams, BasicContentInfo contentInfo)
public java.lang.String getEntityId()
public java.lang.Object getPassedIn()
public java.lang.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 java.util.Map getRelationsFilter()
public java.io.InputStream getStream()
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getParameter(java.lang.String parameterName)
Parameters
getParameter
in interface Parameters
public org.apache.poi.ss.formula.functions.T getParameter(java.lang.String parameterName, java.lang.Class clazz) throws InvalidArgumentException
Parameters
getParameter
in interface Parameters
clazz
- - type to use for conversion.InvalidArgumentException
public boolean hasBinaryProperty(java.lang.String propertyName)
Parameters
hasBinaryProperty
in interface Parameters
propertyName
- the property
Specified as part of the url request.public java.util.List getSorting()
Parameters
SortColumn
for sorting properties.
Specified by the "orderBy" request parameter.getSorting
in interface Parameters
SortColumn
public java.lang.String getBinaryProperty()
Parameters
getBinaryProperty
in interface Parameters
public java.util.List getSelectedProperties()
Parameters
getSelectedProperties
in interface Parameters
public BasicContentInfo getContentInfo()
Parameters
getContentInfo
in interface Parameters
Copyright © 2005 - 2013 Alfresco Software, Inc. All Rights Reserved.