Package org.labkey.remoteapi.domain

Class ListDomainsCommand

java.lang.Object

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

org.labkey.remoteapi.PostCommand<ListDomainsResponse>

org.labkey.remoteapi.domain.ListDomainsCommand

All Implemented Interfaces:

HasRequiredVersion

public class ListDomainsCommand
extends PostCommand<ListDomainsResponse>

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
ListDomainsCommand(boolean includeFields, boolean includeProjectAndShared, Set<String> domainKinds, String containerPath)

Method Summary

Modifier and Type	Method	Description
protected ListDomainsResponse	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	getContainerPath()
Set<String>	getDomainKinds()
org.json.JSONObject	getJsonObject()	Returns the JSON object to post or null for no JSON.
boolean	isIncludeFields()
boolean	isIncludeProjectAndShared()
void	setContainerPath(String containerPath)
void	setDomainKinds(Set<String> domainKinds)
void	setIncludeFields(boolean includeFields)
void	setIncludeProjectAndShared(boolean includeProjectAndShared)

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

ListDomainsCommand

public ListDomainsCommand(boolean includeFields,
 boolean includeProjectAndShared,
 Set<String> domainKinds,
 String containerPath)

Method Details

isIncludeFields

public boolean isIncludeFields()

setIncludeFields

public void setIncludeFields(boolean includeFields)

isIncludeProjectAndShared

public boolean isIncludeProjectAndShared()

setIncludeProjectAndShared

public void setIncludeProjectAndShared(boolean includeProjectAndShared)

getDomainKinds

public Set<String> getDomainKinds()

setDomainKinds

public void setDomainKinds(Set<String> domainKinds)

getContainerPath

public String getContainerPath()

setContainerPath

public void setContainerPath(String containerPath)

createResponse

protected ListDomainsResponse 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<ListDomainsResponse,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<ListDomainsResponse>

Returns:

The JSON object to post.