Package org.labkey.remoteapi.assay

Class GetProtocolCommand

java.lang.Object

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

org.labkey.remoteapi.GetCommand<ProtocolResponse>

org.labkey.remoteapi.assay.GetProtocolCommand

All Implemented Interfaces:

HasRequiredVersion

public class GetProtocolCommand
extends GetCommand<ProtocolResponse>

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
GetProtocolCommand(long protocolId)
GetProtocolCommand(long protocolId, boolean copy)
GetProtocolCommand(String providerName)

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	createParameterMap()	Returns a new, mutable parameter map.
protected ProtocolResponse	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.
Boolean	getCopy()
Long	getProtocolId()
String	getProviderName()
void	setCopy(Boolean copy)
void	setProtocolId(long protocolId)
void	setProviderName(String providerName)

Methods inherited from class org.labkey.remoteapi.GetCommand

createRequest

Methods inherited from class org.labkey.remoteapi.Command

_execute, 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

GetProtocolCommand

public GetProtocolCommand(String providerName)

GetProtocolCommand

public GetProtocolCommand(long protocolId)

GetProtocolCommand

public GetProtocolCommand(long protocolId,
 boolean copy)

Method Details

createParameterMap

protected Map<String,Object> createParameterMap()

Description copied from class: Command

Returns a new, mutable parameter map. Derived classes will typically override this method to put values passed to specialized setter methods into the map.

Overrides:

createParameterMap in class Command<ProtocolResponse,org.apache.hc.client5.http.classic.methods.HttpGet>

Returns:

The parameter map to use when building the URL.

createResponse

protected ProtocolResponse 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<ProtocolResponse,org.apache.hc.client5.http.classic.methods.HttpGet>

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.

getProviderName

public String getProviderName()

setProviderName

public void setProviderName(String providerName)

getProtocolId

public Long getProtocolId()

setProtocolId

public void setProtocolId(long protocolId)

getCopy

public Boolean getCopy()

setCopy

public void setCopy(Boolean copy)