Package org.labkey.remoteapi.storage

Class BaseStorageCommand

java.lang.Object

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

org.labkey.remoteapi.PostCommand<StorageCommandResponse>

org.labkey.remoteapi.storage.BaseStorageCommand

All Implemented Interfaces:

HasRequiredVersion

Direct Known Subclasses:

CreateCommand, DeleteCommand, UpdateCommand

public abstract class BaseStorageCommand
extends PostCommand<StorageCommandResponse>

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
BaseStorageCommand(String action, StorageRow storageRow)

Method Summary

Modifier and Type	Method	Description
protected StorageCommandResponse	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()	Dynamically builds the JSON object to send based on the storageRow.
double	getRequiredVersion()	Returns the required version number of this API call.

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, getTimeout, setRequiredVersion, setTimeout

Methods inherited from class java.lang.Object

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

Constructor Details

BaseStorageCommand

public BaseStorageCommand(String action,
 StorageRow storageRow)

Method Details

getRequiredVersion

public double getRequiredVersion()

Description copied from class: Command

Returns the required version number of this API call.

Specified by:

getRequiredVersion in interface HasRequiredVersion

Overrides:

getRequiredVersion in class Command<StorageCommandResponse,org.apache.hc.client5.http.classic.methods.HttpPost>

Returns:

The required version number

createResponse

protected StorageCommandResponse 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<StorageCommandResponse,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()

Dynamically builds the JSON object to send based on the storageRow.

Overrides:

getJsonObject in class PostCommand<StorageCommandResponse>

Returns:

The JSON object to send.