controllers.gui

Class Studies

java.lang.Object

play.mvc.Results

play.mvc.Controller

controllers.gui.Studies

All Implemented Interfaces:

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

@Singleton
public class Studies
extends play.mvc.Controller

Controller for all actions regarding studies 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	addAllMemberUsers(java.lang.Long studyId) POST request that adds all users as members to a study
play.mvc.Result	changeComponentOrder(java.lang.Long studyId, java.lang.Long componentId, java.lang.String newPosition) POST request to change the oder of components within a study.
play.mvc.Result	cloneStudy(java.lang.Long studyId) GET request to clones a study.
play.mvc.Result	memberUsers(java.lang.Long studyId) GET request that gets all users and whether they are admin of this study as a JSON array.
play.mvc.Result	properties(java.lang.Long studyId) GET request that returns the study properties as JSON.
play.mvc.Result	remove(java.lang.Long studyId) DELETE request to remove a study
play.mvc.Result	removeAllMemberUsers(java.lang.Long studyId) DELETE request that removes all member users from a study
play.mvc.Result	runStudy(play.mvc.Http.Request request, java.lang.Long studyId, java.lang.Long batchId) Runs the whole study.
play.mvc.Result	study(java.lang.Long studyId)
play.mvc.Result	study(java.lang.Long studyId, int httpStatus) Shows the study view with details of a study components and so on.
play.mvc.Result	submitCreated() POST request to create a new study.
play.mvc.Result	submitEdited(java.lang.Long studyId) POST request to update study properties
play.mvc.Result	tableDataByStudy(java.lang.Long studyId) GET request that returns all component data of the given study as JSON.
play.mvc.Result	toggleActive(java.lang.Long studyId, java.lang.Boolean active) POST request to activate or deactivate a study.
play.mvc.Result	toggleLock(java.lang.Long studyId) POST request to swap the locked field of a study.
play.mvc.Result	toggleMemberUser(java.lang.Long studyId, java.lang.String username, boolean isMember) POST request that adds or removes a member user from a study

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

study

public play.mvc.Result study(java.lang.Long studyId,
                             int httpStatus)
                      throws JatosGuiException

Shows the study view with details of a study components and so on.

Throws:

JatosGuiException

study

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

Throws:

JatosGuiException

submitCreated

public play.mvc.Result submitCreated()

POST request to create a new study.

properties

public play.mvc.Result properties(java.lang.Long studyId)
                           throws ForbiddenException,
                                  NotFoundException

GET request that returns the study properties as JSON.

Throws:

ForbiddenException

NotFoundException

submitEdited

public play.mvc.Result submitEdited(java.lang.Long studyId)
                             throws ForbiddenException,
                                    NotFoundException

POST request to update study properties

Throws:

ForbiddenException

NotFoundException

toggleLock

public play.mvc.Result toggleLock(java.lang.Long studyId)
                           throws JatosGuiException,
                                  ForbiddenException,
                                  NotFoundException

POST request to swap the locked field of a study.

Throws:

JatosGuiException

ForbiddenException

NotFoundException

toggleActive

public play.mvc.Result toggleActive(java.lang.Long studyId,
                                    java.lang.Boolean active)

POST request to activate or deactivate a study. Can be done only by an admin.

remove

public play.mvc.Result remove(java.lang.Long studyId)
                       throws JatosGuiException,
                              ForbiddenException,
                              NotFoundException,
                              java.io.IOException

DELETE request to remove a study

Throws:

JatosGuiException

ForbiddenException

NotFoundException

java.io.IOException

cloneStudy

public play.mvc.Result cloneStudy(java.lang.Long studyId)
                           throws JatosGuiException,
                                  ForbiddenException,
                                  NotFoundException,
                                  java.io.IOException

GET request to clones a study.

Throws:

JatosGuiException

ForbiddenException

NotFoundException

java.io.IOException

memberUsers

public play.mvc.Result memberUsers(java.lang.Long studyId)
                            throws JatosGuiException,
                                   ForbiddenException,
                                   NotFoundException

GET request that gets all users and whether they are admin of this study as a JSON array.

Throws:

JatosGuiException

ForbiddenException

NotFoundException

toggleMemberUser

public play.mvc.Result toggleMemberUser(java.lang.Long studyId,
                                        java.lang.String username,
                                        boolean isMember)
                                 throws ForbiddenException,
                                        NotFoundException

POST request that adds or removes a member user from a study

Throws:

ForbiddenException

NotFoundException

addAllMemberUsers

public play.mvc.Result addAllMemberUsers(java.lang.Long studyId)
                                  throws ForbiddenException,
                                         NotFoundException

POST request that adds all users as members to a study

Throws:

ForbiddenException

NotFoundException

removeAllMemberUsers

public play.mvc.Result removeAllMemberUsers(java.lang.Long studyId)
                                     throws ForbiddenException,
                                            NotFoundException

DELETE request that removes all member users from a study

Throws:

ForbiddenException

NotFoundException

changeComponentOrder

public play.mvc.Result changeComponentOrder(java.lang.Long studyId,
                                            java.lang.Long componentId,
                                            java.lang.String newPosition)
                                     throws JatosGuiException,
                                            ForbiddenException,
                                            NotFoundException,
                                            BadRequestException

POST request to change the oder of components within a study.

Throws:

JatosGuiException

ForbiddenException

NotFoundException

BadRequestException

runStudy

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

Runs the whole study. Uses a JatosWorker and the given batch. Redirects to /publix/studyCode.

Throws:

JatosGuiException

NotFoundException

ForbiddenException

tableDataByStudy

public play.mvc.Result tableDataByStudy(java.lang.Long studyId)
                                 throws JatosGuiException,
                                        ForbiddenException,
                                        NotFoundException

GET request that returns all component data of the given study as JSON.

Throws:

JatosGuiException

ForbiddenException

NotFoundException