Package org.labkey.remoteapi.query

Class GetQueryDetailsResponse

java.lang.Object

org.labkey.remoteapi.CommandResponse

org.labkey.remoteapi.query.GetQueryDetailsResponse

public class GetQueryDetailsResponse
extends CommandResponse

Represents the response from a GetQueriesCommand.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetQueryDetailsResponse.Column
static class	GetQueryDetailsResponse.Lookup

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<GetQueryDetailsResponse.Column>	getColumns()	Returns the columns available in the given query name.
String	getDescription()	Returns the description of the query described by this response
String	getName()	Returns the query name that is described by this response
String	getSchemaName()	Returns the schema name the query in this response belongs to.
String	getTitle()	Returns the title of the query described by this response (often the same as the name, but not always)

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

GetQueryDetailsResponse

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

Method Details

getSchemaName

public String getSchemaName()

Returns the schema name the query in this response belongs to.

Returns:

The schema name.

getName

public String getName()

Returns the query name that is described by this response

Returns:

The query name.

getDescription

public String getDescription()

Returns the description of the query described by this response

Returns:

The query description.

getTitle

public String getTitle()

Returns the title of the query described by this response (often the same as the name, but not always)

Returns:

The query title.

getColumns

public List<GetQueryDetailsResponse.Column> getColumns()

Returns the columns available in the given query name.

Returns:

The list of columns available within that query.