Class GetContainersCommand

java.lang.Object

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

org.labkey.remoteapi.GetCommand<GetContainersResponse>

org.labkey.remoteapi.security.GetContainersCommand

All Implemented Interfaces:

HasRequiredVersion

public class GetContainersCommand
extends GetCommand<GetContainersResponse>

Nested Class Summary

Nested classes/interfaces inherited from class Command

Command.CommonParameters, Command.Response

Field Summary

Fields inherited from class Command

CONTENT_TYPE_JSON

Constructor Summary

Constructors

Constructor	Description
GetContainersCommand()

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	createParameterMap()	Returns a new, mutable parameter map.
protected GetContainersResponse	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.
Boolean	getIncludeChildWorkbooks()
Boolean	getIncludeEffectivePermissions()
Boolean	getIncludeStandardProperties()
boolean	isIncludeSubfolders()
void	setIncludeChildWorkbooks(Boolean includeChildWorkbooks)
void	setIncludeEffectivePermissions(Boolean includeEffectivePermissions)
void	setIncludeStandardProperties(Boolean includeStandardProperties)
void	setIncludeSubfolders(boolean includeSubfolders)

Methods inherited from class GetCommand

createRequest

Methods inherited from class Command

_execute, execute, getActionName, getControllerName, getHttpRequest, getParameters, getParamValueAsString, getRequiredVersion, getTimeout, setRequiredVersion, setTimeout

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GetContainersCommand

public GetContainersCommand()

Method Details

isIncludeSubfolders

public boolean isIncludeSubfolders()

setIncludeSubfolders

public void setIncludeSubfolders(boolean includeSubfolders)

getIncludeChildWorkbooks

public Boolean getIncludeChildWorkbooks()

setIncludeChildWorkbooks

public void setIncludeChildWorkbooks(Boolean includeChildWorkbooks)

getIncludeStandardProperties

public Boolean getIncludeStandardProperties()

setIncludeStandardProperties

public void setIncludeStandardProperties(Boolean includeStandardProperties)

getIncludeEffectivePermissions

public Boolean getIncludeEffectivePermissions()

setIncludeEffectivePermissions

public void setIncludeEffectivePermissions(Boolean includeEffectivePermissions)

createResponse

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

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

Returns:

The parameter map to use when building the URL.