RestfulController (Grace Framework

grails.rest.RestfulController

```
@Artefact(value: Controller)
@grails.gorm.transactions.ReadOnly
class RestfulController<T>
extends Object
```
Base class that can be extended to get the basic CRUD operations needed for a RESTful API.
Authors:
Graeme Rocher
Since:
2.3

Properties Summary

Properties
Type	Name and description
`static Object`	`allowedMethods`
`boolean`	`readOnly`
`Class<T>`	`resource`
`String`	`resourceClassName`
`String`	`resourceName`

Constructor Summary

Constructors
Constructor and description
`RestfulController(Class<T> resource)`
`RestfulController(Class<T> resource, boolean readOnly)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected Integer`	`countResources()` Counts all of resources
	`Object`	`create()` Displays a form to create a new resource
	`protected T`	`createResource(Map params)` Creates a new instance of the resource for the given parameters
	`protected T`	`createResource()` Creates a new instance of the resource.
	`Object`	`delete()` Deletes a resource for the given id
	`protected void`	`deleteResource(T resource)` Deletes a resource
	`Object`	`edit()`
	`protected String`	`getClassMessageArg()`
	`protected 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
	`Object`	`index(Integer max)` Lists all resources up to the given maximum
	`protected List<T>`	`listAllResources(Map params)` List all of resource based on parameters
	`protected void`	`notFound()`
	`Object`	`patch()` Updates a resource for the given id
	`protected T`	`queryForResource(Serializable id)` Queries for a resource for the given id
	`Object`	`save()` Saves a resource
	`protected T`	`saveResource(T resource)` Saves a resource
	`Object`	`show()` Shows a single resource
	`Object`	`update()` Updates a resource for the given id
	`protected T`	`updateResource(T resource)` Updates a resource

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Property Detail
  - static Object allowedMethods
  - boolean readOnly
  - Class<T> resource
  - String resourceClassName
  - String resourceName
- Constructor Detail
  - RestfulController(Class<T> resource)
  - RestfulController(Class<T> resource, boolean readOnly)
- Method Detail
  - protected Integer countResources()
    
    Counts all of resources
    Returns:
    List of resources or empty if it doesn't exist
  - Object create()
    
    Displays a form to create a new resource
  - protected T createResource(Map params)
    
    Creates a new instance of the resource for the given parameters
    Parameters:
    params - The parameters
    Returns:
    The resource instance
  - protected T createResource()
    
    Creates 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.
    Returns:
    The resource instance
  - @grails.gorm.transactions.Transactional
    Object delete()
    
    Deletes a resource for the given id
    Parameters:
    id - The id
  - protected void deleteResource(T resource)
    
    Deletes a resource
    Parameters:
    resource - The resource to be deleted
  - Object edit()
  - protected String getClassMessageArg()
  - protected Object getObjectToBind()
    
    The 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 Map or a org.grails.databinding.DataBindingSource.
    Returns:
    the object to bind 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
    Returns:
    true if controller is read only
  - Object index(Integer max)
    
    Lists all resources up to the given maximum
    Parameters:
    max - The maximum
    Returns:
    A list of resources
  - protected List<T> listAllResources(Map params)
    
    List all of resource based on parameters
    Returns:
    List of resources or empty if it doesn't exist
  - protected void notFound()
  - @grails.gorm.transactions.Transactional
    Object patch()
    
    Updates a resource for the given id
    Parameters:
    id
  - protected T queryForResource(Serializable id)
    
    Queries for a resource for the given id
    Parameters:
    id - The id
    Returns:
    The resource or null if it doesn't exist
  - @grails.gorm.transactions.Transactional
    Object save()
    
    Saves a resource
  - protected T saveResource(T resource)
    
    Saves a resource
    Parameters:
    resource - The resource to be saved
    Returns:
    The saved resource or null if can't save it
  - Object show()
    
    Shows a single resource
    Parameters:
    id - The id of the resource
    Returns:
    The rendered resource or a 404 if it doesn't exist
  - @grails.gorm.transactions.Transactional
    Object update()
    
    Updates a resource for the given id
    Parameters:
    id
  - protected T updateResource(T resource)
    
    Updates a resource
    Parameters:
    resource - The resource to be updated
    Returns:
    The updated resource or null if can't save it

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

[Groovy] Class RestfulController<T>

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static Object allowedMethods

boolean readOnly

Class<T> resource

String resourceClassName

String resourceName

Constructor Detail

RestfulController(Class<T> resource)

RestfulController(Class<T> resource, boolean readOnly)

Method Detail

protected Integer countResources()

Object create()

protected T createResource(Map params)

protected T createResource()

@grails.gorm.transactions.Transactional
Object delete()

protected void deleteResource(T resource)

Object edit()

protected String getClassMessageArg()

protected Object getObjectToBind()

protected boolean handleReadOnly()

Object index(Integer max)

protected List<T> listAllResources(Map params)

protected void notFound()

@grails.gorm.transactions.Transactional
Object patch()

protected T queryForResource(Serializable id)

@grails.gorm.transactions.Transactional
Object save()

protected T saveResource(T resource)

Object show()

@grails.gorm.transactions.Transactional
Object update()

protected T updateResource(T resource)

[Groovy] Class RestfulController<T>

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static Object allowedMethods

boolean readOnly

Class<T> resource

String resourceClassName

String resourceName

Constructor Detail

RestfulController(Class<T> resource)

RestfulController(Class<T> resource, boolean readOnly)

Method Detail

protected Integer countResources()

Object create()

protected T createResource(Map params)

protected T createResource()

@grails.gorm.transactions.TransactionalObject delete()

protected void deleteResource(T resource)

Object edit()

protected String getClassMessageArg()

protected Object getObjectToBind()

protected boolean handleReadOnly()

Object index(Integer max)

protected List<T> listAllResources(Map params)

protected void notFound()

@grails.gorm.transactions.TransactionalObject patch()

protected T queryForResource(Serializable id)

@grails.gorm.transactions.TransactionalObject save()

protected T saveResource(T resource)

Object show()

@grails.gorm.transactions.TransactionalObject update()

protected T updateResource(T resource)

@grails.gorm.transactions.Transactional
Object delete()

@grails.gorm.transactions.Transactional
Object patch()

@grails.gorm.transactions.Transactional
Object save()

@grails.gorm.transactions.Transactional
Object update()