Method Detail

• abstract void embedded(java.lang.Object object)

  Render embedded links for the associations of the given object (if any)

  Parameters:

  object - The domain object

• abstract void embedded(java.util.Map model)

  Render embedded links for the given model

  Parameters:

  model - The embedded model

• abstract void embedded(java.lang.Object object, java.util.Map arguments)

  Render embedded links for the associations of the given object (if any)

  Parameters:

  object - The domain object

  arguments - Arguments to the embedded method

• abstract void embedded(@groovy.lang.DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate) groovy.lang.Closure callable)

  Outputs a HAL embedded entry for the given closure

  Parameters:

  callable - The callable

• abstract void embedded(java.lang.String contentType, @groovy.lang.DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate) groovy.lang.Closure callable)

  Outputs a HAL embedded entry for the content type and closure

  Parameters:

  contentType - The content type

  callable - The callable

• abstract void inline(java.lang.Object object, java.util.Map arguments, @groovy.lang.DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate) groovy.lang.Closure customizer)

  Same as GrailsJsonViewHelper.inline but renders HAL links too

• abstract void inline(java.lang.Object object, java.util.Map arguments)

  Same as GrailsJsonViewHelper.inline but renders HAL links too

• abstract void inline(java.lang.Object object, @groovy.lang.DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate) groovy.lang.Closure customizer)

  Same as GrailsJsonViewHelper.inline but renders HAL links too

• abstract void inline(java.lang.Object object)

  Same as GrailsJsonViewHelper.inline but renders HAL links too

• abstract void links(groovy.lang.Closure callable)

  Define the hal links

  Parameters:

  callable - The closure

• abstract void links(java.lang.Object object, java.lang.String contentType)

  Creates HAL links for the given object

  Parameters:

  object - The object to create links for

• abstract void links(java.lang.Object object)

  Creates HAL links for the given object

  Parameters:

  object - The object to create links for

• abstract void links(java.util.Map model)

  Creates HAL links for the given model

  Parameters:

  object - The model to create links for

• abstract void links(java.util.Map model, java.lang.Object paginationObject, java.lang.Number total)

  Creates HAL links for the given model and pagination object

  Parameters:

  object - The model to create links for

• abstract void paginate(java.lang.Object object, java.lang.Integer total)

  Pagination support which outputs hal links to the resulting pages

  Parameters:

  object - The object to create links for

  total - The total number of objects to be paginated

• abstract void paginate(java.lang.Object object, java.lang.Integer total, java.lang.Integer offset)

  Pagination support which outputs hal links to the resulting pages

  Parameters:

  object - The object to create links for

  total - The total number of objects to be paginated

  offset - The numerical offset where the page starts (defaults to 0)

• abstract void paginate(java.lang.Object object, java.lang.Integer total, java.lang.Integer offset, java.lang.Integer max)

  Pagination support which outputs hal links to the resulting pages

  Parameters:

  object - The object to create links for

  total - The total number of objects to be paginated

  offset - The numerical offset where the page starts (defaults to 0)

  max - The maximum number of objects to be shown (defaults to 10)

• abstract void paginate(java.lang.Object object, java.lang.Integer total, java.lang.Integer offset, java.lang.Integer max, java.lang.String sort)

  Pagination support which outputs hal links to the resulting pages

  Parameters:

  object - The object to create links for

  total - The total number of objects to be paginated

  offset - The numerical offset where the page starts (defaults to 0)

  max - The maximum number of objects to be shown (defaults to 10)

  sort - The field to sort on (defaults to null)

• abstract void paginate(java.lang.Object object, java.lang.Integer total, java.lang.Integer offset, java.lang.Integer max, java.lang.String sort, java.lang.String order)

  Pagination support which outputs hal links to the resulting pages

  Parameters:

  object - The object to create links for

  total - The total number of objects to be paginated

  offset - The numerical offset where the page starts (defaults to 0)

  max - The maximum number of objects to be shown (defaults to 10)

  sort - The field to sort on (defaults to null)

  order - The order in which the results are to be sorted eg: DESC or ASC

• abstract JsonWritable render(java.lang.Object object, java.util.Map arguments, @groovy.lang.DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate) groovy.lang.Closure customizer)

  Same as GrailsJsonViewHelper.render but renders HAL links too

• abstract JsonWritable render(java.lang.Object object, java.util.Map arguments)

  Same as GrailsJsonViewHelper.render but renders HAL links too

• abstract JsonWritable render(java.lang.Object object, @groovy.lang.DelegatesTo(value: StreamingJsonBuilder.StreamingJsonDelegate) groovy.lang.Closure customizer)

  Same as GrailsJsonViewHelper.render but renders HAL links too

• abstract JsonWritable render(java.lang.Object object)

  Same as GrailsJsonViewHelper.render but renders HAL links too

• abstract void setDelegate(StreamingJsonDelegate jsonDelegate)

• abstract void type(java.lang.String name)

  Parameters:

  name - Sets the HAL response type