Package org.labkey.remoteapi.domain

Class GetDomainDetailsCommand

java.lang.Object

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

org.labkey.remoteapi.GetCommand<DomainDetailsResponse>

org.labkey.remoteapi.domain.GetDomainDetailsCommand

All Implemented Interfaces:

HasRequiredVersion

public class GetDomainDetailsCommand
extends GetCommand<DomainDetailsResponse>

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
GetDomainDetailsCommand(Long domainId)
GetDomainDetailsCommand(String schemaName, String queryName)

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	createParameterMap()	Returns a new, mutable parameter map.
protected DomainDetailsResponse	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.
Long	getDomainId()
String	getQueryName()
String	getSchemaName()
void	setDomainId(Long domainId)
void	setQueryName(String queryName)
void	setSchemaName(String schemaName)

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

GetDomainDetailsCommand

public GetDomainDetailsCommand(String schemaName,
 String queryName)

GetDomainDetailsCommand

public GetDomainDetailsCommand(Long domainId)

Method Details

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

Returns:

The parameter map to use when building the URL.

createResponse

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

getSchemaName

public String getSchemaName()

setSchemaName

public void setSchemaName(String schemaName)

getQueryName

public String getQueryName()

setQueryName

public void setQueryName(String queryName)

getDomainId

public Long getDomainId()

setDomainId

public void setDomainId(Long domainId)