Package org.labkey.remoteapi.security

Class DeleteUserCommand

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.DeleteUserCommand

All Implemented Interfaces:

HasRequiredVersion

public class DeleteUserCommand
extends PostCommand<CommandResponse>

Deletes existing users based on userIds If it executed without exception, the users have 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
DeleteUserCommand(int userId)

Method Summary

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

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

DeleteUserCommand

public DeleteUserCommand(int userId)

Method Details

getUserId

public int getUserId()

setUserId

public void setUserId(int userId)

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.