controllers.gui

Class StudyLinks

java.lang.Object

play.mvc.Results

play.mvc.Controller

controllers.gui.StudyLinks

All Implemented Interfaces:

play.mvc.Http.HeaderNames, play.mvc.Http.Status

@Singleton
public class StudyLinks
extends play.mvc.Controller

Controller for all actions regarding study links, batches, and workers within the JATOS GUI.

Field Summary

Fields inherited from interface play.mvc.Http.Status

ACCEPTED, BAD_GATEWAY, BAD_REQUEST, CONFLICT, CONTINUE, CREATED, EXPECTATION_FAILED, FAILED_DEPENDENCY, FORBIDDEN, FOUND, GATEWAY_TIMEOUT, GONE, HTTP_VERSION_NOT_SUPPORTED, IM_A_TEAPOT, INSUFFICIENT_STORAGE, INTERNAL_SERVER_ERROR, LENGTH_REQUIRED, LOCKED, METHOD_NOT_ALLOWED, MOVED_PERMANENTLY, MULTI_STATUS, MULTIPLE_CHOICES, NETWORK_AUTHENTICATION_REQUIRED, NO_CONTENT, NON_AUTHORITATIVE_INFORMATION, NOT_ACCEPTABLE, NOT_FOUND, NOT_IMPLEMENTED, NOT_MODIFIED, OK, PARTIAL_CONTENT, PAYMENT_REQUIRED, PERMANENT_REDIRECT, PRECONDITION_FAILED, PRECONDITION_REQUIRED, PROXY_AUTHENTICATION_REQUIRED, REQUEST_ENTITY_TOO_LARGE, REQUEST_HEADER_FIELDS_TOO_LARGE, REQUEST_TIMEOUT, REQUEST_URI_TOO_LONG, REQUESTED_RANGE_NOT_SATISFIABLE, RESET_CONTENT, SEE_OTHER, SERVICE_UNAVAILABLE, SWITCHING_PROTOCOLS, TEMPORARY_REDIRECT, TOO_MANY_REQUESTS, UNAUTHORIZED, UNPROCESSABLE_ENTITY, UNSUPPORTED_MEDIA_TYPE, UPGRADE_REQUIRED, USE_PROXY

Fields inherited from interface play.mvc.Http.HeaderNames

ACCEPT, ACCEPT_CHARSET, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ACCEPT_RANGES, ACCESS_CONTROL_ALLOW_CREDENTIALS, ACCESS_CONTROL_ALLOW_HEADERS, ACCESS_CONTROL_ALLOW_METHODS, ACCESS_CONTROL_ALLOW_ORIGIN, ACCESS_CONTROL_EXPOSE_HEADERS, ACCESS_CONTROL_MAX_AGE, ACCESS_CONTROL_REQUEST_HEADERS, ACCESS_CONTROL_REQUEST_METHOD, AGE, ALLOW, AUTHORIZATION, CACHE_CONTROL, CONNECTION, CONTENT_DISPOSITION, CONTENT_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_LOCATION, CONTENT_MD5, CONTENT_RANGE, CONTENT_SECURITY_POLICY, CONTENT_SECURITY_POLICY_REPORT_ONLY, CONTENT_TRANSFER_ENCODING, CONTENT_TYPE, COOKIE, DATE, ETAG, EXPECT, EXPIRES, FORWARDED, FROM, HOST, IF_MATCH, IF_MODIFIED_SINCE, IF_NONE_MATCH, IF_RANGE, IF_UNMODIFIED_SINCE, LAST_MODIFIED, LINK, LOCATION, MAX_FORWARDS, ORIGIN, PRAGMA, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, RANGE, REFERER, REFERRER_POLICY, RETRY_AFTER, SERVER, SET_COOKIE, SET_COOKIE2, STRICT_TRANSPORT_SECURITY, TE, TRAILER, TRANSFER_ENCODING, UPGRADE, USER_AGENT, VARY, VIA, WARNING, WWW_AUTHENTICATE, X_CONTENT_SECURITY_POLICY_NONCE_HEADER, X_CONTENT_TYPE_OPTIONS, X_FORWARDED_FOR, X_FORWARDED_HOST, X_FORWARDED_PORT, X_FORWARDED_PROTO, X_FRAME_OPTIONS, X_PERMITTED_CROSS_DOMAIN_POLICIES, X_REQUESTED_WITH, X_XSS_PROTECTION

Method Summary

Modifier and Type	Method and Description
play.mvc.Result	batchById(java.lang.Long studyId, java.lang.Long batchId) GET request that returns Batch data belonging to the given study as JSON.
play.mvc.Result	batchesByStudy(java.lang.Long studyId) GET request that returns the data of all Batches of the given study as JSON.
play.mvc.Result	batchProperties(java.lang.Long studyId, java.lang.Long batchId) GET request that returns Batch properties as JSON
play.mvc.Result	batchSessionData(java.lang.Long studyId, java.lang.Long batchId) GET request that returns the batch session data as String
play.mvc.Result	createGeneralRun(java.lang.Long studyId, java.lang.Long batchId, java.lang.String workerType) GET request that returns a study code for the given worker type (possible types are GeneralMultipleWorker, GeneralSingleWorker, MTWorker).
play.mvc.Result	createPersonalRun(play.mvc.Http.Request request, java.lang.Long studyId, java.lang.Long batchId, java.lang.String workerType) POST request that creates either Personal Single or Personal Multiple study links and their corresponding workers.
play.mvc.Result	groupsByBatch(java.lang.Long studyId, java.lang.Long batchId) GET request that returns data of all groups that belong to the given batch as JSON
play.mvc.Result	groupSessionData(java.lang.Long studyId, java.lang.Long groupResultId) GET request that returns the group session data as String
play.mvc.Result	removeBatch(java.lang.Long studyId, java.lang.Long batchId) DELETE request to remove a Batch
play.mvc.Result	studyLinks(play.mvc.Http.Request request, java.lang.Long studyId) GET request to get the Study Links page
play.mvc.Result	studyLinksData(java.lang.Long studyId, java.lang.Long batchId, java.lang.String workerType) GET request that returns a JSON object used in the Study Links page to fill the study links table for the Personal type workers
play.mvc.Result	studyLinksSetupData(java.lang.Long studyId, java.lang.Long batchId) GET request that returns a JSON object use in the Study Links page with a list of data aggregated from StudyLink, Worker and Batch
play.mvc.Result	submitCreatedBatch(play.mvc.Http.Request request, java.lang.Long studyId) POST request to submit a newly created Batch
play.mvc.Result	submitEditedBatchProperties(play.mvc.Http.Request request, java.lang.Long studyId, java.lang.Long batchId) POST request to submit changed Batch properties
play.mvc.Result	submitEditedBatchSessionData(play.mvc.Http.Request request, java.lang.Long studyId, java.lang.Long batchId) POST request to submit changed batch session data
play.mvc.Result	submitEditedGroupSessionData(play.mvc.Http.Request request, java.lang.Long studyId, java.lang.Long groupResultId) POST request to submit changed group session data
play.mvc.Result	toggleAllowedWorkerType(java.lang.Long studyId, java.lang.Long batchId, java.lang.String workerType, java.lang.Boolean allow) POST request to allow or deny a worker type in a batch.
play.mvc.Result	toggleBatchActive(java.lang.Long studyId, java.lang.Long batchId, java.lang.Boolean active) POST request to toggle the property 'active' of the given batch.
play.mvc.Result	toggleGroupFixed(java.lang.Long studyId, java.lang.Long groupResultId, boolean fixed) GET request to toggle the group state FIXED / STARTED
play.mvc.Result	toggleStudyLinkActive(java.lang.Long studyId, java.lang.Long batchId, java.lang.String studyCode, java.lang.Boolean active) POST request to change the property 'active' of a StudyLink.

Methods inherited from class play.mvc.Controller

changeLang, changeLang, clearLang, ctx, flash, flash, flash, lang, request, response, session, session, session, TODO, TODO

Methods inherited from class play.mvc.Results

badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, contentDispositionHeader, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, found, found, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, movedPermanently, movedPermanently, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, networkAuthenticationRequired, noContent, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, permanentRedirect, permanentRedirect, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, preconditionRequired, redirect, redirect, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, requestHeaderFieldsTooLarge, seeOther, seeOther, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, status, temporaryRedirect, temporaryRedirect, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, tooManyRequests, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

studyLinks

public play.mvc.Result studyLinks(play.mvc.Http.Request request,
                                  java.lang.Long studyId)
                           throws JatosGuiException

GET request to get the Study Links page

Throws:

JatosGuiException

batchById

public play.mvc.Result batchById(java.lang.Long studyId,
                                 java.lang.Long batchId)
                          throws JatosGuiException

GET request that returns Batch data belonging to the given study as JSON. It includes the count of its StudyResults and GroupResults.

Throws:

JatosGuiException

batchesByStudy

public play.mvc.Result batchesByStudy(java.lang.Long studyId)
                               throws JatosGuiException

GET request that returns the data of all Batches of the given study as JSON. It includes the count of their StudyResults, count of their GroupResults, and the count of their Workers.

Throws:

JatosGuiException

groupsByBatch

public play.mvc.Result groupsByBatch(java.lang.Long studyId,
                                     java.lang.Long batchId)
                              throws JatosGuiException

GET request that returns data of all groups that belong to the given batch as JSON

Throws:

JatosGuiException

submitCreatedBatch

public play.mvc.Result submitCreatedBatch(play.mvc.Http.Request request,
                                          java.lang.Long studyId)
                                   throws JatosGuiException

POST request to submit a newly created Batch

Throws:

JatosGuiException

batchSessionData

public play.mvc.Result batchSessionData(java.lang.Long studyId,
                                        java.lang.Long batchId)
                                 throws JatosGuiException

GET request that returns the batch session data as String

Throws:

JatosGuiException

groupSessionData

public play.mvc.Result groupSessionData(java.lang.Long studyId,
                                        java.lang.Long groupResultId)
                                 throws JatosGuiException

GET request that returns the group session data as String

Throws:

JatosGuiException

submitEditedBatchSessionData

public play.mvc.Result submitEditedBatchSessionData(play.mvc.Http.Request request,
                                                    java.lang.Long studyId,
                                                    java.lang.Long batchId)
                                             throws JatosGuiException

POST request to submit changed batch session data

Throws:

JatosGuiException

submitEditedGroupSessionData

public play.mvc.Result submitEditedGroupSessionData(play.mvc.Http.Request request,
                                                    java.lang.Long studyId,
                                                    java.lang.Long groupResultId)
                                             throws JatosGuiException

POST request to submit changed group session data

Throws:

JatosGuiException

toggleGroupFixed

public play.mvc.Result toggleGroupFixed(java.lang.Long studyId,
                                        java.lang.Long groupResultId,
                                        boolean fixed)
                                 throws JatosGuiException

GET request to toggle the group state FIXED / STARTED

Throws:

JatosGuiException

batchProperties

public play.mvc.Result batchProperties(java.lang.Long studyId,
                                       java.lang.Long batchId)
                                throws JatosGuiException

GET request that returns Batch properties as JSON

Throws:

JatosGuiException

submitEditedBatchProperties

public play.mvc.Result submitEditedBatchProperties(play.mvc.Http.Request request,
                                                   java.lang.Long studyId,
                                                   java.lang.Long batchId)
                                            throws JatosGuiException

POST request to submit changed Batch properties

Throws:

JatosGuiException

toggleBatchActive

public play.mvc.Result toggleBatchActive(java.lang.Long studyId,
                                         java.lang.Long batchId,
                                         java.lang.Boolean active)
                                  throws JatosGuiException

POST request to toggle the property 'active' of the given batch.

Throws:

JatosGuiException

toggleAllowedWorkerType

public play.mvc.Result toggleAllowedWorkerType(java.lang.Long studyId,
                                               java.lang.Long batchId,
                                               java.lang.String workerType,
                                               java.lang.Boolean allow)
                                        throws JatosGuiException

POST request to allow or deny a worker type in a batch.

Throws:

JatosGuiException

removeBatch

public play.mvc.Result removeBatch(java.lang.Long studyId,
                                   java.lang.Long batchId)
                            throws java.lang.Exception

DELETE request to remove a Batch

Throws:

java.lang.Exception

createPersonalRun

public play.mvc.Result createPersonalRun(play.mvc.Http.Request request,
                                         java.lang.Long studyId,
                                         java.lang.Long batchId,
                                         java.lang.String workerType)
                                  throws JatosGuiException

POST request that creates either Personal Single or Personal Multiple study links and their corresponding workers.

Throws:

JatosGuiException

createGeneralRun

public play.mvc.Result createGeneralRun(java.lang.Long studyId,
                                        java.lang.Long batchId,
                                        java.lang.String workerType)
                                 throws JatosGuiException

GET request that returns a study code for the given worker type (possible types are GeneralMultipleWorker, GeneralSingleWorker, MTWorker). This ID is used on the client side to generate the study link. Since for the 'General' workers only one study link is necessary per batch and worker type it only creates one if it is not already stored in the StudyLink table.

Throws:

JatosGuiException

studyLinksSetupData

public play.mvc.Result studyLinksSetupData(java.lang.Long studyId,
                                           java.lang.Long batchId)
                                    throws JatosGuiException

GET request that returns a JSON object use in the Study Links page with a list of data aggregated from StudyLink, Worker and Batch

Throws:

JatosGuiException

studyLinksData

public play.mvc.Result studyLinksData(java.lang.Long studyId,
                                      java.lang.Long batchId,
                                      java.lang.String workerType)
                               throws JatosGuiException

GET request that returns a JSON object used in the Study Links page to fill the study links table for the Personal type workers

Throws:

JatosGuiException

toggleStudyLinkActive

public play.mvc.Result toggleStudyLinkActive(java.lang.Long studyId,
                                             java.lang.Long batchId,
                                             java.lang.String studyCode,
                                             java.lang.Boolean active)
                                      throws JatosGuiException

POST request to change the property 'active' of a StudyLink.

Throws:

JatosGuiException