Package 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.ControllerController for all actions regarding studies within the JATOS GUI.
-
-
Field Summary
-
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
-
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
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description play.mvc.ResultaddAllMemberUsers(java.lang.Long studyId)POST request that adds all users as members to a studyplay.mvc.ResultchangeComponentOrder(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.ResultcloneStudy(java.lang.Long studyId)GET request to clones a study.play.mvc.ResultmemberUsers(java.lang.Long studyId)GET request that gets all users and whether they are admin of this study as a JSON array.play.mvc.Resultproperties(java.lang.Long studyId)GET request that returns the study properties as JSON.play.mvc.ResultremoveAllMemberUsers(java.lang.Long studyId)DELETE request that removes all member users from a studyplay.mvc.ResultrunStudy(play.mvc.Http.Request request, java.lang.Long studyId, java.lang.Long batchId, java.lang.Long frames, java.lang.Long hSplit, java.lang.Long vSplit)Runs the whole study.play.mvc.Resultstudy(play.mvc.Http.Request request, java.lang.Long studyId)play.mvc.Resultstudy(play.mvc.Http.Request request, java.lang.Long studyId, int httpStatus)Shows the study view with details of a study components and so on.play.mvc.ResultsubmitCreated()POST request to create a new study.play.mvc.ResultsubmitDescription(play.mvc.Http.Request request, java.lang.Long studyId)POST request to update study propertiesplay.mvc.ResultsubmitEdited(java.lang.Long studyId)POST request to update study propertiesplay.mvc.ResulttableDataByStudy(java.lang.Long studyId)GET request that returns all component data of the given study as JSON.play.mvc.ResulttoggleLock(java.lang.Long studyId)POST request to swap the locked field of a study.play.mvc.ResulttoggleMemberUser(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
-
-
-
-
Method Detail
-
study
public play.mvc.Result study(play.mvc.Http.Request request, java.lang.Long studyId, int httpStatus) throws JatosGuiExceptionShows the study view with details of a study components and so on.- Throws:
JatosGuiException
-
study
public play.mvc.Result study(play.mvc.Http.Request request, java.lang.Long studyId) throws JatosGuiException- Throws:
JatosGuiException
-
submitCreated
public play.mvc.Result submitCreated() throws java.io.IOException, ForbiddenExceptionPOST request to create a new study.- Throws:
java.io.IOExceptionForbiddenException
-
properties
public play.mvc.Result properties(java.lang.Long studyId) throws ForbiddenException, NotFoundExceptionGET request that returns the study properties as JSON.- Throws:
ForbiddenExceptionNotFoundException
-
submitEdited
public play.mvc.Result submitEdited(java.lang.Long studyId) throws ForbiddenException, NotFoundExceptionPOST request to update study properties- Throws:
ForbiddenExceptionNotFoundException
-
submitDescription
public play.mvc.Result submitDescription(play.mvc.Http.Request request, java.lang.Long studyId) throws ForbiddenException, NotFoundExceptionPOST request to update study properties- Throws:
ForbiddenExceptionNotFoundException
-
toggleLock
public play.mvc.Result toggleLock(java.lang.Long studyId) throws JatosGuiException, ForbiddenException, NotFoundExceptionPOST request to swap the locked field of a study.
-
cloneStudy
public play.mvc.Result cloneStudy(java.lang.Long studyId) throws JatosGuiException, ForbiddenException, NotFoundException, java.io.IOExceptionGET request to clones a study.- Throws:
JatosGuiExceptionForbiddenExceptionNotFoundExceptionjava.io.IOException
-
memberUsers
public play.mvc.Result memberUsers(java.lang.Long studyId) throws JatosGuiException, ForbiddenException, NotFoundExceptionGET request that gets all users and whether they are admin of this study as a JSON array.
-
toggleMemberUser
public play.mvc.Result toggleMemberUser(java.lang.Long studyId, java.lang.String username, boolean isMember) throws ForbiddenException, NotFoundExceptionPOST request that adds or removes a member user from a study- Throws:
ForbiddenExceptionNotFoundException
-
addAllMemberUsers
public play.mvc.Result addAllMemberUsers(java.lang.Long studyId) throws ForbiddenException, NotFoundExceptionPOST request that adds all users as members to a study- Throws:
ForbiddenExceptionNotFoundException
-
removeAllMemberUsers
public play.mvc.Result removeAllMemberUsers(java.lang.Long studyId) throws ForbiddenException, NotFoundExceptionDELETE request that removes all member users from a study- Throws:
ForbiddenExceptionNotFoundException
-
changeComponentOrder
public play.mvc.Result changeComponentOrder(java.lang.Long studyId, java.lang.Long componentId, java.lang.String newPosition) throws JatosGuiException, ForbiddenException, NotFoundException, BadRequestExceptionPOST request to change the oder of components within a study.
-
runStudy
public play.mvc.Result runStudy(play.mvc.Http.Request request, java.lang.Long studyId, java.lang.Long batchId, java.lang.Long frames, java.lang.Long hSplit, java.lang.Long vSplit) throws NotFoundException, ForbiddenExceptionRuns the whole study. Can run the study in mulitple frames in parallel. Uses a JatosWorker and the given batch. Redirects to /publix/runx.- Throws:
NotFoundExceptionForbiddenException
-
tableDataByStudy
public play.mvc.Result tableDataByStudy(java.lang.Long studyId) throws JatosGuiException, ForbiddenException, NotFoundExceptionGET request that returns all component data of the given study as JSON.
-
-