Package org.labkey.remoteapi.security

Class GroupMembersCommand

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

All Implemented Interfaces:

HasRequiredVersion

Direct Known Subclasses:

AddGroupMembersCommand, RemoveGroupMembersCommand

public abstract class GroupMembersCommand
extends PostCommand<CommandResponse>

Base class for AddGroupMembersCommand and RemoveGroupMembersCommand

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

Modifier	Constructor	Description
protected	GroupMembersCommand(String actionName, int groupId)

Method Summary

Modifier and Type	Method	Description
void	addPrincipalId(int... ids)
void	addPrincipalId(List<Integer> ids)
void	clearPrincipalIds()
int	getGroupId()
org.json.JSONObject	getJsonObject()	Returns the JSON object to post or null for no JSON.
List<Integer>	getPrincipals()
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

GroupMembersCommand

protected GroupMembersCommand(String actionName,
 int groupId)

Method Details

getPrincipals

public List<Integer> getPrincipals()

addPrincipalId

public void addPrincipalId(int... ids)

addPrincipalId

public void addPrincipalId(List<Integer> ids)

clearPrincipalIds

public void clearPrincipalIds()

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.