Package org.labkey.remoteapi.security

Class CreateGroupCommand

java.lang.Object

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

org.labkey.remoteapi.PostCommand<CreateGroupResponse>

org.labkey.remoteapi.security.CreateGroupCommand

All Implemented Interfaces:

HasRequiredVersion

public class CreateGroupCommand
extends PostCommand<CreateGroupResponse>

Creates a new user group. When executed in a project or subfolder, it will create the group at the project level. When executed at the root level, it will create a new site 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
CreateGroupCommand(String name)

Method Summary

Modifier and Type	Method	Description
protected CreateGroupResponse	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()
void	setName(String name)

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

CreateGroupCommand

public CreateGroupCommand(String name)

Method Details

getName

public String getName()

setName

public void setName(String name)

createResponse

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

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

Returns:

The JSON object to post.