Package org.labkey.remoteapi.security

Class GetUsersCommand

java.lang.Object

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

org.labkey.remoteapi.GetCommand<GetUsersResponse>

org.labkey.remoteapi.security.GetUsersCommand

All Implemented Interfaces:

HasRequiredVersion

public class GetUsersCommand
extends GetCommand<GetUsersResponse>

Returns a list of users given selection criteria. This may be called by any logged-in user.

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
GetUsersCommand()

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	createParameterMap()	Returns a new, mutable parameter map.
protected GetUsersResponse	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.
String	getGroup()
int	getGroupId()
Boolean	getIncludeDeactivated()	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	getIncludeInactive()
String	getName()
void	setGroup(String group)
void	setGroupId(int groupId)
void	setIncludeDeactivated(Boolean includeInactive)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setIncludeInactive(boolean includeInactive)
void	setName(String name)

Methods inherited from class org.labkey.remoteapi.GetCommand

createRequest

Methods inherited from class org.labkey.remoteapi.Command

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

GetUsersCommand

public GetUsersCommand()

Method Details

getGroupId

public int getGroupId()

Returns:

the id of a project group for which you want the members

setGroupId

public void setGroupId(int groupId)

Parameters:

groupId - the id of a project group for which you want the members (specify groupId or group, not both).

getGroup

public String getGroup()

Returns:

the name of a project group for which you want the members

setGroup

public void setGroup(String group)

Parameters:

group - the name of a project group for which you want the members (specify groupId or group, not both).

getName

public String getName()

Returns:

the first part of the username, useful for username completion

setName

public void setName(String name)

Parameters:

name - The first part of the username, useful for username completion. If specified, only users whose email address or display name starts with the value supplied will be returned.

getIncludeDeactivated

@Deprecated(forRemoval=true)
public Boolean getIncludeDeactivated()

Deprecated, for removal: This API element is subject to removal in a future version.

setIncludeDeactivated

@Deprecated(forRemoval=true)
public void setIncludeDeactivated(Boolean includeInactive)

Deprecated, for removal: This API element is subject to removal in a future version.

getIncludeInactive

public boolean getIncludeInactive()

Returns:

Flag to request inactive users as well

setIncludeInactive

public void setIncludeInactive(boolean includeInactive)

createParameterMap

protected Map<String,Object> createParameterMap()

Description copied from class: Command

Returns a new, mutable parameter map. Derived classes will typically override this method to put values passed to specialized setter methods into the map.

Overrides:

createParameterMap in class Command<GetUsersResponse,org.apache.hc.client5.http.classic.methods.HttpGet>

Returns:

The parameter map to use when building the URL.

createResponse

protected GetUsersResponse 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<GetUsersResponse,org.apache.hc.client5.http.classic.methods.HttpGet>

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.