Package org.labkey.remoteapi.assay

Class SaveAssayBatchCommand

java.lang.Object

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

org.labkey.remoteapi.PostCommand<SaveAssayBatchResponse>

org.labkey.remoteapi.assay.SaveAssayBatchCommand

All Implemented Interfaces:

HasRequiredVersion

public class SaveAssayBatchCommand
extends PostCommand<SaveAssayBatchResponse>

Saves an assay batch on the server. If no batch or run ids are specified, new ones will be inserted. If they are specified, existing ones will be updated.

Nested Class Summary

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

Command.CommonParameters, Command.Response

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SAMPLE_DERIVATION_PROTOCOL

Fields inherited from class org.labkey.remoteapi.Command

CONTENT_TYPE_JSON

Constructor Summary

Constructors

Constructor	Description
SaveAssayBatchCommand(int assayId)
SaveAssayBatchCommand(int assayId, Batch batch)
SaveAssayBatchCommand(String protocolName, Batch batch)

Method Summary

Modifier and Type	Method	Description
protected SaveAssayBatchResponse	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.
org.json.JSONObject	getJsonObject()	Returns the JSON object to post or null for no JSON.

Methods inherited from class org.labkey.remoteapi.PostCommand

createRequest

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

Field Details

SAMPLE_DERIVATION_PROTOCOL

public static final String SAMPLE_DERIVATION_PROTOCOL

See Also:

• Constant Field Values

Constructor Details

SaveAssayBatchCommand

public SaveAssayBatchCommand(int assayId)

Parameters:

assayId - the id of the assay definition on the web server

SaveAssayBatchCommand

public SaveAssayBatchCommand(int assayId,
 Batch batch)

Parameters:

assayId - the id of the assay definition on the web server

batch - the batch object to be saved

SaveAssayBatchCommand

public SaveAssayBatchCommand(String protocolName,
 Batch batch)

Parameters:

protocolName - the name of the protocol to use for non-assay backed runs

batch - the batch object to be saved

Method Details

getJsonObject

public org.json.JSONObject getJsonObject()

Description copied from class: PostCommand

Returns the JSON object to post or null for no JSON. Override this method to provide parameters as JSON.

Overrides:

getJsonObject in class PostCommand<SaveAssayBatchResponse>

Returns:

The JSON object to post.

createResponse

protected SaveAssayBatchResponse 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<SaveAssayBatchResponse,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.