Class AssayListResponse

java.lang.Object

org.labkey.remoteapi.CommandResponse

org.labkey.remoteapi.assay.AssayListResponse

public class AssayListResponse
extends CommandResponse

Response class for the AssayListCommand. This class provides helpful getter method to access particular bits of the parsed response data.

Constructor Summary

Constructors

Constructor	Description
AssayListResponse(String text, int statusCode, String contentType, org.json.JSONObject json)	Constructs a new AssayListResponse

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getDefinition(int id)	Returns an assay definition for the assay identified by the specified id.
Map<String,Object>	getDefinition(String name)	Returns an assay definition for the assay identified by the specified name.
List<Map<String,Object>>	getDefinitions()	Returns the definitions section of the response.

Methods inherited from class CommandResponse

findObject, getContentType, getParsedData, getProperty, getProperty, getStatusCode, getText

Methods inherited from class Object

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

Constructor Details

AssayListResponse

public AssayListResponse(String text,
 int statusCode,
 String contentType,
 org.json.JSONObject json)

Constructs a new AssayListResponse

Parameters:

text - The response text.

statusCode - The HTTP status code.

contentType - The HTTP response content type

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

Method Details

getDefinitions

public List<Map<String,Object>> getDefinitions()

Returns the definitions section of the response. This returns a list of assay definition Maps, each of which contains properties about the particular assay definition.

Returns:

The list of definitions.

getDefinition

public Map<String,Object> getDefinition(String name)

Returns an assay definition for the assay identified by the specified name.

Parameters:

name - The name of the assay definition to find.

Returns:

The assay definition or null if not found.

getDefinition

public Map<String,Object> getDefinition(int id)

Returns an assay definition for the assay identified by the specified id.

Parameters:

id - The id of the assay definition to find.

Returns:

The assay definition or null if not found.