Package org.labkey.remoteapi.assay

Class ImportRunCommand

java.lang.Object

org.labkey.remoteapi.Command<ResponseType,org.apache.hc.client5.http.classic.methods.HttpPost>

org.labkey.remoteapi.PostCommand<ImportRunResponse>

org.labkey.remoteapi.assay.ImportRunCommand

All Implemented Interfaces:

HasRequiredVersion

public class ImportRunCommand
extends PostCommand<ImportRunResponse>

Import a new assay run. If no batch is specified, a new batch will be inserted.

Nested Class Summary

Nested classes/interfaces inherited from class org.labkey.remoteapi.Command

Command.CommonParameters, Command.Response

Field Summary

Fields inherited from class org.labkey.remoteapi.Command

CONTENT_TYPE_JSON

Constructor Summary

Constructors

Constructor	Description
ImportRunCommand(int assayId)
ImportRunCommand(int assayId, File file)
ImportRunCommand(int assayId, List<Map<String,Object>> dataRows)

Method Summary

Modifier and Type	Method	Description
protected org.apache.hc.client5.http.classic.methods.HttpPost	createRequest(URI uri)	Creates the HttpPost instance used for the request.
protected ImportRunResponse	createResponse(String text, int status, String contentType, org.json.JSONObject json)	Creates an instance of the response class, initialized with the response text, the HTTP status code, and parsed JSONObject.
void	setAuditUserComment(String auditUserComment)
void	setBatchId(int batchId)
void	setBatchProperties(Map<String,Object> batchProperties)
void	setComment(String comment)
void	setFile(File file)
void	setName(String name)
void	setPlateMetadata(org.json.JSONObject plateMetadata)
void	setProperties(Map<String,Object> properties)
void	setRunFilePath(String runFilePath)	Absolute or relative path to assay data file to be imported.
void	setUseJson(boolean useJson)

Methods inherited from class org.labkey.remoteapi.PostCommand

getJsonObject

Methods inherited from class org.labkey.remoteapi.Command

_execute, createParameterMap, execute, getActionName, getControllerName, getHttpRequest, getParameters, getParamValueAsString, getRequiredVersion, getTimeout, setRequiredVersion, setTimeout

Methods inherited from class java.lang.Object

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

Constructor Details

ImportRunCommand

public ImportRunCommand(int assayId)

ImportRunCommand

public ImportRunCommand(int assayId,
 File file)

ImportRunCommand

public ImportRunCommand(int assayId,
 List<Map<String,Object>> dataRows)

Method Details

setUseJson

public void setUseJson(boolean useJson)

setName

public void setName(String name)

setComment

public void setComment(String comment)

setFile

public void setFile(File file)

setRunFilePath

public void setRunFilePath(String runFilePath)

Absolute or relative path to assay data file to be imported. The file must exist under the file or pipeline root of the container.

Parameters:

runFilePath - the data file path

setProperties

public void setProperties(Map<String,Object> properties)

setBatchId

public void setBatchId(int batchId)

setBatchProperties

public void setBatchProperties(Map<String,Object> batchProperties)

setPlateMetadata

public void setPlateMetadata(org.json.JSONObject plateMetadata)

setAuditUserComment

public void setAuditUserComment(String auditUserComment)

createResponse

protected ImportRunResponse createResponse(String text,
 int status,
 String contentType,
 org.json.JSONObject json)

Description copied from class: Command

Creates an instance of the response class, initialized with the response text, the HTTP status code, and parsed JSONObject.

Override this method to create an instance of a different class that extends CommandResponse

Overrides:

createResponse in class Command<ImportRunResponse,org.apache.hc.client5.http.classic.methods.HttpPost>

Parameters:

text - The response text from the server.

status - The HTTP status code.

contentType - The Content-Type header value.

json - The parsed JSONObject (or null if no JSON was returned).

Returns:

An instance of the response object.

createRequest

protected org.apache.hc.client5.http.classic.methods.HttpPost createRequest(URI uri)

Description copied from class: PostCommand

Creates the HttpPost instance used for the request. Override to modify the HttpPost object before use or to send something other than JSON in the post body. In your override, create the HttpPost and set the request entity appropriately.

Overrides:

createRequest in class PostCommand<ImportRunResponse>

Parameters:

uri - the uri to convert

Returns:

The PostMethod object.