Package org.labkey.remoteapi.security

Class DeleteContainerCommand

java.lang.Object

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

org.labkey.remoteapi.PostCommand<DeleteContainerResponse>

org.labkey.remoteapi.security.DeleteContainerCommand

All Implemented Interfaces:

HasRequiredVersion

public class DeleteContainerCommand
extends PostCommand<DeleteContainerResponse>

Delete a container (project/folder/workbook) and all of its children. Takes no configuration, just a target container path when executing the command.

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
DeleteContainerCommand()

Method Summary

Modifier and Type	Method	Description
protected DeleteContainerResponse	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.

Methods inherited from class org.labkey.remoteapi.PostCommand

createRequest, getJsonObject

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

DeleteContainerCommand

public DeleteContainerCommand()

Method Details

createResponse

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