Package org.labkey.remoteapi.query

Class GetQueriesCommand

java.lang.Object

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

org.labkey.remoteapi.GetCommand<GetQueriesResponse>

org.labkey.remoteapi.query.GetQueriesCommand

All Implemented Interfaces:

HasRequiredVersion

public class GetQueriesCommand
extends GetCommand<GetQueriesResponse>

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
GetQueriesCommand(String schemaName)	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 GetQueriesResponse	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	getSchemaName()
boolean	isIncludeColumns()
boolean	isIncludeTitle()
boolean	isIncludeUserQueries()
boolean	isIncludeViewDataUrl()
void	setIncludeColumns(boolean includeColumns)	Pass false to omit information about the columns within each query.
void	setIncludeTitle(boolean includeTitle)	Pass false to omit custom query titles.
void	setIncludeUserQueries(boolean includeUserQueries)	Pass false to this method to omit user-defined queries from the results.
void	setIncludeViewDataUrl(boolean includeViewDataUrl)	Pass false to omit view data URLs from the results.
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

GetQueriesCommand

public GetQueriesCommand(String schemaName)

Constructs the command given a particular schema name.

Parameters:

schemaName - The schema name.

Method Details

getSchemaName

public String getSchemaName()

setSchemaName

public void setSchemaName(String schemaName)

isIncludeColumns

public boolean isIncludeColumns()

setIncludeColumns

public void setIncludeColumns(boolean includeColumns)

Pass false to omit information about the columns within each query. By default, column information is included.

Parameters:

includeColumns - 'false' to omit column information.

isIncludeTitle

public boolean isIncludeTitle()

setIncludeTitle

public void setIncludeTitle(boolean includeTitle)

Pass false to omit custom query titles. Titles will be returned, but their values will be identical to names. Default is true.

Parameters:

includeTitle - 'false' to omit custom query titles.

isIncludeUserQueries

public boolean isIncludeUserQueries()

setIncludeUserQueries

public void setIncludeUserQueries(boolean includeUserQueries)

Pass false to this method to omit user-defined queries from the results. By default, user-defined queries are included.

Parameters:

includeUserQueries - Set to 'false' to omit user-defined queries.

isIncludeViewDataUrl

public boolean isIncludeViewDataUrl()

setIncludeViewDataUrl

public void setIncludeViewDataUrl(boolean includeViewDataUrl)

Pass false to omit view data URLs from the results. Default is true.

Parameters:

includeViewDataUrl - Set to 'false' to omit view data URLs.

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

Returns:

The parameter map to use when building the URL.

createResponse

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