TempDataResourceController (collectory-hub 2.0 API)

au.org.ala.collectory.TempDataResourceController

All interactions with Temp Data Resource collectory instance is done through this controller. Actions like listing all Temp Data Resources and a list of user uploaded Temp Data Resources is added here. This controller can view, edit and delete a Temp Data Resource. It can create a Data resource from a Temp Data Resource.

Properties Summary

Properties
Type	Name and description
`au.org.ala.web.AuthService`	`authService`
`BiocacheRestService`	`biocacheRestService`
`CollectoryHubJenkinsService`	`collectoryHubJenkinsService`
`CollectoryHubRestService`	`collectoryHubRestService`
`FormatService`	`formatService`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.Object`	`adminChartOptions()`
	`java.lang.Object`	`adminList()` List all temp data resources uploaded by this system.
	`java.lang.Object`	`chartOptions()` Retrieves data set chart configuration
	`java.lang.Object`	`createDr()` Test run a production ready dataset.
	`java.lang.Object`	`decline()` Decline a submitted temp data resource.
	`java.lang.Object`	`delete()` This function checks the status of a temp data resource before permitting a delete.
	`java.lang.Object`	`editMetadata()` Edit a temp data resource's metadata.
	`java.lang.Object`	`error()` error page
	`java.lang.Object`	`loadToProduction()` Webservice to load a temp data resource to production.
	`java.lang.Object`	`myData()` List user uploaded data sets.
	`java.lang.Object`	`notAuthorised()`
	`java.lang.Object`	`reload()` This function checks the status of a temp data resource before permitting a reload.
	`java.lang.Object`	`resetStatus()` Test run a production ready dataset.
	`java.lang.Object`	`saveChartOptions()` Save new data set chart configuration @return
	`java.lang.Object`	`saveTempDataResource()` Save dataset metadata.
	`java.lang.Object`	`submitDataForReview()` Submit a temp data resource for review.
	`java.lang.Object`	`testRun()` Test run a production ready dataset.
	`java.lang.Object`	`viewMetadata()` This function shows the metadata for a temp data resource.

Inherited Methods Summary

Inherited Methods
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()`

- Property Detail
  - au.org.ala.web.AuthService authService
  - BiocacheRestService biocacheRestService
  - CollectoryHubJenkinsService collectoryHubJenkinsService
  - CollectoryHubRestService collectoryHubRestService
  - FormatService formatService
- Method Detail
  - java.lang.Object adminChartOptions()
  - @au.org.ala.web.AlaSecured(value = "ROLE_ADMIN", redirectController = "tempDataResource", redirectAction = "notAuthorised") java.lang.Object adminList()
    
    List all temp data resources uploaded by this system.
    Returns:
  - java.lang.Object chartOptions()
    
    Retrieves data set chart configuration
  - @au.org.ala.web.AlaSecured(value = "ROLE_ADMIN", redirectController = 'tempDataResource', redirectAction = 'myData') java.lang.Object createDr()
    
    Test run a production ready dataset.
    params:
    uid - drt id
    params:
  - @au.org.ala.web.AlaSecured(value = "ROLE_ADMIN", redirectController = "tempDataResource", redirectAction = "notAuthorised") java.lang.Object decline()
    
    Decline a submitted temp data resource. This function will update the status of the temp data resource to declined.
    params:
    uid - drt id
    
    Returns:
  - @au.org.ala.web.AlaSecured(value = "ROLE_USER", redirectController = "tempDataResource", redirectAction = "notAuthorised") java.lang.Object delete()
    
    This function checks the status of a temp data resource before permitting a delete. When temp data resource is submitted for review, no change is permitted to the data or metadata. This is a proxy action to the actual delete function. This function was created to do some additional checks before redirecting to the actual delete action.
    params:
    uid - required - drt id
    
    Returns:
  - @au.org.ala.web.AlaSecured(value = "ROLE_USER", redirectController = "tempDataResource", redirectAction = "notAuthorised") java.lang.Object editMetadata()
    
    Edit a temp data resource's metadata.
    params:
    uid - drt id
    
    Returns:
  - java.lang.Object error()
    
    error page
  - @au.org.ala.web.AlaSecured(value = "ROLE_ADMIN", redirectController = "tempDataResource", redirectAction = "notAuthorised") java.lang.Object loadToProduction()
    
    Webservice to load a temp data resource to production. This will create data resource from temp data resource. Then issue Jenkins job to load it into production.
    params:
    uid - drt id
    
    Returns:
  - java.lang.Object myData()
    
    List user uploaded data sets.
    Returns:
  - java.lang.Object notAuthorised()
  - @au.org.ala.web.AlaSecured(value = "ROLE_USER", redirectController = "tempDataResource", redirectAction = "notAuthorised") java.lang.Object reload()
    
    This function checks the status of a temp data resource before permitting a reload. When temp data resource is submitted for review, no change is permitted to the data or metadata. This is a proxy action to the actual reload function. This function was created to do some additional checks before redirecting to the actual reload action.
    params:
    uid - required - drt id
    
    Returns:
  - @au.org.ala.web.AlaSecured(value = "ROLE_ADMIN", redirectController = 'tempDataResource', redirectAction = 'myData') java.lang.Object resetStatus()
    
    Test run a production ready dataset.
    params:
    uid - drt id
    params:
  - java.lang.Object saveChartOptions()
    
    Save new data set chart configuration
    Returns:
  - @au.org.ala.web.AlaSecured(value = "ROLE_USER", redirectController = "tempDataResource", redirectAction = "notAuthorised") java.lang.Object saveTempDataResource()
    
    Save dataset metadata. Metadata edit form posts to this action.
    params:
    uid - required - drt id
    
    Returns:
  - @au.org.ala.web.AlaSecured(value = "ROLE_USER", redirectController = "tempDataResource", redirectAction = "notAuthorised") java.lang.Object submitDataForReview()
    
    Submit a temp data resource for review. This method changes the status to submitted. Only owner of a data resource can call this action.
    Returns:
  - @au.org.ala.web.AlaSecured(value = "ROLE_ADMIN", redirectController = 'tempDataResource', redirectAction = 'myData') java.lang.Object testRun()
    
    Test run a production ready dataset.
    params:
    uid - drt id
    params:
  - @au.org.ala.web.AlaSecured(value = "ROLE_USER", redirectController = "tempDataResource", redirectAction = "notAuthorised") java.lang.Object viewMetadata()
    
    This function shows the metadata for a temp data resource.
    params:
    uid - drt id
    
    Returns:

Summary:
Property
Method

| Detail:
Property
Method

Groovy Documentation

[Groovy] Class TempDataResourceController

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

au.org.ala.web.AuthService authService

BiocacheRestService biocacheRestService

CollectoryHubJenkinsService collectoryHubJenkinsService

CollectoryHubRestService collectoryHubRestService

FormatService formatService

Method Detail

java.lang.Object adminChartOptions()

@au.org.ala.web.AlaSecured(value = "ROLE_ADMIN", redirectController = "tempDataResource", redirectAction = "notAuthorised") java.lang.Object adminList()

java.lang.Object chartOptions()

@au.org.ala.web.AlaSecured(value = "ROLE_ADMIN", redirectController = 'tempDataResource', redirectAction = 'myData') java.lang.Object createDr()

@au.org.ala.web.AlaSecured(value = "ROLE_ADMIN", redirectController = "tempDataResource", redirectAction = "notAuthorised") java.lang.Object decline()

@au.org.ala.web.AlaSecured(value = "ROLE_USER", redirectController = "tempDataResource", redirectAction = "notAuthorised") java.lang.Object delete()

@au.org.ala.web.AlaSecured(value = "ROLE_USER", redirectController = "tempDataResource", redirectAction = "notAuthorised") java.lang.Object editMetadata()

java.lang.Object error()

@au.org.ala.web.AlaSecured(value = "ROLE_ADMIN", redirectController = "tempDataResource", redirectAction = "notAuthorised") java.lang.Object loadToProduction()

java.lang.Object myData()

java.lang.Object notAuthorised()

@au.org.ala.web.AlaSecured(value = "ROLE_USER", redirectController = "tempDataResource", redirectAction = "notAuthorised") java.lang.Object reload()

@au.org.ala.web.AlaSecured(value = "ROLE_ADMIN", redirectController = 'tempDataResource', redirectAction = 'myData') java.lang.Object resetStatus()

java.lang.Object saveChartOptions()

@au.org.ala.web.AlaSecured(value = "ROLE_USER", redirectController = "tempDataResource", redirectAction = "notAuthorised") java.lang.Object saveTempDataResource()

@au.org.ala.web.AlaSecured(value = "ROLE_USER", redirectController = "tempDataResource", redirectAction = "notAuthorised") java.lang.Object submitDataForReview()

@au.org.ala.web.AlaSecured(value = "ROLE_ADMIN", redirectController = 'tempDataResource', redirectAction = 'myData') java.lang.Object testRun()

@au.org.ala.web.AlaSecured(value = "ROLE_USER", redirectController = "tempDataResource", redirectAction = "notAuthorised") java.lang.Object viewMetadata()