org.structr.rest.resource

Class SortResource

java.lang.Object

org.structr.rest.resource.Resource

org.structr.rest.resource.WrappingResource

org.structr.rest.resource.SortResource

public class SortResource
extends WrappingResource

Author:

Christian Morgner

Field Summary

Fields inherited from class org.structr.rest.resource.WrappingResource

wrappedResource

Fields inherited from class org.structr.rest.resource.Resource

idProperty, securityContext

Constructor Summary

Constructors

Constructor and Description
SortResource(SecurityContext securityContext, String sortKey, String sortOrder)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkAndConfigure(String part, SecurityContext securityContext, javax.servlet.http.HttpServletRequest request) Check and configure this instance with the given values.
Result	doGet(PropertyKey sortKey, boolean sortDescending, int pageSize, int page, String offsetId)
String	getResourceSignature()
String	getSortKey()
String	getSortOrder()
void	postProcessResultSet(Result result)
Resource	tryCombineWith(Resource next)

Methods inherited from class org.structr.rest.resource.WrappingResource

doPost, getEntityClass, getUriPart, isCollectionResource, isPrimitiveArray, wrapResource

Methods inherited from class org.structr.rest.resource.Resource

applyDefaultSorting, buildLocationHeader, configureIdProperty, configurePropertyView, createPostTransaction, doDelete, doHead, doOptions, doPut, extractDistanceSearch, extractSearchableAttributes, findPropertyKey, parseInteger, setSecurityContext

Methods inherited from class java.lang.Object

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

Constructor Detail

SortResource

public SortResource(SecurityContext securityContext,
            String sortKey,
            String sortOrder)

Method Detail

checkAndConfigure

public boolean checkAndConfigure(String part,
                        SecurityContext securityContext,
                        javax.servlet.http.HttpServletRequest request)

Description copied from class: Resource

Check and configure this instance with the given values. Please note that you need to set the security context of your class in this method.

Specified by:

checkAndConfigure in class Resource

Parameters:

part - the uri part that matched this resource

securityContext - the security context of the current request

request - the current request

Returns:

whether this resource accepts the given uri part

doGet

public Result doGet(PropertyKey sortKey,
           boolean sortDescending,
           int pageSize,
           int page,
           String offsetId)
             throws FrameworkException

Specified by:

doGet in class Resource

Throws:

FrameworkException

tryCombineWith

public Resource tryCombineWith(Resource next)
                        throws FrameworkException

Overrides:

tryCombineWith in class WrappingResource

Throws:

FrameworkException

getSortOrder

public String getSortOrder()

getSortKey

public String getSortKey()

postProcessResultSet

public void postProcessResultSet(Result result)

Overrides:

postProcessResultSet in class Resource

getResourceSignature

public String getResourceSignature()

Specified by:

getResourceSignature in class Resource