public interface IPublix
Modifier and Type | Method and Description |
---|---|
play.mvc.Result |
abortStudy(play.mvc.Http.Request request,
StudyResult studyResult,
java.lang.String message)
HTTP type: GET request
Aborts the study run (StudyResult state will be ABORTED).
|
play.mvc.Result |
downloadResultFile(play.mvc.Http.Request request,
StudyResult studyResult,
java.lang.String filename,
java.lang.String componentId)
HTTP type: GET request
Downloads a result file that was previously uploded.
|
play.mvc.Result |
finishStudy(play.mvc.Http.Request request,
StudyResult studyResult,
java.lang.Boolean successful,
java.lang.String message)
HTTP type: GET request
Finishes the study run (StudyResult state will be FINISHED or FAIL).
|
play.mvc.Result |
getInitData(play.mvc.Http.Request request,
StudyResult studyResult,
Component component)
HTTP type: GET request
Returns the init data provided by jatos.js to the experimenters code: study's properties, component's properties,
and study's session data.
|
play.mvc.Result |
heartbeat(play.mvc.Http.Request request,
StudyResult studyResult)
HTTP type: POST request
Heartbeat of a study result: used to give the user an idea of when the study run was last seen.
|
play.mvc.Result |
log(play.mvc.Http.Request request,
StudyResult studyResult,
Component component)
HTTP type: POST request
With this method the client side can log into the server's log.
|
play.mvc.Result |
setStudySessionData(play.mvc.Http.Request request,
StudyResult studyResult)
HTTP type: POST request
Expects the study's session data in JSON format and sets them in the study result that belong to the specified
study.
|
play.mvc.Result |
startComponent(play.mvc.Http.Request request,
StudyResult studyResult,
Component component,
java.lang.String message)
HTTP type: GET request
Starts the component
|
play.mvc.Result |
startStudy(play.mvc.Http.Request request,
StudyLink studyLink)
HTTP type: GET request
Starts the study.
|
play.mvc.Result |
submitOrAppendResultData(play.mvc.Http.Request request,
StudyResult studyResult,
Component component,
boolean append)
HTTP type: PUT/POST request
Persists the submitted data in the ComponentResult specified by the given study and component ID.
|
play.mvc.Result |
uploadResultFile(play.mvc.Http.Request request,
StudyResult studyResult,
Component component,
java.lang.String filename)
HTTP type: POST request
Uploads a result file
|
play.mvc.Result startStudy(play.mvc.Http.Request request, StudyLink studyLink) throws PublixException
PublixException
play.mvc.Result startComponent(play.mvc.Http.Request request, StudyResult studyResult, Component component, java.lang.String message) throws PublixException
PublixException
play.mvc.Result getInitData(play.mvc.Http.Request request, StudyResult studyResult, Component component) throws PublixException, java.io.IOException
PublixException
java.io.IOException
play.mvc.Result setStudySessionData(play.mvc.Http.Request request, StudyResult studyResult) throws PublixException
PublixException
play.mvc.Result heartbeat(play.mvc.Http.Request request, StudyResult studyResult) throws PublixException
PublixException
play.mvc.Result submitOrAppendResultData(play.mvc.Http.Request request, StudyResult studyResult, Component component, boolean append) throws PublixException
PublixException
play.mvc.Result uploadResultFile(play.mvc.Http.Request request, StudyResult studyResult, Component component, java.lang.String filename) throws PublixException
PublixException
play.mvc.Result downloadResultFile(play.mvc.Http.Request request, StudyResult studyResult, java.lang.String filename, java.lang.String componentId) throws PublixException
PublixException
play.mvc.Result abortStudy(play.mvc.Http.Request request, StudyResult studyResult, java.lang.String message) throws PublixException
PublixException
play.mvc.Result finishStudy(play.mvc.Http.Request request, StudyResult studyResult, java.lang.Boolean successful, java.lang.String message) throws PublixException
PublixException
play.mvc.Result log(play.mvc.Http.Request request, StudyResult studyResult, Component component) throws PublixException
PublixException