Package org.labkey.remoteapi.query

Class GetQueryDetailsCommand

java.lang.Object

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

org.labkey.remoteapi.GetCommand<GetQueryDetailsResponse>

org.labkey.remoteapi.query.GetQueryDetailsCommand

All Implemented Interfaces:

HasRequiredVersion

public class GetQueryDetailsCommand
extends GetCommand<GetQueryDetailsResponse>

Command for obtaining the list of queries available within a given schema.

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
GetQueryDetailsCommand(String schemaName, String queryName)	Constructs the command given a particular schema name.
GetQueryDetailsCommand(String schemaName, String queryName, boolean includeSuggestedQueryColumns)	Constructs the command given a particular schema name.

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	createParameterMap()	Returns a new, mutable parameter map.
protected GetQueryDetailsResponse	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	getQueryName()
String	getSchemaName()
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

GetQueryDetailsCommand

public GetQueryDetailsCommand(String schemaName,
 String queryName,
 boolean includeSuggestedQueryColumns)

Constructs the command given a particular schema name.

Parameters:

schemaName - The schema name.

queryName - The name of the query (e.g., table) for the corresponding schema.

includeSuggestedQueryColumns - Default true. Include the auto suggested columns in the response, e.g., user defined queries always have the container column of their root table added.

GetQueryDetailsCommand

public GetQueryDetailsCommand(String schemaName,
 String queryName)

Constructs the command given a particular schema name.

Parameters:

schemaName - The schema name.

queryName - The name of the query (e.g., table) for the corresponding schema.

Method Details

getSchemaName

public String getSchemaName()

setSchemaName

public void setSchemaName(String schemaName)

getQueryName

public String getQueryName()

setQueryName

public void setQueryName(String queryName)

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

Returns:

The parameter map to use when building the URL.

createResponse

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