org.oncoblocks.centromere.web.controller

Interface WebServicesController<T extends Model<ID>,ID extends Serializable>

All Known Implementing Classes:

AbstractApiController, CrudApiController, ReadOnlyApiController

public interface WebServicesController<T extends Model<ID>,ID extends Serializable>

Basic interface, defining all of the required methods for a web services controller.

Author:

woemler

Method Summary

Modifier and Type	Method and Description
org.springframework.http.HttpEntity<?>	create(T entity, javax.servlet.http.HttpServletRequest request) POST / - Attempts to create a new entity record.
org.springframework.http.HttpEntity<?>	delete(ID id, javax.servlet.http.HttpServletRequest request) DELETE /{id} - Attempts to delete a single entity record.
org.springframework.http.HttpEntity<?>	find(org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<T> pagedResourcesAssembler, javax.servlet.http.HttpServletRequest request) GET / - Fetches one or more records, with optional filtering, paging, or sorting applied.
org.springframework.http.HttpEntity<?>	findById(ID id, javax.servlet.http.HttpServletRequest request) GET /{id} - Fetches a single record by its primary ID.
org.springframework.http.HttpEntity<?>	findDistinct(String field, javax.servlet.http.HttpServletRequest request) GET /distinct - Fetches a list of distinct field values.
org.springframework.http.HttpEntity<?>	head(javax.servlet.http.HttpServletRequest request) HEAD /** - Tests whether the URL endpoint is available.
org.springframework.http.HttpEntity<?>	options(javax.servlet.http.HttpServletRequest request) OPTIONS /** - Returns basic request information about URL the endpoint.
org.springframework.http.HttpEntity<?>	update(T entity, ID id, javax.servlet.http.HttpServletRequest request) PUT /{id} - Attempts to update an existing entity record.

Method Detail

findById

org.springframework.http.HttpEntity<?> findById(ID id,
                                                javax.servlet.http.HttpServletRequest request)

GET /{id} - Fetches a single record by its primary ID.

Parameters:

id -

request -

Returns:

findDistinct

org.springframework.http.HttpEntity<?> findDistinct(String field,
                                                    javax.servlet.http.HttpServletRequest request)

GET /distinct - Fetches a list of distinct field values.

Parameters:

field -

request -

Returns:

find

org.springframework.http.HttpEntity<?> find(org.springframework.data.domain.Pageable pageable,
                                            org.springframework.data.web.PagedResourcesAssembler<T> pagedResourcesAssembler,
                                            javax.servlet.http.HttpServletRequest request)

GET / - Fetches one or more records, with optional filtering, paging, or sorting applied.

Parameters:

pageable -

pagedResourcesAssembler -

request -

Returns:

head

org.springframework.http.HttpEntity<?> head(javax.servlet.http.HttpServletRequest request)

HEAD /** - Tests whether the URL endpoint is available.

Parameters:

request -

Returns:

options

org.springframework.http.HttpEntity<?> options(javax.servlet.http.HttpServletRequest request)

OPTIONS /** - Returns basic request information about URL the endpoint.

Parameters:

request -

Returns:

create

org.springframework.http.HttpEntity<?> create(T entity,
                                              javax.servlet.http.HttpServletRequest request)

POST / - Attempts to create a new entity record.

Parameters:

entity -

request -

Returns:

update

org.springframework.http.HttpEntity<?> update(T entity,
                                              ID id,
                                              javax.servlet.http.HttpServletRequest request)

PUT /{id} - Attempts to update an existing entity record.

Parameters:

entity -

id -

request -

Returns:

delete

org.springframework.http.HttpEntity<?> delete(ID id,
                                              javax.servlet.http.HttpServletRequest request)

DELETE /{id} - Attempts to delete a single entity record.

Parameters:

id -

request -

Returns: