Package org.labkey.remoteapi.query

Class GetQueriesResponse

java.lang.Object

org.labkey.remoteapi.CommandResponse

org.labkey.remoteapi.query.GetQueriesResponse

public class GetQueriesResponse
extends CommandResponse

Represents the response from a GetQueriesCommand.

Constructor Summary

Constructors

Constructor	Description
GetQueriesResponse(String text, int statusCode, String contentType, org.json.JSONObject json)

Method Summary

Modifier and Type	Method	Description
List<String>	getColumnNames(String queryName)	Returns the list of column names available in the given query name.
List<String>	getQueryNames()	Returns the list of available query names in the given schema.
String	getSchemaName()	Returns the schema name the queries in this response belong to.
boolean	isUserDefined(String queryName)

Methods inherited from class org.labkey.remoteapi.CommandResponse

findObject, getContentType, getParsedData, getProperty, getProperty, getStatusCode, getText

Methods inherited from class java.lang.Object

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

Constructor Details

GetQueriesResponse

public GetQueriesResponse(String text,
 int statusCode,
 String contentType,
 org.json.JSONObject json)

Method Details

getSchemaName

public String getSchemaName()

Returns the schema name the queries in this response belong to.

Returns:

The schema name.

getQueryNames

public List<String> getQueryNames()

Returns the list of available query names in the given schema.

Returns:

List of query names.

isUserDefined

public boolean isUserDefined(String queryName)

Parameters:

queryName - The query name to find.

Returns:

true if the query of interest is known to be a custom LabKey SQL query, false otherwise.

getColumnNames

public List<String> getColumnNames(String queryName)

Returns the list of column names available in the given query name. Note that if the command was set to not include column information, this will return an empty list.

Parameters:

queryName - The query name to find.

Returns:

The list of columns available within that query, or an empty list if not found.