@Artefact(value: Controller) @grails.gorm.transactions.ReadOnly class RestfulController<T> extends java.lang.Object
Base class that can be extended to get the basic CRUD operations needed for a RESTful API.
Type | Name and description |
---|---|
static java.lang.Object |
allowedMethods |
boolean |
readOnly |
java.lang.Class<T> |
resource |
java.lang.String |
resourceClassName |
java.lang.String |
resourceName |
Constructor and description |
---|
RestfulController
(java.lang.Class<T> resource) |
RestfulController
(java.lang.Class<T> resource, boolean readOnly) |
Type Params | Return Type | Name and description |
---|---|---|
|
protected java.lang.Integer |
countResources() Counts all of resources |
|
java.lang.Object |
create() Displays a form to create a new resource |
|
protected T |
createResource(java.util.Map params) Creates a new instance of the resource for the given parameters |
|
protected T |
createResource() Creates a new instance of the resource. |
|
java.lang.Object |
delete() Deletes a resource for the given id |
|
protected void |
deleteResource(T resource) Deletes a resource |
|
java.lang.Object |
edit() |
|
protected java.lang.String |
getClassMessageArg() |
|
protected java.lang.Object |
getObjectToBind() The object that can be bound to a domain instance. |
|
protected boolean |
handleReadOnly() handles the request for write methods (create, edit, update, save, delete) when controller is in read only mode |
|
java.lang.Object |
index(java.lang.Integer max) Lists all resources up to the given maximum |
|
protected java.util.List<T> |
listAllResources(java.util.Map params) List all of resource based on parameters |
|
protected void |
notFound() |
|
java.lang.Object |
patch() Updates a resource for the given id |
|
protected T |
queryForResource(java.io.Serializable id) Queries for a resource for the given id |
|
java.lang.Object |
save() Saves a resource |
|
protected T |
saveResource(T resource) Saves a resource |
|
java.lang.Object |
show() Shows a single resource |
|
java.lang.Object |
update() Updates a resource for the given id |
|
protected T |
updateResource(T resource) Updates a resource |
Methods inherited from class | Name |
---|---|
class java.lang.Object |
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
Counts all of resources
Displays a form to create a new resource
Creates a new instance of the resource for the given parameters
params
- The parametersCreates a new instance of the resource. If the request contains a body the body will be parsed and used to initialize the new instance, otherwise request parameters will be used to initialized the new instance.
Deletes a resource for the given id
id
- The idDeletes a resource
resource
- The resource to be deletedThe object that can be bound to a domain instance. Defaults to the request. Subclasses may override this method to return anything that is a valid second argument to the bindData method in a controller. This could be the request, a java.util.Map or a org.grails.databinding.DataBindingSource.
handles the request for write methods (create, edit, update, save, delete) when controller is in read only mode
Lists all resources up to the given maximum
max
- The maximumList all of resource based on parameters
Updates a resource for the given id
Queries for a resource for the given id
id
- The idSaves a resource
Saves a resource
resource
- The resource to be savedShows a single resource
id
- The id of the resourceUpdates a resource for the given id
Updates a resource
resource
- The resource to be updatedGroovy Documentation