Package org.labkey.remoteapi.security

Class RenameGroupCommand

java.lang.Object

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

org.labkey.remoteapi.PostCommand<RenameGroupResponse>

org.labkey.remoteapi.security.RenameGroupCommand

All Implemented Interfaces:

HasRequiredVersion

public class RenameGroupCommand
extends PostCommand<RenameGroupResponse>

Renames an existing group.

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
RenameGroupCommand(int groupId, String newName)

Method Summary

Modifier and Type	Method	Description
protected RenameGroupResponse	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.
int	getGroupId()
org.json.JSONObject	getJsonObject()	Returns the JSON object to post or null for no JSON.
String	getNewName()
void	setGroupId(int groupId)
void	setNewName(String newName)

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

RenameGroupCommand

public RenameGroupCommand(int groupId,
 String newName)

Method Details

getGroupId

public int getGroupId()

setGroupId

public void setGroupId(int groupId)

getNewName

public String getNewName()

setNewName

public void setNewName(String newName)

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<RenameGroupResponse>

Returns:

The JSON object to post.

createResponse

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