Package org.labkey.remoteapi.storage

Class StorageCommandResponse

java.lang.Object

org.labkey.remoteapi.CommandResponse

org.labkey.remoteapi.storage.StorageCommandResponse

public class StorageCommandResponse
extends CommandResponse

Response object used for the storage CreateCommand, UpdateCommand, and DeleteCommand. The response object will include a string message and a data object with the properties from the relevant storage item from the command.

Constructor Summary

Constructors

Constructor	Description
StorageCommandResponse(String text, int statusCode, String contentType, org.json.JSONObject json)	Constructs a new StorageCommandResponse, initialized with the provided response text and status code.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getData()	Returns the data object with properties from the newly created storage item.
String	getMessage()	Returns the success message for the command.
Integer	getRowId()

Methods inherited from class org.labkey.remoteapi.CommandResponse

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

Methods inherited from class java.lang.Object

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

Constructor Details

StorageCommandResponse

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

Constructs a new StorageCommandResponse, initialized with the provided response text and status code.

Parameters:

text - The response text

statusCode - The HTTP status code

contentType - The response content type

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

Method Details

getMessage

public String getMessage()

Returns the success message for the command.

Returns:

The success message string.

getData

public Map<String,Object> getData()

Returns the data object with properties from the newly created storage item.

Returns:

A map of the key value pairs for the storage item.

getRowId

public Integer getRowId()