Package org.labkey.remoteapi.security

Class DeleteGroupCommand

java.lang.Object

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

org.labkey.remoteapi.PostCommand<CommandResponse>

org.labkey.remoteapi.security.DeleteGroupCommand

All Implemented Interfaces:

HasRequiredVersion

public class DeleteGroupCommand
extends PostCommand<CommandResponse>

Deletes the existing group corresponding to the group id. Note that the response to the command contains nothing meaningful. If it executed without exception, the group has been deleted.

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
DeleteGroupCommand(int groupId)

Method Summary

Modifier and Type	Method	Description
int	getGroupId()
org.json.JSONObject	getJsonObject()	Returns the JSON object to post or null for no JSON.
void	setGroupId(int groupId)

Methods inherited from class org.labkey.remoteapi.PostCommand

createRequest

Methods inherited from class org.labkey.remoteapi.Command

_execute, createParameterMap, createResponse, 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

DeleteGroupCommand

public DeleteGroupCommand(int groupId)

Method Details

getGroupId

public int getGroupId()

setGroupId

public void setGroupId(int groupId)

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

Returns:

The JSON object to post.