Package org.labkey.remoteapi.security

Class RenameContainerCommand

java.lang.Object

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

org.labkey.remoteapi.PostCommand<RenameContainerResponse>

org.labkey.remoteapi.security.RenameContainerCommand

All Implemented Interfaces:

HasRequiredVersion

public class RenameContainerCommand
extends PostCommand<RenameContainerResponse>

Rename a container on the server

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
RenameContainerCommand(String name, String title, boolean addAlias)

Method Summary

Modifier and Type	Method	Description
protected RenameContainerResponse	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()	Returns the JSON object to post or null for no JSON.
String	getName()
String	getTitle()
boolean	isAddAlias()
void	setAddAlias(boolean addAlias)
void	setName(String name)
void	setTitle(String title)

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

Methods inherited from class java.lang.Object

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

Constructor Details

RenameContainerCommand

public RenameContainerCommand(String name,
 String title,
 boolean addAlias)

Method Details

getJsonObject

public org.json.JSONObject getJsonObject()

Description copied from class: PostCommand

Returns the JSON object to post or null for no JSON. Override this method to provide parameters as JSON.

Overrides:

getJsonObject in class PostCommand<RenameContainerResponse>

Returns:

The JSON object to post.

getName

public String getName()

setName

public void setName(String name)

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

isAddAlias

public boolean isAddAlias()

setAddAlias

public void setAddAlias(boolean addAlias)

createResponse

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