Package org.labkey.remoteapi.assay.nab

Class NAbRunsCommand

java.lang.Object

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

org.labkey.remoteapi.PostCommand<ResponseType>

org.labkey.remoteapi.query.BaseQueryCommand<NAbRunsResponse>

org.labkey.remoteapi.assay.nab.NAbRunsCommand

All Implemented Interfaces:

HasRequiredVersion

public class NAbRunsCommand
extends BaseQueryCommand<NAbRunsResponse>

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

By default, this command returns information about all assays, but you may use the various setters to filter this list to assays of a given name, type or id.

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.query.BaseQueryCommand

_containerFilter, _filters, _maxRows, _offset, _sorts

Fields inherited from class org.labkey.remoteapi.Command

CONTENT_TYPE_JSON

Constructor Summary

Constructors

Constructor	Description
NAbRunsCommand()

Method Summary

Modifier and Type	Method	Description
protected NAbRunsResponse	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.
String	getAssayName()
org.json.JSONObject	getJsonObject()	Returns the JSON object to post or null for no JSON.
boolean	isCalculateNeut()
boolean	isIncludeFitParameters()
boolean	isIncludeStats()
boolean	isIncludeWells()
void	setAssayName(String assayName)
void	setCalculateNeut(boolean calculateNeut)
void	setIncludeFitParameters(boolean includeFitParameters)
void	setIncludeStats(boolean includeStats)
void	setIncludeWells(boolean includeWells)

Methods inherited from class org.labkey.remoteapi.query.BaseQueryCommand

addFilter, addFilter, addSort, addSort, getContainerFilter, getFilters, getMaxRows, getOffset, getQueryParameters, getSorts, isIgnoreFilter, isIncludeMetadata, isIncludeTotalCount, setContainerFilter, setFilters, setIgnoreFilter, setIncludeMetadata, setIncludeTotalCount, setMaxRows, setOffset, setQueryParameters, setSorts

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

NAbRunsCommand

public NAbRunsCommand()

Method Details

createResponse

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

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 BaseQueryCommand<NAbRunsResponse>

Returns:

The JSON object to post.

getAssayName

public String getAssayName()

setAssayName

public void setAssayName(String assayName)

isIncludeStats

public boolean isIncludeStats()

setIncludeStats

public void setIncludeStats(boolean includeStats)

isIncludeWells

public boolean isIncludeWells()

setIncludeWells

public void setIncludeWells(boolean includeWells)

isIncludeFitParameters

public boolean isIncludeFitParameters()

setIncludeFitParameters

public void setIncludeFitParameters(boolean includeFitParameters)

isCalculateNeut

public boolean isCalculateNeut()

setCalculateNeut

public void setCalculateNeut(boolean calculateNeut)