Package org.labkey.remoteapi.assay

Class LoadAssayBatchCommand

java.lang.Object

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

org.labkey.remoteapi.PostCommand<LoadAssayBatchResponse>

org.labkey.remoteapi.assay.LoadAssayBatchCommand

All Implemented Interfaces:

HasRequiredVersion

public class LoadAssayBatchCommand
extends PostCommand<LoadAssayBatchResponse>

Command for obtaining information about the current batch in a particular folder.

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
LoadAssayBatchCommand(String protocolName, int batchId)

Method Summary

Modifier and Type	Method	Description
protected LoadAssayBatchResponse	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.
Batch	getBatch()
int	getBatchId()
org.json.JSONObject	getJsonObject()	Returns the JSON object to post or null for no JSON.
String	getProtocolName()
void	setBatch(Batch batch)
void	setBatchId(int batchId)
void	setProtocolName(String protocolName)

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

Constructor Details

LoadAssayBatchCommand

public LoadAssayBatchCommand(String protocolName,
 int batchId)

Method Details

getBatch

public Batch getBatch()

setBatch

public void setBatch(Batch batch)

getProtocolName

public String getProtocolName()

setProtocolName

public void setProtocolName(String protocolName)

getBatchId

public int getBatchId()

setBatchId

public void setBatchId(int batchId)

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<LoadAssayBatchResponse>

Returns:

The JSON object to post.

createResponse

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