DownloadController (downloads-plugin 4.0.0 API)

au.org.ala.downloads.DownloadController

```
class DownloadController
extends java.lang.Object
```
Download controller TODO: use more meaningful method names in this controller!

Properties Summary

Properties
Type	Name and description
`java.lang.Object`	`authService`
`java.lang.Object`	`biocacheService`
`java.lang.Object`	`customiseService`
`static java.lang.Object`	`defaultAction`
`java.lang.Object`	`doiService`
`java.lang.Object`	`downloadService`
`grails.core.GrailsApplication`	`grailsApplication`
`grails.web.mapping.LinkGenerator`	`linkGenerator`
`java.lang.Object`	`utilityService`

Constructor Summary

Constructors
Constructor and description
`DownloadController ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.Object`	`confirm(DownloadParams downloadParams)` Confirmation page
	`java.lang.Object`	`doi()` View a download via it's DOI identifier (lookup)
	`java.lang.Object`	`fields()` Provides a human-readable version of the Biocache /ws/index/fields JSON data.
	`java.lang.Object`	`getDescription(java.lang.String id)` Display the description attribute for a download field (via it's ID)
	`java.lang.Object`	`myDownloads()` Paginated list of downloads for logged-in user
	`java.lang.Object`	`options1(DownloadParams downloadParams)` Initial download screen with options.
	`java.lang.Object`	`options2(DownloadParams downloadParams)` Action after initial download screen.
	`java.lang.Object`	`saveUserPrefs()` Remember the user's options for customise download page

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), 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()`

- Property Detail
  - java.lang.Object authService
  - java.lang.Object biocacheService
  - java.lang.Object customiseService
  - static java.lang.Object defaultAction
  - java.lang.Object doiService
  - java.lang.Object downloadService
  - grails.core.GrailsApplication grailsApplication
  - @org.springframework.beans.factory.annotation.Autowired grails.web.mapping.LinkGenerator linkGenerator
  - java.lang.Object utilityService
- Constructor Detail
  - DownloadController()
- Method Detail
  - java.lang.Object confirm(DownloadParams downloadParams)
    
    Confirmation page @return
    Parameters:
    downloadParams
  - java.lang.Object doi()
    
    View a download via it's DOI identifier (lookup) @return
  - java.lang.Object fields()
    
    Provides a human-readable version of the Biocache /ws/index/fields JSON data. Allows filtering and paginating of fields. @return
  - java.lang.Object getDescription(java.lang.String id)
    
    Display the description attribute for a download field (via it's ID) @return
    Parameters:
    id
  - java.lang.Object myDownloads()
    
    Paginated list of downloads for logged-in user @return
  - java.lang.Object options1(DownloadParams downloadParams)
    
    Initial download screen with options. @return
    Parameters:
    downloadParams
  - java.lang.Object options2(DownloadParams downloadParams)
    
    Action after initial download screen. Either redirects user to customise screen or to confirmation page & triggers download @return
    Parameters:
    downloadParams
  - java.lang.Object saveUserPrefs()
    
    Remember the user's options for customise download page @return

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class DownloadController

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.lang.Object authService

java.lang.Object biocacheService

java.lang.Object customiseService

static java.lang.Object defaultAction

java.lang.Object doiService

java.lang.Object downloadService

grails.core.GrailsApplication grailsApplication

@org.springframework.beans.factory.annotation.Autowired grails.web.mapping.LinkGenerator linkGenerator

java.lang.Object utilityService

Constructor Detail

DownloadController()

Method Detail

java.lang.Object confirm(DownloadParams downloadParams)

java.lang.Object doi()

java.lang.Object fields()

java.lang.Object getDescription(java.lang.String id)

java.lang.Object myDownloads()

java.lang.Object options1(DownloadParams downloadParams)

java.lang.Object options2(DownloadParams downloadParams)

java.lang.Object saveUserPrefs()