Package org.labkey.remoteapi.study

Class UpdateParticipantGroupCommand

java.lang.Object

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

org.labkey.remoteapi.PostCommand<UpdateParticipantGroupResponse>

org.labkey.remoteapi.study.UpdateParticipantGroupCommand

All Implemented Interfaces:

HasRequiredVersion

public class UpdateParticipantGroupCommand
extends PostCommand<UpdateParticipantGroupResponse>

Request to be sent to the server to update an existing participant group

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UpdateParticipantGroupCommand.UpdatedParticipantGroup	Special subclass that allows specifying just participants that should be added or removed, without needing to specify the full set of participants.

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
UpdateParticipantGroupCommand(ParticipantGroup group)

Method Summary

Modifier and Type	Method	Description
protected UpdateParticipantGroupResponse	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.

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

UpdateParticipantGroupCommand

public UpdateParticipantGroupCommand(ParticipantGroup group)

Parameters:

group - the group, including its requested updates. If fields are not set, they will not be changed from their existing values in the current saved group.

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

Returns:

The JSON object to post.

createResponse

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