Index

A B C D E F G H I J L M N O P Q R S T U V W X _
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addCookie(String, String, String, String, Date, boolean) - Method in class org.labkey.remoteapi.Connection

addFilter(String, Object, Filter.Operator) - Method in class org.labkey.remoteapi.query.BaseQueryCommand

Constructs and adds a new filter to the list.

addFilter(Filter) - Method in class org.labkey.remoteapi.query.BaseQueryCommand

Adds a new filter to the list.

AddGroupMembersCommand - Class in org.labkey.remoteapi.security

Adds a set of principals to a security group.

AddGroupMembersCommand(int) - Constructor for class org.labkey.remoteapi.security.AddGroupMembersCommand

addPrincipalId(int...) - Method in class org.labkey.remoteapi.security.GroupMembersCommand

addPrincipalId(List<Integer>) - Method in class org.labkey.remoteapi.security.GroupMembersCommand

addRow(Map<String, Object>) - Method in class org.labkey.remoteapi.query.SaveRowsCommand

Adds a row to the list of rows to be sent to the server.

addSort(String, Sort.Direction) - Method in class org.labkey.remoteapi.query.BaseQueryCommand

Constructs and adds a new sort definition to the current list.

addSort(Sort) - Method in class org.labkey.remoteapi.query.BaseQueryCommand

Adds a new sort definition to the current list.

afterExecute() - Method in class org.labkey.remoteapi.Connection

AllFolders - Enum constant in enum class org.labkey.remoteapi.query.ContainerFilter

All folders to which the user has permission

ApiKeyCredentialsProvider - Class in org.labkey.remoteapi

ApiKeyCredentialsProvider(String) - Constructor for class org.labkey.remoteapi.ApiKeyCredentialsProvider

apiVersion - Enum constant in enum class org.labkey.remoteapi.Command.CommonParameters

ApiVersionException - Exception in org.labkey.remoteapi

ASCENDING - Enum constant in enum class org.labkey.remoteapi.query.Sort.Direction

AssayListCommand - Class in org.labkey.remoteapi.assay

Command for obtaining information about the current assay definitions in a particular folder.

AssayListCommand() - Constructor for class org.labkey.remoteapi.assay.AssayListCommand

Constructs a new AssayListCommand object.

AssayListResponse - Class in org.labkey.remoteapi.assay

Response class for the AssayListCommand.

AssayListResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.assay.AssayListResponse

Constructs a new AssayListResponse

assayTest(Connection, String) - Static method in class org.labkey.remoteapi.test.Test

B

BaseCreateFolderCommand<COMMAND extends BaseCreateFolderCommand<?>> - Class in org.labkey.remoteapi.security

BaseCreateFolderCommand(String) - Constructor for class org.labkey.remoteapi.security.BaseCreateFolderCommand

BaseQueryCommand<ResponseType extends CommandResponse> - Class in org.labkey.remoteapi.query

BaseQueryCommand(String, String) - Constructor for class org.labkey.remoteapi.query.BaseQueryCommand

BaseSelect - Interface in org.labkey.remoteapi.query

Common methods implemented by SelectRowsCommand and ExecuteSqlCommand

BaseStorageCommand - Class in org.labkey.remoteapi.storage

BaseStorageCommand(String, StorageRow) - Constructor for class org.labkey.remoteapi.storage.BaseStorageCommand

BaseTransformCommand<ResponseType extends CommandResponse> - Class in org.labkey.remoteapi.di

BaseTransformCommand(String, String) - Constructor for class org.labkey.remoteapi.di.BaseTransformCommand

BaseTransformResponse - Class in org.labkey.remoteapi.di

BaseTransformResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.di.BaseTransformResponse

Constructs a new CommandResponse, initialized with the provided response text and status code.

BasicAuthCredentialsProvider - Class in org.labkey.remoteapi

BasicAuthCredentialsProvider(String, String) - Constructor for class org.labkey.remoteapi.BasicAuthCredentialsProvider

Batch - Class in org.labkey.remoteapi.assay

Batch() - Constructor for class org.labkey.remoteapi.assay.Batch

Batch(JSONObject) - Constructor for class org.labkey.remoteapi.assay.Batch

beforeExecute(HttpRequest) - Method in class org.labkey.remoteapi.Connection

If first request, prime the Connection by forcing authentication and populating CSRF and session info.

BETWEEN - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

BOOLEAN - Enum constant in enum class org.labkey.remoteapi.query.SelectRowsResponse.ColumnDataType

build() - Method in class org.labkey.remoteapi.experiment.LineageCommand.Builder

Builder(String) - Constructor for class org.labkey.remoteapi.experiment.LineageCommand.Builder

Builder(List<String>) - Constructor for class org.labkey.remoteapi.experiment.LineageCommand.Builder

C

Canister - Enum constant in enum class org.labkey.remoteapi.storage.StorageItemTypes

CaseInsensitiveHashMap<V> - Class in org.labkey.remoteapi.collections

CaseInsensitiveHashMap() - Constructor for class org.labkey.remoteapi.collections.CaseInsensitiveHashMap

CaseInsensitiveHashMap(int) - Constructor for class org.labkey.remoteapi.collections.CaseInsensitiveHashMap

CaseInsensitiveHashMap(Map<String, V>) - Constructor for class org.labkey.remoteapi.collections.CaseInsensitiveHashMap

clear() - Method in class org.labkey.remoteapi.collections.CaseInsensitiveHashMap

clearPrincipalIds() - Method in class org.labkey.remoteapi.security.GroupMembersCommand

ClientConfig - Class in org.labkey.remoteapi.test

Utility class to parse a .properties file and produce reasonable exceptions if required properties aren't present.

ClientConfig(String[]) - Constructor for class org.labkey.remoteapi.test.ClientConfig

Defaults to looking in the working directory for a config.properties file.

close() - Method in class org.labkey.remoteapi.Command.Response

CodeGenerationException - Exception in org.labkey.remoteapi.totp

CodeGenerationException(String, Throwable) - Constructor for exception org.labkey.remoteapi.totp.CodeGenerationException

CodeGenerator - Class in org.labkey.remoteapi.totp

CodeGenerator(HashingAlgorithm, int) - Constructor for class org.labkey.remoteapi.totp.CodeGenerator

Command<ResponseType extends CommandResponse,RequestType extends org.apache.hc.client5.http.classic.methods.HttpUriRequest> - Class in org.labkey.remoteapi

Abstract base class for all API commands.

Command(String, String) - Constructor for class org.labkey.remoteapi.Command

Constructs a new Command object for calling the specified API action on the specified controller.

Command.CommonParameters - Enum Class in org.labkey.remoteapi

An enum of common parameter names used in API URLs.

Command.Response - Class in org.labkey.remoteapi

Response class allows clients to get an InputStream, consume lazily, and close the connection when complete.

CommandException - Exception in org.labkey.remoteapi

Represents an exception that occurs while executing a command.

CommandException(String) - Constructor for exception org.labkey.remoteapi.CommandException

Constructs a new CommandException given a message only.

CommandException(String, int, JSONObject, String, String, String) - Constructor for exception org.labkey.remoteapi.CommandException

Constructs a new CommandException given a message, HTTP status code, exception property map, responseText, and contentType.

CommandResponse - Class in org.labkey.remoteapi

Represents the details of a response returned from the LabKey Server.

CommandResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.CommandResponse

Constructs a new CommandResponse, initialized with the provided response text and status code.

ConditionalFormat - Class in org.labkey.remoteapi.domain

Bean class for defining a conditional format for a field.
Grids will conditionally apply the specified styling to the associated field.

ConditionalFormat(List<ConditionalFormatFilter>, Boolean, Boolean, Boolean) - Constructor for class org.labkey.remoteapi.domain.ConditionalFormat

Construct a conditional format with font styling

ConditionalFormat(List<ConditionalFormatFilter>, String, String) - Constructor for class org.labkey.remoteapi.domain.ConditionalFormat

Construct a conditional format with color styling

ConditionalFormat(List<ConditionalFormatFilter>, String, String, Boolean, Boolean, Boolean) - Constructor for class org.labkey.remoteapi.domain.ConditionalFormat

Construct a conditional format with the specified styling.

ConditionalFormatFilter - Class in org.labkey.remoteapi.domain

Bean defining a filter used to control when conditional formatting should be applied to a field.

ConditionalFormatFilter(String, Filter.Operator) - Constructor for class org.labkey.remoteapi.domain.ConditionalFormatFilter

Construct a filter for conditional formatting.

CONFIG_ARG_PREFIX - Static variable in class org.labkey.remoteapi.test.ClientConfig

configureClientBuilder(URI, HttpClientBuilder) - Method in class org.labkey.remoteapi.ApiKeyCredentialsProvider

configureClientBuilder(URI, HttpClientBuilder) - Method in class org.labkey.remoteapi.BasicAuthCredentialsProvider

configureClientBuilder(URI, HttpClientBuilder) - Method in interface org.labkey.remoteapi.CredentialsProvider

configureClientBuilder(URI, HttpClientBuilder) - Method in class org.labkey.remoteapi.GuestCredentialsProvider

configureClientBuilder(URI, HttpClientBuilder) - Method in class org.labkey.remoteapi.NetrcCredentialsProvider

configureRequest(URI, HttpUriRequest, HttpClientContext) - Method in class org.labkey.remoteapi.ApiKeyCredentialsProvider

configureRequest(URI, HttpUriRequest, HttpClientContext) - Method in class org.labkey.remoteapi.BasicAuthCredentialsProvider

configureRequest(URI, HttpUriRequest, HttpClientContext) - Method in interface org.labkey.remoteapi.CredentialsProvider

configureRequest(URI, HttpUriRequest, HttpClientContext) - Method in class org.labkey.remoteapi.GuestCredentialsProvider

configureRequest(URI, HttpUriRequest, HttpClientContext) - Method in class org.labkey.remoteapi.NetrcCredentialsProvider

Connection - Class in org.labkey.remoteapi

Represents connection information for a particular LabKey Server.

Connection(String) - Constructor for class org.labkey.remoteapi.Connection

Constructs a new Connection object with a base URL that attempts authentication via .netrc/_netrc entry, if present.

Connection(String, String, String) - Constructor for class org.labkey.remoteapi.Connection

Constructs a new Connection object for a base URL that attempts basic authentication.

Connection(String, CredentialsProvider) - Constructor for class org.labkey.remoteapi.Connection

Constructs a new Connection object given a base URL and a credentials provider.

Connection(URI, CredentialsProvider) - Constructor for class org.labkey.remoteapi.Connection

Constructs a new Connection object given a base URL and a credentials provider.

ContainerFilter - Enum Class in org.labkey.remoteapi.query

Represents a container filter that can be used with the ExecuteSqlCommand and the SelectRowsCommand.

CONTAINS - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

CONTAINS_NONE_OF - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

CONTAINS_ONE_OF - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

containsKey(Object) - Method in class org.labkey.remoteapi.collections.CaseInsensitiveHashMap

containsKey(String) - Method in class org.labkey.remoteapi.collections.CaseInsensitiveHashMap

CONTENT_TYPE_JSON - Static variable in class org.labkey.remoteapi.Command

A constant for the official JSON content type ("application/json")

CreateCommand - Class in org.labkey.remoteapi.storage

Create a new LabKey Freezer Manager storage item that can be used in the creation of a storage hierarchy.

CreateCommand(StorageRow) - Constructor for class org.labkey.remoteapi.storage.CreateCommand

Constructs a new CreateCommand for the given StorageRow.

createConnection() - Method in class org.labkey.remoteapi.test.ClientConfig

Creates a connection object based on the baseServerURL, username, and password config properties.

CreateContainerCommand - Class in org.labkey.remoteapi.security

Create a container (project/folder/workbook) on the server

CreateContainerCommand(String) - Constructor for class org.labkey.remoteapi.security.CreateContainerCommand

CreateContainerResponse - Class in org.labkey.remoteapi.security

CreateContainerResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.security.CreateContainerResponse

CreateDomainCommand - Class in org.labkey.remoteapi.domain

Command class for creating a new domain.

CreateDomainCommand(String, String) - Constructor for class org.labkey.remoteapi.domain.CreateDomainCommand

Initialize command to create a domain of the specified "kind".

CreateFolderCommand - Class in org.labkey.remoteapi.security

Similar to CreateContainerCommand, but supports creating folders from a template

CreateFolderCommand() - Constructor for class org.labkey.remoteapi.security.CreateFolderCommand

CreateGroupCommand - Class in org.labkey.remoteapi.security

Creates a new user group.

CreateGroupCommand(String) - Constructor for class org.labkey.remoteapi.security.CreateGroupCommand

CreateGroupResponse - Class in org.labkey.remoteapi.security

CreateGroupResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.security.CreateGroupResponse

createParameterMap() - Method in class org.labkey.remoteapi.assay.AssayListCommand

createParameterMap() - Method in class org.labkey.remoteapi.assay.GetProtocolCommand

createParameterMap() - Method in class org.labkey.remoteapi.Command

Returns a new, mutable parameter map.

createParameterMap() - Method in class org.labkey.remoteapi.domain.GetDomainDetailsCommand

createParameterMap() - Method in class org.labkey.remoteapi.experiment.LineageCommand

createParameterMap() - Method in class org.labkey.remoteapi.ms2.StartSearchCommand

createParameterMap() - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

createParameterMap() - Method in class org.labkey.remoteapi.query.GetQueriesCommand

createParameterMap() - Method in class org.labkey.remoteapi.query.GetQueryDetailsCommand

createParameterMap() - Method in class org.labkey.remoteapi.security.GetContainersCommand

createParameterMap() - Method in class org.labkey.remoteapi.security.GetGroupPermsCommand

createParameterMap() - Method in class org.labkey.remoteapi.security.GetUsersCommand

createParameterMap() - Method in class org.labkey.remoteapi.security.ImpersonateUserCommand

createParameterMap() - Method in class org.labkey.remoteapi.SimpleGetCommand

Returns a new, mutable parameter map initialized with the values from the map passed to SimpleGetCommand.setParameters(Map) method, if any.

createParameterMap() - Method in class org.labkey.remoteapi.SimplePostCommand

Returns a new, mutable parameter map initialized with the values from the map passed to SimplePostCommand.setParameters(Map) method, if any.

CreateProjectCommand - Class in org.labkey.remoteapi.security

Similar to CreateContainerCommand, but supports the "Project Creator" role and creating projects from a template

CreateProjectCommand() - Constructor for class org.labkey.remoteapi.security.CreateProjectCommand

createRequest(URI) - Method in class org.labkey.remoteapi.assay.ImportRunCommand

createRequest(URI) - Method in class org.labkey.remoteapi.Command

Creates the appropriate HttpUriRequest instance.

createRequest(URI) - Method in class org.labkey.remoteapi.GetCommand

Creates the HttpGet instance used for the request.

createRequest(URI) - Method in class org.labkey.remoteapi.PostCommand

Creates the HttpPost instance used for the request.

createRequest(URI) - Method in class org.labkey.remoteapi.query.ImportDataCommand

createRequest(URI) - Method in class org.labkey.remoteapi.security.BaseCreateFolderCommand

createRequest(URI) - Method in class org.labkey.remoteapi.security.StopImpersonatingCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.assay.AssayListCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.assay.GetAssayRunCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.assay.GetProtocolCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.assay.ImportRunCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.assay.LoadAssayBatchCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.assay.nab.NAbRunsCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.assay.SaveAssayBatchCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.assay.SaveAssayRunsCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.assay.SaveProtocolCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.Command

Creates an instance of the response class, initialized with the response text, the HTTP status code, and parsed JSONObject.

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.di.ResetTransformStateCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.di.RunTransformCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.di.UpdateTransformConfigurationCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.domain.SaveDomainCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.domain.GetDomainDetailsCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.domain.ListDomainsCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.experiment.LineageCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.ms2.StartSearchCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.pipeline.FileNotificationCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.query.GetQueriesCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.query.GetQueryDetailsCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.query.GetSchemasCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.query.ImportDataCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.query.SaveRowsCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.query.SelectRowsCommand

Overridden to create a SelectRowsResponse object.

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.query.TruncateTableCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.security.CreateContainerCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.security.CreateGroupCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.security.CreateUserCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.security.DeleteContainerCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.security.GetContainersCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.security.GetGroupPermsCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.security.GetUsersCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.security.RenameContainerCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.security.RenameGroupCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.security.WhoAmICommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.storage.BaseStorageCommand

createResponse(String, int, String, JSONObject) - Method in class org.labkey.remoteapi.study.UpdateParticipantGroupCommand

CreateUserCommand - Class in org.labkey.remoteapi.security

Create a new user account on the server.

CreateUserCommand(String) - Constructor for class org.labkey.remoteapi.security.CreateUserCommand

CreateUserResponse - Class in org.labkey.remoteapi.security

CreateUserResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.security.CreateUserResponse

CredentialsProvider - Interface in org.labkey.remoteapi

crudTest(Connection, String) - Static method in class org.labkey.remoteapi.test.Test

Current - Enum constant in enum class org.labkey.remoteapi.query.ContainerFilter

The current container

CurrentAndParents - Enum constant in enum class org.labkey.remoteapi.query.ContainerFilter

The current container and all of its parent containers

CurrentAndSubfolders - Enum constant in enum class org.labkey.remoteapi.query.ContainerFilter

The current container and any folders it contains

CurrentPlusProject - Enum constant in enum class org.labkey.remoteapi.query.ContainerFilter

The current container and the project folder containing it

CurrentPlusProjectAndShared - Enum constant in enum class org.labkey.remoteapi.query.ContainerFilter

The current container, its project folder and all shared folders

D

Data - Class in org.labkey.remoteapi.assay

Represents a data file that may be used in a run.

Data() - Constructor for class org.labkey.remoteapi.assay.Data

Data(JSONObject) - Constructor for class org.labkey.remoteapi.assay.Data

datasetTest(Connection, String) - Static method in class org.labkey.remoteapi.test.Test

DATE - Enum constant in enum class org.labkey.remoteapi.query.SelectRowsResponse.ColumnDataType

DATE_EQUAL - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

DATE_GT - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

DATE_GTE - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

DATE_LT - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

DATE_LTE - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

DATE_NOT_EQUAL - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

DateParser - Class in org.labkey.remoteapi.query

DateParser() - Constructor for class org.labkey.remoteapi.query.DateParser

deepUnmodifiableList(List<Object>) - Static method in class org.labkey.remoteapi.internal.ResponseUtils

Make a thoroughly unmodifiable copy of a List that was generated by a JSONArray.
Any nested Maps or Lists will also be made unmodifiable.

deepUnmodifiableMap(Map<String, Object>) - Static method in class org.labkey.remoteapi.internal.ResponseUtils

Make a thoroughly unmodifiable copy of a Map that was generated by a JSONObject.
Any nested Maps or Lists will be made unmodifiable.

deepUnmodifiableMap(JSONObject) - Static method in class org.labkey.remoteapi.internal.ResponseUtils

Convert JSON Object to map and make a thoroughly unmodifiable copy of that map.
Any nested JSONObjects or JSONArrays will be similarly processed.

DeleteCommand - Class in org.labkey.remoteapi.storage

Delete an existing LabKey Freezer Manager storage item.

DeleteCommand(StorageRow) - Constructor for class org.labkey.remoteapi.storage.DeleteCommand

Constructs a new DeleteCommand for the given StorageRow.

DeleteContainerCommand - Class in org.labkey.remoteapi.security

Delete a container (project/folder/workbook) and all of its children.

DeleteContainerCommand() - Constructor for class org.labkey.remoteapi.security.DeleteContainerCommand

DeleteContainerResponse - Class in org.labkey.remoteapi.security

Response from a DeleteContainerResponse.

DeleteContainerResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.security.DeleteContainerResponse

DeleteGroupCommand - Class in org.labkey.remoteapi.security

Deletes the existing group corresponding to the group id.

DeleteGroupCommand(int) - Constructor for class org.labkey.remoteapi.security.DeleteGroupCommand

DeleteRowsCommand - Class in org.labkey.remoteapi.query

Command for deleting rows from a read-write schema.

DeleteRowsCommand(String, String) - Constructor for class org.labkey.remoteapi.query.DeleteRowsCommand

Constructs a DeleteRowsCommand for the given schemaName and queryName.

DeleteUserCommand - Class in org.labkey.remoteapi.security

Deletes existing users based on userIds If it executed without exception, the users have been deleted

DeleteUserCommand(int) - Constructor for class org.labkey.remoteapi.security.DeleteUserCommand

Demo - Class in org.labkey.remoteapi.test

Assumes a running LabKey Server with an "API Test" project containing: - The People list imported from People.xls in this repository - A wiki page named "home".

Demo(String[]) - Constructor for class org.labkey.remoteapi.test.Demo

DESCENDING - Enum constant in enum class org.labkey.remoteapi.query.Sort.Direction

DETAILED - Enum constant in enum class org.labkey.remoteapi.query.SaveRowsCommand.AuditBehavior

doDemo() - Method in class org.labkey.remoteapi.test.Demo

DOES_NOT_CONTAIN - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

DOES_NOT_START_WITH - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

Domain - Class in org.labkey.remoteapi.domain

Bean that defines a domain for creating, updating, or reading.

Domain() - Constructor for class org.labkey.remoteapi.domain.Domain

Domain(String) - Constructor for class org.labkey.remoteapi.domain.Domain

Domain(JSONObject) - Constructor for class org.labkey.remoteapi.domain.Domain

DomainDetailsResponse - Class in org.labkey.remoteapi.domain

DomainDetailsResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.domain.DomainDetailsResponse

DomainResponse - Class in org.labkey.remoteapi.domain

Response object for commands that expect the server to return a serialized domain.

DomainResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.domain.DomainResponse

DropDomainCommand - Class in org.labkey.remoteapi.domain

Command to delete a domain.

DropDomainCommand(String, String) - Constructor for class org.labkey.remoteapi.domain.DropDomainCommand

Instantiate command to delete the specified domain.

dump() - Method in class org.labkey.remoteapi.experiment.LineageResponse

E

encodeURIComponent(String) - Static method in class org.labkey.remoteapi.internal.EncodeUtils

URL Encode string.

EncodeUtils - Class in org.labkey.remoteapi.internal

EncodeUtils() - Constructor for class org.labkey.remoteapi.internal.EncodeUtils

EnsureLoginCommand - Class in org.labkey.remoteapi.security

Simply ensures that the connection is associated with an authenticated user.

EnsureLoginCommand() - Constructor for class org.labkey.remoteapi.security.EnsureLoginCommand

EQUAL - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

execSqlTest(Connection, String) - Static method in class org.labkey.remoteapi.test.Test

execute(Connection, String) - Method in class org.labkey.remoteapi.Command

Executes the command in the given folder on the specified connection, and returns information about the response.

execute(Connection, String) - Method in interface org.labkey.remoteapi.query.BaseSelect

ExecuteSqlCommand - Class in org.labkey.remoteapi.query

Command for executing arbitrary LabKey SQL.

ExecuteSqlCommand(String) - Constructor for class org.labkey.remoteapi.query.ExecuteSqlCommand

Constructs an ExecuteSqlCommand, initialized with a schema name.

ExecuteSqlCommand(String, String) - Constructor for class org.labkey.remoteapi.query.ExecuteSqlCommand

Constructs an ExecuteSqlCommand, initialized with a schema name and SQL query.

executeSqlDemo() - Method in class org.labkey.remoteapi.test.Demo

EXP_CHILD_OF - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

EXP_LINEAGE_OF - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

EXP_PARENT_OF - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

ExpObject - Class in org.labkey.remoteapi.assay

Base class for experiment objects, including Run, Data, Batch, etc

ExpObject() - Constructor for class org.labkey.remoteapi.assay.ExpObject

ExpObject(JSONObject) - Constructor for class org.labkey.remoteapi.assay.ExpObject

F

file - Enum constant in enum class org.labkey.remoteapi.query.ImportDataCommand.ImportDataType

FileNotificationCommand - Class in org.labkey.remoteapi.pipeline

Notifies the server that files may have become available for the pipeline to process.

FileNotificationCommand() - Constructor for class org.labkey.remoteapi.pipeline.FileNotificationCommand

FileNotificationResponse - Class in org.labkey.remoteapi.pipeline

Server response from FileNotificationCommand.

FileNotificationResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.pipeline.FileNotificationResponse

Filter - Class in org.labkey.remoteapi.query

Represents a filter definition for a query

Filter(String, Object) - Constructor for class org.labkey.remoteapi.query.Filter

Constructs a new equality Filter for the given column name and value.

Filter(String, Object, Filter.Operator) - Constructor for class org.labkey.remoteapi.query.Filter

Constructs a filter with a given column name, value and operator.

Filter(Filter) - Constructor for class org.labkey.remoteapi.query.Filter

Filter.Operator - Enum Class in org.labkey.remoteapi.query

findContainer(String[], int, Map<String, Object>) - Method in class org.labkey.remoteapi.security.GetContainersResponse

findContainer(String, Map<String, Object>) - Method in class org.labkey.remoteapi.security.GetContainersResponse

findObject(List<Map<String, Object>>, String, String) - Method in class org.labkey.remoteapi.CommandResponse

Finds, in a List of Maps, the first Map containing an entry that matches propertyName and value matches the value supplied.

FLOAT - Enum constant in enum class org.labkey.remoteapi.query.SelectRowsResponse.ColumnDataType

Freezer - Enum constant in enum class org.labkey.remoteapi.storage.StorageItemTypes

fromJSON(JSONObject) - Static method in class org.labkey.remoteapi.domain.ConditionalFormat

Populate new ConditionalFormat bean with deserialized JSON

G

generate(String, long) - Method in class org.labkey.remoteapi.totp.CodeGenerator

generateCode(String) - Static method in class org.labkey.remoteapi.totp.TotpManager

generateCode(String, int, int, HashingAlgorithm) - Static method in class org.labkey.remoteapi.totp.TotpManager

get(Object) - Method in class org.labkey.remoteapi.collections.CaseInsensitiveHashMap

get(String) - Method in class org.labkey.remoteapi.collections.CaseInsensitiveHashMap

getAbsolutePath() - Method in class org.labkey.remoteapi.assay.Data

getActionName() - Method in class org.labkey.remoteapi.Command

Returns the action name specified when constructing this object.

getAllowBackgroundUpload() - Method in class org.labkey.remoteapi.assay.Protocol

getAllowEditableResults() - Method in class org.labkey.remoteapi.assay.Protocol

getAllowPlateMetadata() - Method in class org.labkey.remoteapi.assay.Protocol

getAllowQCStates() - Method in class org.labkey.remoteapi.assay.Protocol

getAllowSpacesInPath() - Method in class org.labkey.remoteapi.assay.Protocol

getAllowTransformationScript() - Method in class org.labkey.remoteapi.assay.Protocol

getAllProperties() - Method in class org.labkey.remoteapi.ResponseObject

getAssayDescription() - Method in class org.labkey.remoteapi.assay.nab.NAbRunsResponse

getAssayId() - Method in class org.labkey.remoteapi.assay.ImportRunResponse

getAssayId() - Method in class org.labkey.remoteapi.assay.nab.NAbRunsResponse

getAssayId() - Method in class org.labkey.remoteapi.assay.SaveAssayBatchResponse

getAssayName() - Method in class org.labkey.remoteapi.assay.nab.NAbRunsCommand

getAssayName() - Method in class org.labkey.remoteapi.assay.nab.NAbRunsResponse

GetAssayRunCommand - Class in org.labkey.remoteapi.assay

Command for obtaining information about a run in a particular folder.

GetAssayRunCommand(String) - Constructor for class org.labkey.remoteapi.assay.GetAssayRunCommand

GetAssayRunResponse - Class in org.labkey.remoteapi.assay

GetAssayRunResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.assay.GetAssayRunResponse

Constructs a new CommandResponse, initialized with the provided response text and status code.

getAsymmetry() - Method in class org.labkey.remoteapi.assay.nab.model.NAbCurveParameters

getAuditBehavior() - Method in class org.labkey.remoteapi.query.SaveRowsCommand

getAuditUserComment() - Method in class org.labkey.remoteapi.query.SaveRowsCommand

getAuthHeaderValue() - Method in exception org.labkey.remoteapi.CommandException

Returns the value of the WWW-Authenticate header

getAutoCopyTargetContainerId() - Method in class org.labkey.remoteapi.assay.Protocol

getAvailableDetectionMethods() - Method in class org.labkey.remoteapi.assay.Protocol

getAvailableMetadataInputFormats() - Method in class org.labkey.remoteapi.assay.Protocol

getAvailablePlateTemplates() - Method in class org.labkey.remoteapi.assay.Protocol

getAverageNeutralization(Connection, String, String, int) - Static method in class org.labkey.remoteapi.test.Test

getBackgroundColor() - Method in class org.labkey.remoteapi.domain.ConditionalFormat

Get conditional background color.

getBackgroundUpload() - Method in class org.labkey.remoteapi.assay.Protocol

getBaseURI() - Method in class org.labkey.remoteapi.Connection

Returns the base URI for this connection.

getBatch() - Method in class org.labkey.remoteapi.assay.LoadAssayBatchCommand

getBatch() - Method in class org.labkey.remoteapi.assay.LoadAssayBatchResponse

getBatch() - Method in class org.labkey.remoteapi.assay.SaveAssayBatchResponse

getBatchId() - Method in class org.labkey.remoteapi.assay.ImportRunResponse

getBatchId() - Method in class org.labkey.remoteapi.assay.LoadAssayBatchCommand

getBold() - Method in class org.labkey.remoteapi.domain.ConditionalFormat

Get boldness flag for conditional format

getCaption() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse.Column

getCellControl() - Method in class org.labkey.remoteapi.assay.nab.model.NAbRun

getChildren() - Method in class org.labkey.remoteapi.experiment.LineageNode

getColumn() - Method in class org.labkey.remoteapi.assay.nab.model.NAbWell

getColumnDataType(String) - Method in class org.labkey.remoteapi.query.SelectRowsResponse

Returns the data type for the requested column name.

getColumnModel() - Method in class org.labkey.remoteapi.query.SelectRowsResponse

Returns the column model section of the response.

getColumnModel(String) - Method in class org.labkey.remoteapi.query.SelectRowsResponse

Returns the column properties for the specified column name.

getColumnName() - Method in class org.labkey.remoteapi.query.Filter

getColumnName() - Method in class org.labkey.remoteapi.query.Sort

getColumnNames(String) - Method in class org.labkey.remoteapi.query.GetQueriesResponse

Returns the list of column names available in the given query name.

getColumns() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse

Returns the columns available in the given query name.

getColumns() - Method in class org.labkey.remoteapi.query.SelectRowsCommand

Returns the explicit column list to be requested, or null if the default set of columns will be requested.

getCommand() - Method in class org.labkey.remoteapi.query.SaveRowsResponse

Returns the 'command' response property.

getCommand() - Method in class org.labkey.remoteapi.query.TruncateTableResponse

Returns the 'command' response property.

GetCommand<ResponseType extends CommandResponse> - Class in org.labkey.remoteapi

Base class for all commands that use get

GetCommand(String, String) - Constructor for class org.labkey.remoteapi.GetCommand

getComment() - Method in class org.labkey.remoteapi.assay.Run

getComment() - Method in class org.labkey.remoteapi.experiment.LineageNode

getConditionalFormats() - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

getContainer() - Method in class org.labkey.remoteapi.experiment.LineageNode

Container entity ID of the object.

getContainerFilter() - Method in class org.labkey.remoteapi.query.BaseQueryCommand

Returns the container filter set for this command

getContainerFilter() - Method in interface org.labkey.remoteapi.query.BaseSelect

getContainerFilter() - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

Returns the container filter set for this command

getContainerId() - Method in class org.labkey.remoteapi.assay.nab.model.NAbRun

getContainerId() - Method in class org.labkey.remoteapi.security.GetContainersResponse

getContainerPath() - Method in class org.labkey.remoteapi.assay.nab.model.NAbRun

getContainerPath() - Method in class org.labkey.remoteapi.domain.ListDomainsCommand

getContainerPath() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse.Lookup

getContainerPath() - Method in class org.labkey.remoteapi.security.GetUsersResponse

GetContainersCommand - Class in org.labkey.remoteapi.security

GetContainersCommand() - Constructor for class org.labkey.remoteapi.security.GetContainersCommand

GetContainersResponse - Class in org.labkey.remoteapi.security

GetContainersResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.security.GetContainersResponse

getContentLength() - Method in class org.labkey.remoteapi.Command.Response

getContentType() - Method in class org.labkey.remoteapi.Command.Response

getContentType() - Method in exception org.labkey.remoteapi.CommandException

getContentType() - Method in class org.labkey.remoteapi.CommandResponse

Returns the Content-Type header value from the response.

getControllerName() - Method in class org.labkey.remoteapi.Command

Returns the controller name specified when constructing this object.

getCopy() - Method in class org.labkey.remoteapi.assay.GetProtocolCommand

getCpasType() - Method in class org.labkey.remoteapi.experiment.LineageNode

The CPAS type of the object as an LSID.

getCreated() - Method in class org.labkey.remoteapi.experiment.LineageNode

getCreatedBy() - Method in class org.labkey.remoteapi.experiment.LineageNode

getCredentialsProvider() - Method in class org.labkey.remoteapi.Connection

getCSRF() - Method in class org.labkey.remoteapi.security.WhoAmIResponse

getCurveBasedDilution() - Method in class org.labkey.remoteapi.assay.nab.model.NAbNeutralizationResult

getCutoff() - Method in class org.labkey.remoteapi.assay.nab.model.NAbNeutralizationResult

getCutoffs() - Method in class org.labkey.remoteapi.assay.nab.model.NAbRun

getData() - Method in class org.labkey.remoteapi.storage.StorageCommandResponse

Returns the data object with properties from the newly created storage item.

getDataFileURL() - Method in class org.labkey.remoteapi.assay.Data

getDataInputs() - Method in class org.labkey.remoteapi.assay.Run

getDataOutputs() - Method in class org.labkey.remoteapi.assay.Run

getDefinition(int) - Method in class org.labkey.remoteapi.assay.AssayListResponse

Returns an assay definition for the assay identified by the specified id.

getDefinition(String) - Method in class org.labkey.remoteapi.assay.AssayListResponse

Returns an assay definition for the assay identified by the specified name.

getDefinitions() - Method in class org.labkey.remoteapi.assay.AssayListResponse

Returns the definitions section of the response.

getDeletedRowCount() - Method in class org.labkey.remoteapi.query.TruncateTableResponse

Returns the 'deletedRows' response property.

getDeleteParticipantIds() - Method in class org.labkey.remoteapi.study.UpdateParticipantGroupCommand.UpdatedParticipantGroup

getDerivationDataScope() - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

getDescription() - Method in class org.labkey.remoteapi.assay.Protocol

getDescription() - Method in class org.labkey.remoteapi.domain.Domain

getDescription() - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

getDescription() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse.Column

getDescription() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse

Returns the description of the query described by this response

getDescription() - Method in class org.labkey.remoteapi.security.CreateContainerCommand

getDescription() - Method in class org.labkey.remoteapi.study.ParticipantGroup

getDescriptionId() - Method in class org.labkey.remoteapi.di.UpdateTransformConfigurationResponse

getDilution() - Method in class org.labkey.remoteapi.assay.nab.model.NAbReplicate

getDimension() - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

getDirection() - Method in class org.labkey.remoteapi.query.Sort

getDisplayColumn() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse.Lookup

getDisplayName() - Method in class org.labkey.remoteapi.security.GetUsersResponse.UserInfo

getDisplayName() - Method in class org.labkey.remoteapi.security.WhoAmIResponse

getDisplayValue() - Method in enum class org.labkey.remoteapi.query.Filter.Operator

getDisplayValue(String) - Method in interface org.labkey.remoteapi.query.Row

Returns a column's display value (if different from value).

getDisplayValue(String) - Method in class org.labkey.remoteapi.query.RowMap

getDomain() - Method in class org.labkey.remoteapi.domain.DomainDetailsResponse

Get the Domain deserialized from the server's response

getDomain() - Method in class org.labkey.remoteapi.domain.DomainResponse

Get the Domain deserialized from the server's response

getDomainDesign() - Method in class org.labkey.remoteapi.domain.SaveDomainCommand

Get the domain design that will be POSTed by this command.

GetDomainDetailsCommand - Class in org.labkey.remoteapi.domain

GetDomainDetailsCommand(Long) - Constructor for class org.labkey.remoteapi.domain.GetDomainDetailsCommand

GetDomainDetailsCommand(String, String) - Constructor for class org.labkey.remoteapi.domain.GetDomainDetailsCommand

getDomainId() - Method in class org.labkey.remoteapi.domain.Domain

getDomainId() - Method in class org.labkey.remoteapi.domain.GetDomainDetailsCommand

getDomainKinds() - Method in class org.labkey.remoteapi.domain.ListDomainsCommand

getDomains() - Method in class org.labkey.remoteapi.assay.Protocol

getDomains() - Method in class org.labkey.remoteapi.domain.ListDomainsResponse

getDomainURI() - Method in class org.labkey.remoteapi.domain.Domain

getEditableResults() - Method in class org.labkey.remoteapi.assay.Protocol

getEditableRuns() - Method in class org.labkey.remoteapi.assay.Protocol

getEmail() - Method in class org.labkey.remoteapi.security.CreateUserCommand

getEmail() - Method in class org.labkey.remoteapi.security.CreateUserResponse

getEmail() - Method in class org.labkey.remoteapi.security.GetUsersResponse.UserInfo

getEmail() - Method in class org.labkey.remoteapi.security.WhoAmIResponse

getEnabled() - Method in class org.labkey.remoteapi.di.UpdateTransformConfigurationCommand

getEnabled() - Method in class org.labkey.remoteapi.di.UpdateTransformConfigurationResponse

getEnsureParticipantIds() - Method in class org.labkey.remoteapi.study.UpdateParticipantGroupCommand.UpdatedParticipantGroup

getEntry(File, String) - Method in class org.labkey.remoteapi.NetrcFileParser

getEntry(String) - Method in class org.labkey.remoteapi.NetrcFileParser

getExpType() - Method in class org.labkey.remoteapi.experiment.LineageNode

The Experiment type of the object.

getExtraContext() - Method in class org.labkey.remoteapi.query.SaveRowsCommand

Gets the additional extra context.

getFieldKey() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse.Column

getFields() - Method in class org.labkey.remoteapi.domain.Domain

getFieldSeparator() - Method in class org.labkey.remoteapi.query.SqlExecuteCommand

getFiles() - Method in class org.labkey.remoteapi.ms2.StartSearchCommand

getFilters() - Method in class org.labkey.remoteapi.query.BaseQueryCommand

Returns the current list of filters, or null if none are defined.

getFitError() - Method in class org.labkey.remoteapi.assay.nab.model.NAbSample

getFitParameters() - Method in class org.labkey.remoteapi.assay.nab.model.NAbSample

getFolderType() - Method in class org.labkey.remoteapi.security.CreateContainerCommand

getFormat() - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

getFormat() - Method in class org.labkey.remoteapi.query.ImportDataCommand

getFriendlyName() - Method in enum class org.labkey.remoteapi.totp.HashingAlgorithm

getGroup() - Method in class org.labkey.remoteapi.security.GetUsersCommand

getGroupId() - Method in class org.labkey.remoteapi.security.CreateGroupResponse

getGroupId() - Method in class org.labkey.remoteapi.security.DeleteGroupCommand

getGroupId() - Method in class org.labkey.remoteapi.security.GetUsersCommand

getGroupId() - Method in class org.labkey.remoteapi.security.GroupMembersCommand

getGroupId() - Method in class org.labkey.remoteapi.security.RenameGroupCommand

GetGroupPermsCommand - Class in org.labkey.remoteapi.security

GetGroupPermsCommand() - Constructor for class org.labkey.remoteapi.security.GetGroupPermsCommand

GetGroupPermsResponse - Class in org.labkey.remoteapi.security

GetGroupPermsResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.security.GetGroupPermsResponse

getHeaderValue(String) - Method in class org.labkey.remoteapi.Command.Response

getHidden() - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

getHmacAlgorithm() - Method in enum class org.labkey.remoteapi.totp.HashingAlgorithm

getHttpClient() - Method in class org.labkey.remoteapi.Connection

Returns the CloseableHttpClient object to use for this connection.

getHttpRequest(Connection, String) - Method in class org.labkey.remoteapi.Command

Returns the appropriate, initialized HttpUriRequest implementation.

getId() - Method in class org.labkey.remoteapi.assay.AssayListCommand

Returns the current assay id filter (if any).

getId() - Method in class org.labkey.remoteapi.assay.ExpObject

getId() - Method in class org.labkey.remoteapi.experiment.LineageNode

getId() - Method in class org.labkey.remoteapi.security.CreateContainerResponse

getIdColumn() - Method in class org.labkey.remoteapi.query.SelectRowsResponse

Returns the name of the column containing the primary key value for each row.

getIncludeChildWorkbooks() - Method in class org.labkey.remoteapi.security.GetContainersCommand

getIncludeDeactivated() - Method in class org.labkey.remoteapi.security.GetUsersCommand

Deprecated, for removal: This API element is subject to removal in a future version.

getIncludeEffectivePermissions() - Method in class org.labkey.remoteapi.security.GetContainersCommand

getIncludeInactive() - Method in class org.labkey.remoteapi.security.GetUsersCommand

getIncludeStandardProperties() - Method in class org.labkey.remoteapi.security.GetContainersCommand

getInflection() - Method in class org.labkey.remoteapi.assay.nab.model.NAbCurveParameters

getInputStream() - Method in class org.labkey.remoteapi.Command.Response

getInsertOption() - Method in class org.labkey.remoteapi.query.ImportDataCommand

getItalic() - Method in class org.labkey.remoteapi.domain.ConditionalFormat

Get italic flag for conditional format

getJobId() - Method in class org.labkey.remoteapi.di.RunTransformResponse

getJobId() - Method in class org.labkey.remoteapi.query.ImportDataResponse

When importing a file asynchronously, the jobId of the queued job is returned.

getJsonObject() - Method in class org.labkey.remoteapi.assay.AssayListCommand

getJsonObject() - Method in class org.labkey.remoteapi.assay.GetAssayRunCommand

getJsonObject() - Method in class org.labkey.remoteapi.assay.LoadAssayBatchCommand

getJsonObject() - Method in class org.labkey.remoteapi.assay.nab.NAbRunsCommand

getJsonObject() - Method in class org.labkey.remoteapi.assay.SaveAssayBatchCommand

getJsonObject() - Method in class org.labkey.remoteapi.assay.SaveAssayRunsCommand

getJsonObject() - Method in class org.labkey.remoteapi.assay.SaveProtocolCommand

getJsonObject() - Method in class org.labkey.remoteapi.di.BaseTransformCommand

getJsonObject() - Method in class org.labkey.remoteapi.di.UpdateTransformConfigurationCommand

getJsonObject() - Method in class org.labkey.remoteapi.domain.CreateDomainCommand

getJsonObject() - Method in class org.labkey.remoteapi.domain.DropDomainCommand

getJsonObject() - Method in class org.labkey.remoteapi.domain.ListDomainsCommand

getJsonObject() - Method in class org.labkey.remoteapi.domain.SaveDomainCommand

getJsonObject() - Method in class org.labkey.remoteapi.PostCommand

Returns the JSON object to post or null for no JSON.

getJsonObject() - Method in class org.labkey.remoteapi.query.BaseQueryCommand

getJsonObject() - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

getJsonObject() - Method in class org.labkey.remoteapi.query.ImportDataCommand

getJsonObject() - Method in class org.labkey.remoteapi.query.MoveRowsCommand

getJsonObject() - Method in class org.labkey.remoteapi.query.SaveRowsCommand

Dynamically builds the JSON object to send based on the current schema name, query name and rows list.

getJsonObject() - Method in class org.labkey.remoteapi.query.SelectRowsCommand

getJsonObject() - Method in class org.labkey.remoteapi.query.SqlExecuteCommand

getJsonObject() - Method in class org.labkey.remoteapi.query.TruncateTableCommand

getJsonObject() - Method in class org.labkey.remoteapi.security.CreateContainerCommand

getJsonObject() - Method in class org.labkey.remoteapi.security.CreateGroupCommand

getJsonObject() - Method in class org.labkey.remoteapi.security.CreateUserCommand

getJsonObject() - Method in class org.labkey.remoteapi.security.DeleteGroupCommand

getJsonObject() - Method in class org.labkey.remoteapi.security.DeleteUserCommand

getJsonObject() - Method in class org.labkey.remoteapi.security.GroupMembersCommand

getJsonObject() - Method in class org.labkey.remoteapi.security.RenameContainerCommand

getJsonObject() - Method in class org.labkey.remoteapi.security.RenameGroupCommand

getJsonObject() - Method in class org.labkey.remoteapi.SimplePostCommand

Returns the JSON object to post or null for no JSON.

getJsonObject() - Method in class org.labkey.remoteapi.storage.BaseStorageCommand

Dynamically builds the JSON object to send based on the storageRow.

getJsonObject() - Method in class org.labkey.remoteapi.study.UpdateParticipantGroupCommand

getKeyColumn() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse.Lookup

getKind() - Method in class org.labkey.remoteapi.domain.CreateDomainCommand

getKind() - Method in class org.labkey.remoteapi.domain.DomainDetailsResponse

getLabel() - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

getLabel() - Method in class org.labkey.remoteapi.study.ParticipantGroup

getLastChecked() - Method in class org.labkey.remoteapi.di.UpdateTransformConfigurationResponse

getLineSeparator() - Method in class org.labkey.remoteapi.query.SqlExecuteCommand

getLogin() - Method in class org.labkey.remoteapi.NetrcFileParser.NetrcEntry

getLookup() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse.Column

getLsid() - Method in class org.labkey.remoteapi.assay.GetAssayRunCommand

getLsid() - Method in class org.labkey.remoteapi.assay.Run

getLsid() - Method in class org.labkey.remoteapi.experiment.LineageNode

getMachine() - Method in class org.labkey.remoteapi.NetrcFileParser.NetrcEntry

getMaterialInputs() - Method in class org.labkey.remoteapi.assay.Run

getMaterialOutputs() - Method in class org.labkey.remoteapi.assay.Run

getMax() - Method in class org.labkey.remoteapi.assay.nab.model.NAbCurveParameters

getMax() - Method in class org.labkey.remoteapi.assay.nab.model.NAbWellGroup

getMaxDilution() - Method in class org.labkey.remoteapi.assay.nab.model.NAbSample

getMaxRows() - Method in class org.labkey.remoteapi.query.BaseQueryCommand

Returns the current row limit value.

getMaxRows() - Method in interface org.labkey.remoteapi.query.BaseSelect

getMaxRows() - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

Returns the current row limit value.

getMean() - Method in class org.labkey.remoteapi.assay.nab.model.NAbWellGroup

getMeasure() - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

getMessage() - Method in class org.labkey.remoteapi.security.CreateUserResponse

getMessage() - Method in class org.labkey.remoteapi.storage.StorageCommandResponse

Returns the success message for the command.

getMetaData() - Method in class org.labkey.remoteapi.query.SelectRowsResponse

Returns the meta-data section of the response.

getMetaData(String) - Method in class org.labkey.remoteapi.query.SelectRowsResponse

Returns the meta-data for a given column name.

getMin() - Method in class org.labkey.remoteapi.assay.nab.model.NAbCurveParameters

getMin() - Method in class org.labkey.remoteapi.assay.nab.model.NAbWellGroup

getMinDilution() - Method in class org.labkey.remoteapi.assay.nab.model.NAbSample

getModified() - Method in class org.labkey.remoteapi.experiment.LineageNode

getModifiedBy() - Method in class org.labkey.remoteapi.experiment.LineageNode

getMvEnabled() - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

getMvRawValue(String) - Method in interface org.labkey.remoteapi.query.Row

Returns the column's missing-value raw value.

getMvRawValue(String) - Method in class org.labkey.remoteapi.query.RowMap

getMvValue(String) - Method in interface org.labkey.remoteapi.query.Row

Returns a column's missing-value indicator.

getMvValue(String) - Method in class org.labkey.remoteapi.query.RowMap

getName() - Method in class org.labkey.remoteapi.assay.AssayListCommand

Returns the assay name filter upon (if any)

getName() - Method in class org.labkey.remoteapi.assay.ExpObject

getName() - Method in class org.labkey.remoteapi.assay.Protocol

getName() - Method in class org.labkey.remoteapi.domain.Domain

getName() - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

getName() - Method in class org.labkey.remoteapi.experiment.LineageNode

getName() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse.Column

getName() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse

Returns the query name that is described by this response

getName() - Method in class org.labkey.remoteapi.security.CreateContainerCommand

getName() - Method in class org.labkey.remoteapi.security.CreateContainerResponse

getName() - Method in class org.labkey.remoteapi.security.CreateGroupCommand

getName() - Method in class org.labkey.remoteapi.security.GetUsersCommand

getName() - Method in class org.labkey.remoteapi.security.RenameContainerCommand

getName() - Method in class org.labkey.remoteapi.security.RenameContainerResponse

getNeutPercent() - Method in class org.labkey.remoteapi.assay.nab.model.NAbReplicate

getNeutPlusMinus() - Method in class org.labkey.remoteapi.assay.nab.model.NAbReplicate

getNeutralizationResults() - Method in class org.labkey.remoteapi.assay.nab.model.NAbSample

getNewName() - Method in class org.labkey.remoteapi.security.RenameGroupCommand

getNewName() - Method in class org.labkey.remoteapi.security.RenameGroupResponse

getNode() - Method in class org.labkey.remoteapi.experiment.LineageNode.Edge

getNodes() - Method in class org.labkey.remoteapi.experiment.LineageResponse

getObjectId() - Method in class org.labkey.remoteapi.assay.nab.model.NAbSample

getOffset() - Method in class org.labkey.remoteapi.query.BaseQueryCommand

Returns the index of the first row in the resultset to return (defaults to 0).

getOffset() - Method in interface org.labkey.remoteapi.query.BaseSelect

getOffset() - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

Returns the index of the first row in the resultset to return (defaults to 0).

getOldName() - Method in class org.labkey.remoteapi.security.RenameGroupResponse

getOperator() - Method in class org.labkey.remoteapi.query.Filter

getOperator(String) - Static method in enum class org.labkey.remoteapi.query.Filter.Operator

getOperatorFromUrlKey(String) - Static method in enum class org.labkey.remoteapi.query.Filter.Operator

getOptions() - Method in class org.labkey.remoteapi.domain.CreateDomainCommand

Get the 'options' map for the domain to be created.

getOptions() - Method in class org.labkey.remoteapi.domain.DomainDetailsResponse

getOrDefault(Object, V) - Method in class org.labkey.remoteapi.collections.CaseInsensitiveHashMap

getParameters() - Method in class org.labkey.remoteapi.Command

Makes an immutable copy of the parameter map used for building the URL available to callers.

getParamValueAsString(Object, String) - Method in class org.labkey.remoteapi.Command

Returns an appropriate string encoding of the parameter value.

getParents() - Method in class org.labkey.remoteapi.experiment.LineageNode

getParsedData() - Method in class org.labkey.remoteapi.CommandResponse

Attempts to parse the response text and return a property Map.

getParticipantGroup() - Method in class org.labkey.remoteapi.study.UpdateParticipantGroupResponse

getParticipantIds() - Method in class org.labkey.remoteapi.study.ParticipantGroup

getPassword() - Method in class org.labkey.remoteapi.NetrcFileParser.NetrcEntry

getPath() - Method in class org.labkey.remoteapi.ms2.StartSearchCommand

getPath() - Method in class org.labkey.remoteapi.security.CreateContainerResponse

getPath() - Method in class org.labkey.remoteapi.security.RenameContainerResponse

getPHI() - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

getPipelinePath() - Method in class org.labkey.remoteapi.assay.Data

getPipelineURL() - Method in class org.labkey.remoteapi.di.RunTransformResponse

getPkFilters() - Method in class org.labkey.remoteapi.experiment.LineageNode

getPlateMetadata() - Method in class org.labkey.remoteapi.assay.Protocol

getPlateMetadata() - Method in class org.labkey.remoteapi.assay.Run

getPointBasedDilution() - Method in class org.labkey.remoteapi.assay.nab.model.NAbNeutralizationResult

getPostData() - Method in class org.labkey.remoteapi.security.BaseCreateFolderCommand

getPostData() - Method in class org.labkey.remoteapi.security.CreateProjectCommand

getPrincipals() - Method in class org.labkey.remoteapi.security.GroupMembersCommand

getProgrammaticName() - Method in enum class org.labkey.remoteapi.query.Filter.Operator

getProperties() - Method in class org.labkey.remoteapi.assay.ExpObject

getProperties() - Method in class org.labkey.remoteapi.assay.nab.model.NAbRun

getProperties() - Method in class org.labkey.remoteapi.assay.nab.model.NAbSample

getProperties() - Method in exception org.labkey.remoteapi.CommandException

Returns the exception property map, or null if no map was set.

getProperties() - Method in class org.labkey.remoteapi.experiment.LineageNode

getProperties() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse.Column

getProperty(String) - Method in class org.labkey.remoteapi.CommandResponse

Returns the value of a specific property in the parsed data given a path to that property.

getProperty(String) - Method in class org.labkey.remoteapi.test.ClientConfig

Gets a property of the given name.

getProperty(String[], int, Map<String, Object>) - Method in class org.labkey.remoteapi.CommandResponse

Called by CommandResponse.getProperty(String) after splitting the path into a String[], and recursively by itself as it descends the property hierarchy.

getProperty(String, String) - Method in class org.labkey.remoteapi.test.ClientConfig

getPropertyId() - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

getPropertyURI() - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

getProps() - Method in class org.labkey.remoteapi.storage.StorageRow

getProtocol() - Method in class org.labkey.remoteapi.assay.ProtocolResponse

getProtocol() - Method in class org.labkey.remoteapi.ms2.StartSearchCommand

GetProtocolCommand - Class in org.labkey.remoteapi.assay

GetProtocolCommand(long) - Constructor for class org.labkey.remoteapi.assay.GetProtocolCommand

GetProtocolCommand(long, boolean) - Constructor for class org.labkey.remoteapi.assay.GetProtocolCommand

GetProtocolCommand(String) - Constructor for class org.labkey.remoteapi.assay.GetProtocolCommand

getProtocolId() - Method in class org.labkey.remoteapi.assay.GetProtocolCommand

getProtocolId() - Method in class org.labkey.remoteapi.assay.Protocol

getProtocolName() - Method in class org.labkey.remoteapi.assay.LoadAssayBatchCommand

getProtocolName() - Method in class org.labkey.remoteapi.assay.SaveAssayRunsCommand

getProtocolParameters() - Method in class org.labkey.remoteapi.assay.Protocol

getProtocolTransformScripts() - Method in class org.labkey.remoteapi.assay.Protocol

getProviderName() - Method in class org.labkey.remoteapi.assay.GetProtocolCommand

getProviderName() - Method in class org.labkey.remoteapi.assay.Protocol

getQcEnabled() - Method in class org.labkey.remoteapi.assay.Protocol

GetQueriesCommand - Class in org.labkey.remoteapi.query

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

GetQueriesCommand(String) - Constructor for class org.labkey.remoteapi.query.GetQueriesCommand

Constructs the command given a particular schema name.

GetQueriesResponse - Class in org.labkey.remoteapi.query

Represents the response from a GetQueriesCommand.

GetQueriesResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.query.GetQueriesResponse

GetQueryDetailsCommand - Class in org.labkey.remoteapi.query

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

GetQueryDetailsCommand(String, String) - Constructor for class org.labkey.remoteapi.query.GetQueryDetailsCommand

Constructs the command given a particular schema name.

GetQueryDetailsCommand(String, String, boolean) - Constructor for class org.labkey.remoteapi.query.GetQueryDetailsCommand

Constructs the command given a particular schema name.

GetQueryDetailsResponse - Class in org.labkey.remoteapi.query

Represents the response from a GetQueriesCommand.

GetQueryDetailsResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.query.GetQueryDetailsResponse

GetQueryDetailsResponse.Column - Class in org.labkey.remoteapi.query

GetQueryDetailsResponse.Lookup - Class in org.labkey.remoteapi.query

getQueryFilter() - Method in class org.labkey.remoteapi.domain.ConditionalFormat

Get conditional format conditions

getQueryName() - Method in class org.labkey.remoteapi.domain.DropDomainCommand

getQueryName() - Method in class org.labkey.remoteapi.domain.GetDomainDetailsCommand

getQueryName() - Method in class org.labkey.remoteapi.experiment.LineageNode

getQueryName() - Method in class org.labkey.remoteapi.query.GetQueryDetailsCommand

getQueryName() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse.Lookup

getQueryName() - Method in class org.labkey.remoteapi.query.ImportDataCommand

Returns the query name

getQueryName() - Method in class org.labkey.remoteapi.query.SaveRowsCommand

Returns the query name

getQueryName() - Method in class org.labkey.remoteapi.query.SaveRowsResponse

Returns the 'queryName' response property.

getQueryName() - Method in class org.labkey.remoteapi.query.SelectRowsCommand

Returns the query this command will request.

getQueryName() - Method in class org.labkey.remoteapi.query.TruncateTableCommand

Returns the query name

getQueryName() - Method in class org.labkey.remoteapi.query.TruncateTableResponse

Returns the 'queryName' response property.

getQueryNames() - Method in class org.labkey.remoteapi.query.GetQueriesResponse

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

getQueryParameters() - Method in class org.labkey.remoteapi.query.BaseQueryCommand

getQueryParameters() - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

Map of name (string)/value pairs for the values of parameters if the SQL references underlying queries that are parameterized.

getQueryParameters() - Method in class org.labkey.remoteapi.query.SqlExecuteCommand

Map of name (string)/value pairs for the values of parameters if the SQL references underlying queries that are parameterized.

getQueryStringParamName() - Method in class org.labkey.remoteapi.query.Filter

Returns the query string parameter name for this filter.

getQueryStringParamValue() - Method in class org.labkey.remoteapi.query.Filter

Returns the query string parameter value (not URL-encoded).

getRangeURI() - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

getReader() - Method in class org.labkey.remoteapi.Command.Response

getReplicates() - Method in class org.labkey.remoteapi.assay.nab.model.NAbSample

getRequired() - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

getRequiredVersion() - Method in class org.labkey.remoteapi.assay.SaveProtocolCommand

getRequiredVersion() - Method in class org.labkey.remoteapi.Command

Returns the required version number of this API call.

getRequiredVersion() - Method in interface org.labkey.remoteapi.HasRequiredVersion

getRequiredVersion() - Method in interface org.labkey.remoteapi.query.BaseSelect

getRequiredVersion() - Method in class org.labkey.remoteapi.storage.BaseStorageCommand

getResponseText() - Method in exception org.labkey.remoteapi.CommandException

Returns the text of the response

getResult() - Method in class org.labkey.remoteapi.di.UpdateTransformConfigurationResponse

getRole() - Method in class org.labkey.remoteapi.experiment.LineageNode.Edge

getRow() - Method in class org.labkey.remoteapi.assay.nab.model.NAbWell

getRowCount() - Method in class org.labkey.remoteapi.query.ImportDataResponse

getRowCount() - Method in class org.labkey.remoteapi.query.SelectRowsResponse

Returns the number of rows this query could return.

getRowId() - Method in class org.labkey.remoteapi.storage.StorageCommandResponse

getRowId() - Method in class org.labkey.remoteapi.study.ParticipantGroup

getRows() - Method in class org.labkey.remoteapi.query.SelectRowsResponse

Returns the list of rows from the parsed response data.

getRows() - Method in class org.labkey.remoteapi.query.SaveRowsCommand

Returns the current list of 'rows' (i.e., Maps) that will be sent to the server.

getRowsAffected() - Method in class org.labkey.remoteapi.query.SaveRowsResponse

Returns the 'rowsAffected' response property.

getRowset() - Method in class org.labkey.remoteapi.query.SelectRowsResponse

Returns an iterable Rowset.

getRun() - Method in class org.labkey.remoteapi.assay.GetAssayRunResponse

getRunId() - Method in class org.labkey.remoteapi.assay.ImportRunResponse

getRunId() - Method in class org.labkey.remoteapi.assay.nab.model.NAbRun

getRuns() - Method in class org.labkey.remoteapi.assay.Batch

getRuns() - Method in class org.labkey.remoteapi.assay.nab.NAbRunsResponse

getRuns() - Method in class org.labkey.remoteapi.assay.SaveAssayRunsCommand

getRuns() - Method in class org.labkey.remoteapi.assay.SaveAssayRunsResponse

getSamples() - Method in class org.labkey.remoteapi.assay.nab.model.NAbRun

getSampleSetId() - Method in class org.labkey.remoteapi.assay.Material

getSampleSetName() - Method in class org.labkey.remoteapi.assay.Material

getSaveScriptFiles() - Method in class org.labkey.remoteapi.assay.Protocol

getSchemaName() - Method in class org.labkey.remoteapi.domain.DropDomainCommand

getSchemaName() - Method in class org.labkey.remoteapi.domain.GetDomainDetailsCommand

getSchemaName() - Method in class org.labkey.remoteapi.experiment.LineageNode

getSchemaName() - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

Returns the current schema name.

getSchemaName() - Method in class org.labkey.remoteapi.query.GetQueriesCommand

getSchemaName() - Method in class org.labkey.remoteapi.query.GetQueriesResponse

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

getSchemaName() - Method in class org.labkey.remoteapi.query.GetQueryDetailsCommand

getSchemaName() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse

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

getSchemaName() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse.Lookup

getSchemaName() - Method in class org.labkey.remoteapi.query.ImportDataCommand

Returns the schema name.

getSchemaName() - Method in class org.labkey.remoteapi.query.SaveRowsCommand

Returns the schema name.

getSchemaName() - Method in class org.labkey.remoteapi.query.SaveRowsResponse

Returns the 'schemaName' response property.

getSchemaName() - Method in class org.labkey.remoteapi.query.SelectRowsCommand

Returns the current schema name this command will query.

getSchemaName() - Method in class org.labkey.remoteapi.query.SqlExecuteCommand

getSchemaName() - Method in class org.labkey.remoteapi.query.TruncateTableCommand

Returns the schema name.

getSchemaName() - Method in class org.labkey.remoteapi.query.TruncateTableResponse

Returns the 'schemaName' response property.

getSchemaNames() - Method in class org.labkey.remoteapi.query.GetSchemasResponse

Returns the list of schema names available in the folder path in which this command was executed.

GetSchemasCommand - Class in org.labkey.remoteapi.query

Command to obtain the list of schemas available in a given folder path.

GetSchemasCommand() - Constructor for class org.labkey.remoteapi.query.GetSchemasCommand

GetSchemasResponse - Class in org.labkey.remoteapi.query

Represents the response of a GetSchemasCommand.

GetSchemasResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.query.GetSchemasResponse

getSeed() - Method in class org.labkey.remoteapi.experiment.LineageResponse

getSeeds() - Method in class org.labkey.remoteapi.experiment.LineageResponse

getSelectedDetectionMethod() - Method in class org.labkey.remoteapi.assay.Protocol

getSelectedMetadataInputFormat() - Method in class org.labkey.remoteapi.assay.Protocol

getSelectedPlateTemplate() - Method in class org.labkey.remoteapi.assay.Protocol

getSize() - Method in interface org.labkey.remoteapi.query.Rowset

getSize() - Method in class org.labkey.remoteapi.query.RowsResponseRowset

getSlope() - Method in class org.labkey.remoteapi.assay.nab.model.NAbCurveParameters

getSortQueryStringParam(List<Sort>) - Static method in class org.labkey.remoteapi.query.Sort

Constructs the sort query string parameter from the current list of sort definitions.

getSorts() - Method in class org.labkey.remoteapi.query.BaseQueryCommand

Returns the current list of sort definitions.

getSorts() - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

A sort specification to apply over the rows returned by the SQL.

getSql() - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

Returns the current SQL query.

getSql() - Method in class org.labkey.remoteapi.query.SqlExecuteCommand

Returns the current SQL query.

getState() - Method in class org.labkey.remoteapi.di.UpdateTransformConfigurationResponse

getStatus() - Method in class org.labkey.remoteapi.di.RunTransformResponse

getStatusCode() - Method in class org.labkey.remoteapi.Command.Response

getStatusCode() - Method in exception org.labkey.remoteapi.CommandException

Returns the HTTP status code returned by the server.

getStatusCode() - Method in class org.labkey.remoteapi.CommandResponse

Returns the HTTP status code (typically 200).

getStatusText() - Method in class org.labkey.remoteapi.Command.Response

getStddev() - Method in class org.labkey.remoteapi.assay.nab.model.NAbWellGroup

getStrikethrough() - Method in class org.labkey.remoteapi.domain.ConditionalFormat

getSuccess() - Method in class org.labkey.remoteapi.di.BaseTransformResponse

getSuccess() - Method in class org.labkey.remoteapi.query.ImportDataResponse

getSuccessURL() - Method in class org.labkey.remoteapi.assay.ImportRunResponse

getText() - Method in class org.labkey.remoteapi.Command.Response

getText() - Method in class org.labkey.remoteapi.CommandResponse

Returns the raw response text.

getTextColor() - Method in class org.labkey.remoteapi.domain.ConditionalFormat

Get conditional text color.

getTime() - Method in class org.labkey.remoteapi.totp.TimeProvider

getTimeout() - Method in class org.labkey.remoteapi.Command

Returns the current timeout setting in milliseconds for this Command.

getTimeout() - Method in class org.labkey.remoteapi.Connection

The timeout used for Commands that have not established their own timeouts.

getTitle() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse

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

getTitle() - Method in class org.labkey.remoteapi.security.CreateContainerCommand

getTitle() - Method in class org.labkey.remoteapi.security.RenameContainerCommand

getTitle() - Method in enum class org.labkey.remoteapi.storage.StorageItemTypes

getTransformId() - Method in class org.labkey.remoteapi.di.BaseTransformCommand

getType() - Method in class org.labkey.remoteapi.assay.AssayListCommand

Returns the current assay type filter (if any).

getType() - Method in class org.labkey.remoteapi.experiment.LineageNode

The namespace portion of the LSID.

getType() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse.Column

getType() - Method in class org.labkey.remoteapi.security.CreateContainerCommand

getType() - Method in class org.labkey.remoteapi.storage.StorageRow

getUrl() - Method in class org.labkey.remoteapi.experiment.LineageNode

getUrl(String) - Method in interface org.labkey.remoteapi.query.Row

Returns a column's URL

getUrl(String) - Method in class org.labkey.remoteapi.query.RowMap

getUrlKey() - Method in enum class org.labkey.remoteapi.query.Filter.Operator

getUserAgent() - Method in class org.labkey.remoteapi.Connection

getUserId() - Method in class org.labkey.remoteapi.security.CreateUserResponse

getUserId() - Method in class org.labkey.remoteapi.security.DeleteUserCommand

getUserId() - Method in class org.labkey.remoteapi.security.GetUsersResponse.UserInfo

getUserId() - Method in class org.labkey.remoteapi.security.WhoAmIResponse

getUserPermissions() - Method in class org.labkey.remoteapi.security.GetContainersResponse

Deprecated, for removal: This API element is subject to removal in a future version.

getUserPermissions(String) - Method in class org.labkey.remoteapi.security.GetContainersResponse

Deprecated, for removal: This API element is subject to removal in a future version.

GetUsersCommand - Class in org.labkey.remoteapi.security

Returns a list of users given selection criteria.

GetUsersCommand() - Constructor for class org.labkey.remoteapi.security.GetUsersCommand

getUsersInfo() - Method in class org.labkey.remoteapi.security.GetUsersResponse

GetUsersResponse - Class in org.labkey.remoteapi.security

The result of a GetUsersCommand request.

GetUsersResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.security.GetUsersResponse

GetUsersResponse.UserInfo - Class in org.labkey.remoteapi.security

Information about a single user that matched the request

getValue() - Method in class org.labkey.remoteapi.assay.nab.model.NAbWell

getValue() - Method in class org.labkey.remoteapi.query.Filter

getValue(String) - Method in interface org.labkey.remoteapi.query.Row

Returns a column's raw value.

getValue(String) - Method in class org.labkey.remoteapi.query.RowMap

getVerboseLogging() - Method in class org.labkey.remoteapi.di.UpdateTransformConfigurationCommand

getVerboseLogging() - Method in class org.labkey.remoteapi.di.UpdateTransformConfigurationResponse

getViewName() - Method in class org.labkey.remoteapi.query.SelectRowsCommand

Returns the current saved view name this command will request.

getVirusControl() - Method in class org.labkey.remoteapi.assay.nab.model.NAbRun

getWafEncoding() - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

getWebPartDemo() - Method in class org.labkey.remoteapi.test.Demo

getWellgroupName() - Method in class org.labkey.remoteapi.assay.nab.model.NAbSample

getWells() - Method in class org.labkey.remoteapi.assay.nab.model.NAbWellGroup

GroupMembersCommand - Class in org.labkey.remoteapi.security

Base class for AddGroupMembersCommand and RemoveGroupMembersCommand

GroupMembersCommand(String, int) - Constructor for class org.labkey.remoteapi.security.GroupMembersCommand

GT - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

GTE - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

GuestCredentialsProvider - Class in org.labkey.remoteapi

A credentials provider that provides no credentials.

GuestCredentialsProvider() - Constructor for class org.labkey.remoteapi.GuestCredentialsProvider

H

HashingAlgorithm - Enum Class in org.labkey.remoteapi.totp

hasPermission(int) - Method in class org.labkey.remoteapi.security.GetContainersResponse

Deprecated, for removal: This API element is subject to removal in a future version.

hasPermission(int, String) - Method in class org.labkey.remoteapi.security.GetContainersResponse

Deprecated, for removal: This API element is subject to removal in a future version.

HasRequiredVersion - Interface in org.labkey.remoteapi

I

impersonate(String) - Method in class org.labkey.remoteapi.Connection

For site-admins only, start impersonating a user.

impersonate(String, String) - Method in class org.labkey.remoteapi.Connection

For site-admins or project-admins only, start impersonating a user.

ImpersonateUserCommand - Class in org.labkey.remoteapi.security

For site-admins or project-admins only, start impersonating a user.

ImpersonateUserCommand(int) - Constructor for class org.labkey.remoteapi.security.ImpersonateUserCommand

ImpersonateUserCommand(String) - Constructor for class org.labkey.remoteapi.security.ImpersonateUserCommand

IMPORT - Enum constant in enum class org.labkey.remoteapi.query.ImportDataCommand.InsertOption

Bulk insert.

ImportDataCommand - Class in org.labkey.remoteapi.query

Import data in bulk from a text, local file, or a file contained within a module on the LabKey Server.

ImportDataCommand(String, String) - Constructor for class org.labkey.remoteapi.query.ImportDataCommand

Constructs an ImportDataCommand for the given schemaName and queryName.

ImportDataCommand.ImportDataType - Enum Class in org.labkey.remoteapi.query

ImportDataCommand.InsertOption - Enum Class in org.labkey.remoteapi.query

ImportDataResponse - Class in org.labkey.remoteapi.query

ImportDataResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.query.ImportDataResponse

ImportRunCommand - Class in org.labkey.remoteapi.assay

Import a new assay run.

ImportRunCommand(int) - Constructor for class org.labkey.remoteapi.assay.ImportRunCommand

ImportRunCommand(int, File) - Constructor for class org.labkey.remoteapi.assay.ImportRunCommand

ImportRunCommand(int, List<Map<String, Object>>) - Constructor for class org.labkey.remoteapi.assay.ImportRunCommand

ImportRunDemo - Class in org.labkey.remoteapi.test

ImportRunDemo() - Constructor for class org.labkey.remoteapi.test.ImportRunDemo

ImportRunResponse - Class in org.labkey.remoteapi.assay

ImportRunResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.assay.ImportRunResponse

IN - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

initializeConnection(Connection) - Method in class org.labkey.remoteapi.ApiKeyCredentialsProvider

initializeConnection(Connection) - Method in class org.labkey.remoteapi.BasicAuthCredentialsProvider

initializeConnection(Connection) - Method in interface org.labkey.remoteapi.CredentialsProvider

Initialize the connection before its first request.

initializeConnection(Connection) - Method in class org.labkey.remoteapi.GuestCredentialsProvider

initializeConnection(Connection) - Method in class org.labkey.remoteapi.NetrcCredentialsProvider

InsertRowsCommand - Class in org.labkey.remoteapi.query

Command for inserting rows into a table in a read-write schema.

InsertRowsCommand(String, String) - Constructor for class org.labkey.remoteapi.query.InsertRowsCommand

Constructs an InsertRowsCommand for the given schemaName and queryName.

INT - Enum constant in enum class org.labkey.remoteapi.query.SelectRowsResponse.ColumnDataType

isAcceptSelfSignedCerts() - Method in class org.labkey.remoteapi.Connection

Returns true if the connection should accept a self-signed SSL certificate when using HTTPS, false otherwise.

isAddAlias() - Method in class org.labkey.remoteapi.security.RenameContainerCommand

isAutoIncrement() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse.Column

ISBLANK - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

isCalculated() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse.Column

isCalculateNeut() - Method in class org.labkey.remoteapi.assay.nab.NAbRunsCommand

isDataValueRequired() - Method in enum class org.labkey.remoteapi.query.Filter.Operator

isExtendedFormat() - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

Returns whether the extended format will be requested.

isExtendedFormat() - Method in class org.labkey.remoteapi.query.SelectRowsCommand

Returns whether the extended format will be requested.

isHidden() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse.Column

isIgnoreFilter() - Method in class org.labkey.remoteapi.query.BaseQueryCommand

isImpersonated() - Method in class org.labkey.remoteapi.security.WhoAmIResponse

isImportIdentity() - Method in class org.labkey.remoteapi.query.ImportDataCommand

isImportLookupByAlternateKey() - Method in class org.labkey.remoteapi.query.ImportDataCommand

isIncludeColumns() - Method in class org.labkey.remoteapi.query.GetQueriesCommand

isIncludeDetailsColumn() - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

Include the Details link column in the set of columns (defaults to false).

isIncludeFields() - Method in class org.labkey.remoteapi.domain.ListDomainsCommand

isIncludeFitParameters() - Method in class org.labkey.remoteapi.assay.nab.NAbRunsCommand

isIncludeMetadata() - Method in class org.labkey.remoteapi.query.BaseQueryCommand

isIncludeProjectAndShared() - Method in class org.labkey.remoteapi.domain.ListDomainsCommand

isIncludeStats() - Method in class org.labkey.remoteapi.assay.nab.NAbRunsCommand

isIncludeSubfolders() - Method in class org.labkey.remoteapi.security.GetContainersCommand

isIncludeSubfolders() - Method in class org.labkey.remoteapi.security.GetGroupPermsCommand

Returns whether the command will recurse down the subfolders of the folder in which the command is executed.

isIncludeTitle() - Method in class org.labkey.remoteapi.query.GetQueriesCommand

isIncludeTotalCount() - Method in class org.labkey.remoteapi.query.BaseQueryCommand

isIncludeTotalCount() - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

Include the total number of rows available (defaults to true).

isIncludeUserQueries() - Method in class org.labkey.remoteapi.query.GetQueriesCommand

isIncludeViewDataUrl() - Method in class org.labkey.remoteapi.query.GetQueriesCommand

isIncludeWells() - Method in class org.labkey.remoteapi.assay.nab.NAbRunsCommand

isKeyField() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse.Column

isMvEnabled() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse.Column

isNullable() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse.Column

isPublic() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse.Lookup

isReadOnly() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse.Column

isSaveInSession() - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

Whether the definition of this query should be stored for reuse during the current session.

isSaveToPipeline() - Method in class org.labkey.remoteapi.query.ImportDataCommand

isSelectable() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse.Column

isSendEmail() - Method in class org.labkey.remoteapi.security.CreateUserCommand

isUseAsync() - Method in class org.labkey.remoteapi.query.ImportDataCommand

isUserDefined(String) - Method in class org.labkey.remoteapi.query.GetQueriesResponse

isUserEditable() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse.Column

isVersionField() - Method in class org.labkey.remoteapi.query.GetQueryDetailsResponse.Column

isWorkbook() - Method in class org.labkey.remoteapi.security.CreateContainerCommand

iterator() - Method in class org.labkey.remoteapi.query.RowsResponseRowset

J

JSESSIONID - Static variable in class org.labkey.remoteapi.Connection

L

LineageCommand - Class in org.labkey.remoteapi.experiment

LineageCommand.Builder - Class in org.labkey.remoteapi.experiment

LineageNode - Class in org.labkey.remoteapi.experiment

LineageNode(String, Map<String, Object>) - Constructor for class org.labkey.remoteapi.experiment.LineageNode

LineageNode.Edge - Class in org.labkey.remoteapi.experiment

LineageResponse - Class in org.labkey.remoteapi.experiment

LineageResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.experiment.LineageResponse

ListDomainsCommand - Class in org.labkey.remoteapi.domain

ListDomainsCommand(boolean, boolean, Set<String>, String) - Constructor for class org.labkey.remoteapi.domain.ListDomainsCommand

ListDomainsResponse - Class in org.labkey.remoteapi.domain

ListDomainsResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.domain.ListDomainsResponse

Constructs a new CommandResponse, initialized with the provided response text and status code.

LoadAssayBatchCommand - Class in org.labkey.remoteapi.assay

Command for obtaining information about the current batch in a particular folder.

LoadAssayBatchCommand(String, int) - Constructor for class org.labkey.remoteapi.assay.LoadAssayBatchCommand

LoadAssayBatchResponse - Class in org.labkey.remoteapi.assay

LoadAssayBatchResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.assay.LoadAssayBatchResponse

Constructs a new CommandResponse, initialized with the provided response text and status code.

logout() - Method in class org.labkey.remoteapi.Connection

Invalidates the current HTTP session on the server, if any

LogoutCommand - Class in org.labkey.remoteapi.security

Ends the current HTTP session, if any is active.

LogoutCommand() - Constructor for class org.labkey.remoteapi.security.LogoutCommand

Lookup(Map<String, Object>) - Constructor for class org.labkey.remoteapi.query.GetQueryDetailsResponse.Lookup

LT - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

LTE - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

M

main(String[]) - Static method in class org.labkey.remoteapi.test.Demo

main(String...) - Static method in class org.labkey.remoteapi.test.ImportRunDemo

main(String...) - Static method in class org.labkey.remoteapi.test.MS2SearchClient

main(String...) - Static method in class org.labkey.remoteapi.test.PipelineFileAvailableClient

main(String...) - Static method in class org.labkey.remoteapi.test.SaveAssayBatchDemo

main(String[]) - Static method in class org.labkey.remoteapi.test.Test

Mascot - Enum constant in enum class org.labkey.remoteapi.ms2.StartSearchCommand.SearchEngine

Material - Class in org.labkey.remoteapi.assay

Material() - Constructor for class org.labkey.remoteapi.assay.Material

Material(JSONObject) - Constructor for class org.labkey.remoteapi.assay.Material

MEMBER_OF - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

MERGE - Enum constant in enum class org.labkey.remoteapi.query.ImportDataCommand.InsertOption

Bulk insert or update.

moduleResource - Enum constant in enum class org.labkey.remoteapi.query.ImportDataCommand.ImportDataType

MoveRowsCommand - Class in org.labkey.remoteapi.query

Command for moving rows from a compatible schema table.

MoveRowsCommand(String, String, String) - Constructor for class org.labkey.remoteapi.query.MoveRowsCommand

Constructs a MoveRowsCommand for the given targetContainerPath, schemaName, and queryName.

MS2SearchClient - Class in org.labkey.remoteapi.test

Demo code that accepts one or more CSV files on the command line.

MS2SearchClient() - Constructor for class org.labkey.remoteapi.test.MS2SearchClient

MV_INDICATOR - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

N

NAbCurveParameters - Class in org.labkey.remoteapi.assay.nab.model

NAbCurveParameters(Map<String, Object>) - Constructor for class org.labkey.remoteapi.assay.nab.model.NAbCurveParameters

NAbNeutralizationResult - Class in org.labkey.remoteapi.assay.nab.model

NAbNeutralizationResult(long, double, double) - Constructor for class org.labkey.remoteapi.assay.nab.model.NAbNeutralizationResult

NAbReplicate - Class in org.labkey.remoteapi.assay.nab.model

NAbReplicate(Map<String, Object>) - Constructor for class org.labkey.remoteapi.assay.nab.model.NAbReplicate

NAbRun - Class in org.labkey.remoteapi.assay.nab.model

NAbRun(Map<String, Object>) - Constructor for class org.labkey.remoteapi.assay.nab.model.NAbRun

NAbRunsCommand - Class in org.labkey.remoteapi.assay.nab

Command for obtaining information about the current assay definitions in a particular folder.

NAbRunsCommand() - Constructor for class org.labkey.remoteapi.assay.nab.NAbRunsCommand

NAbRunsResponse - Class in org.labkey.remoteapi.assay.nab

Response class for the NAbRunsCommand.

NAbRunsResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.assay.nab.NAbRunsResponse

Constructs a new CommandResponse, initialized with the provided response text and status code.

NAbSample - Class in org.labkey.remoteapi.assay.nab.model

NAbSample(Map<String, Object>, long[]) - Constructor for class org.labkey.remoteapi.assay.nab.model.NAbSample

nabTest(Connection, String) - Static method in class org.labkey.remoteapi.test.Test

NAbWell - Class in org.labkey.remoteapi.assay.nab.model

NAbWell(Map<String, Object>) - Constructor for class org.labkey.remoteapi.assay.nab.model.NAbWell

NAbWellGroup - Class in org.labkey.remoteapi.assay.nab.model

NAbWellGroup(Map<String, Object>) - Constructor for class org.labkey.remoteapi.assay.nab.model.NAbWellGroup

NEQ - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

NEQ_OR_NULL - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

NetrcCredentialsProvider - Class in org.labkey.remoteapi

Attempts to find a .netrc or _netrc file and entry for the given host.

NetrcCredentialsProvider(String) - Constructor for class org.labkey.remoteapi.NetrcCredentialsProvider

Attempt netrc lookup for the given host.

NetrcCredentialsProvider(URI) - Constructor for class org.labkey.remoteapi.NetrcCredentialsProvider

Attempt netrc lookup for the URI's host.

NetrcFileParser - Class in org.labkey.remoteapi

NetrcFileParser() - Constructor for class org.labkey.remoteapi.NetrcFileParser

NetrcFileParser.NetrcEntry - Class in org.labkey.remoteapi

NO_MV_INDICATOR - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

NONBLANK - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

NONE - Enum constant in enum class org.labkey.remoteapi.query.SaveRowsCommand.AuditBehavior

NOT_BETWEEN - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

NOT_IN - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

O

ONTOLOGY_IN_SUBTREE - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

ONTOLOGY_NOT_IN_SUBTREE - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

org.labkey.remoteapi - package org.labkey.remoteapi

org.labkey.remoteapi.assay - package org.labkey.remoteapi.assay

org.labkey.remoteapi.assay.nab - package org.labkey.remoteapi.assay.nab

org.labkey.remoteapi.assay.nab.model - package org.labkey.remoteapi.assay.nab.model

org.labkey.remoteapi.collections - package org.labkey.remoteapi.collections

org.labkey.remoteapi.di - package org.labkey.remoteapi.di

org.labkey.remoteapi.domain - package org.labkey.remoteapi.domain

org.labkey.remoteapi.experiment - package org.labkey.remoteapi.experiment

org.labkey.remoteapi.internal - package org.labkey.remoteapi.internal

org.labkey.remoteapi.ms2 - package org.labkey.remoteapi.ms2

org.labkey.remoteapi.pipeline - package org.labkey.remoteapi.pipeline

org.labkey.remoteapi.query - package org.labkey.remoteapi.query

org.labkey.remoteapi.security - package org.labkey.remoteapi.security

org.labkey.remoteapi.storage - package org.labkey.remoteapi.storage

org.labkey.remoteapi.study - package org.labkey.remoteapi.study

org.labkey.remoteapi.test - package org.labkey.remoteapi.test

org.labkey.remoteapi.totp - package org.labkey.remoteapi.totp

P

parse(String) - Method in class org.labkey.remoteapi.query.DateParser

parseJsonType(String) - Static method in enum class org.labkey.remoteapi.query.SelectRowsResponse.ColumnDataType

ParticipantGroup - Class in org.labkey.remoteapi.study

A client-side representation of a participant group from a study on the server.

ParticipantGroup() - Constructor for class org.labkey.remoteapi.study.ParticipantGroup

path - Enum constant in enum class org.labkey.remoteapi.query.ImportDataCommand.ImportDataType

PhysicalLocation - Enum constant in enum class org.labkey.remoteapi.storage.StorageItemTypes

PipelineFileAvailableClient - Class in org.labkey.remoteapi.test

Demo code that notifies server that files may become available under a pipeline root, which releases queued pipeline jobs that are blocked awaiting those files.

PipelineFileAvailableClient() - Constructor for class org.labkey.remoteapi.test.PipelineFileAvailableClient

PostCommand<ResponseType extends CommandResponse> - Class in org.labkey.remoteapi

Base class for all commands that need to post data to the server, rather than providing parameters in the query string.

PostCommand(String, String) - Constructor for class org.labkey.remoteapi.PostCommand

Constructs a new PostCommand given a controller and action name.

PrimaryStorage - Enum constant in enum class org.labkey.remoteapi.storage.StorageItemTypes

PropertyDescriptor - Class in org.labkey.remoteapi.domain

PropertyDescriptor() - Constructor for class org.labkey.remoteapi.domain.PropertyDescriptor

PropertyDescriptor(String, String) - Constructor for class org.labkey.remoteapi.domain.PropertyDescriptor

PropertyDescriptor(String, String, String) - Constructor for class org.labkey.remoteapi.domain.PropertyDescriptor

PropertyDescriptor(JSONObject) - Constructor for class org.labkey.remoteapi.domain.PropertyDescriptor

Protocol - Class in org.labkey.remoteapi.assay

Protocol() - Constructor for class org.labkey.remoteapi.assay.Protocol

Protocol(JSONObject) - Constructor for class org.labkey.remoteapi.assay.Protocol

ProtocolResponse - Class in org.labkey.remoteapi.assay

ProtocolResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.assay.ProtocolResponse

put(String, V) - Method in class org.labkey.remoteapi.collections.CaseInsensitiveHashMap

putAll(Map<? extends String, ? extends V>) - Method in class org.labkey.remoteapi.collections.CaseInsensitiveHashMap

putIfAbsent(String, V) - Method in class org.labkey.remoteapi.collections.CaseInsensitiveHashMap

Q

Q - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

queryFilterFromJSONString(String) - Static method in class org.labkey.remoteapi.domain.ConditionalFormat

queryFilterToJSONString() - Method in class org.labkey.remoteapi.domain.ConditionalFormat

R

Rack - Enum constant in enum class org.labkey.remoteapi.storage.StorageItemTypes

remove(Object) - Method in class org.labkey.remoteapi.collections.CaseInsensitiveHashMap

remove(String) - Method in class org.labkey.remoteapi.collections.CaseInsensitiveHashMap

RemoveGroupMembersCommand - Class in org.labkey.remoteapi.security

Removes a set of principals from a security group.

RemoveGroupMembersCommand(int) - Constructor for class org.labkey.remoteapi.security.RemoveGroupMembersCommand

RenameContainerCommand - Class in org.labkey.remoteapi.security

Rename a container on the server

RenameContainerCommand(String, String, boolean) - Constructor for class org.labkey.remoteapi.security.RenameContainerCommand

RenameContainerResponse - Class in org.labkey.remoteapi.security

RenameContainerResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.security.RenameContainerResponse

RenameGroupCommand - Class in org.labkey.remoteapi.security

Renames an existing group.

RenameGroupCommand(int, String) - Constructor for class org.labkey.remoteapi.security.RenameGroupCommand

RenameGroupResponse - Class in org.labkey.remoteapi.security

RenameGroupResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.security.RenameGroupResponse

ResetTransformStateCommand - Class in org.labkey.remoteapi.di

Resets the stored state of an ETL, allowing it to be rerun from scratch by forgetting any retained last modified dates or similar.

ResetTransformStateCommand(String) - Constructor for class org.labkey.remoteapi.di.ResetTransformStateCommand

Reset an ETL transform to its initial state, as if it has never been run

ResetTransformStateResponse - Class in org.labkey.remoteapi.di

ResetTransformStateResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.di.ResetTransformStateResponse

Constructs a new CommandResponse, initialized with the provided response text and status code.

ResponseObject - Class in org.labkey.remoteapi

Base class for objects mapped from subsets of response JSON

ResponseObject() - Constructor for class org.labkey.remoteapi.ResponseObject

ResponseObject(Map<String, Object>) - Constructor for class org.labkey.remoteapi.ResponseObject

ResponseUtils - Class in org.labkey.remoteapi.internal

Row - Interface in org.labkey.remoteapi.query

Provides a format-neutral way of obtaining a row's value.

RowMap - Class in org.labkey.remoteapi.query

RowMap() - Constructor for class org.labkey.remoteapi.query.RowMap

RowMap(Map<String, Object>) - Constructor for class org.labkey.remoteapi.query.RowMap

Rowset - Interface in org.labkey.remoteapi.query

Provides an iterable interface over the response rows that hides the differences between the simple and extended response formats.

RowsResponseRowset - Class in org.labkey.remoteapi.query

RowsResponseRowset(List<Map<String, Object>>) - Constructor for class org.labkey.remoteapi.query.RowsResponseRowset

Run - Class in org.labkey.remoteapi.assay

Represents a single assay run

Run() - Constructor for class org.labkey.remoteapi.assay.Run

Run(JSONObject) - Constructor for class org.labkey.remoteapi.assay.Run

RunTransformCommand - Class in org.labkey.remoteapi.di

Queues an ETL to run on the server.

RunTransformCommand(String) - Constructor for class org.labkey.remoteapi.di.RunTransformCommand

RunTransformResponse - Class in org.labkey.remoteapi.di

RunTransformResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.di.RunTransformResponse

Constructs a new CommandResponse, initialized with the provided response text and status code.

S

SAMPLE_DERIVATION_PROTOCOL - Static variable in class org.labkey.remoteapi.assay.SaveAssayBatchCommand

SaveAssayBatchCommand - Class in org.labkey.remoteapi.assay

Saves an assay batch on the server.

SaveAssayBatchCommand(int) - Constructor for class org.labkey.remoteapi.assay.SaveAssayBatchCommand

SaveAssayBatchCommand(int, Batch) - Constructor for class org.labkey.remoteapi.assay.SaveAssayBatchCommand

SaveAssayBatchCommand(String, Batch) - Constructor for class org.labkey.remoteapi.assay.SaveAssayBatchCommand

SaveAssayBatchDemo - Class in org.labkey.remoteapi.test

Five command line args: 1.

SaveAssayBatchDemo() - Constructor for class org.labkey.remoteapi.test.SaveAssayBatchDemo

SaveAssayBatchResponse - Class in org.labkey.remoteapi.assay

SaveAssayBatchResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.assay.SaveAssayBatchResponse

SaveAssayRunsCommand - Class in org.labkey.remoteapi.assay

Saves runs on the server.

SaveAssayRunsCommand(String, List<Run>) - Constructor for class org.labkey.remoteapi.assay.SaveAssayRunsCommand

SaveAssayRunsResponse - Class in org.labkey.remoteapi.assay

SaveAssayRunsResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.assay.SaveAssayRunsResponse

Constructs a new CommandResponse, initialized with the provided response text and status code.

SaveDomainCommand - Class in org.labkey.remoteapi.domain

SaveDomainCommand(Long) - Constructor for class org.labkey.remoteapi.domain.SaveDomainCommand

SaveDomainCommand(String, String) - Constructor for class org.labkey.remoteapi.domain.SaveDomainCommand

SaveProtocolCommand - Class in org.labkey.remoteapi.assay

SaveProtocolCommand(Protocol) - Constructor for class org.labkey.remoteapi.assay.SaveProtocolCommand

SaveRowsCommand - Class in org.labkey.remoteapi.query

Base class for commands that make changes to rows exposed from a given query in a given schema.

SaveRowsCommand(String, String, String) - Constructor for class org.labkey.remoteapi.query.SaveRowsCommand

Constructs a new SaveRowsCommand for a given schema, query and action name.

SaveRowsCommand.AuditBehavior - Enum Class in org.labkey.remoteapi.query

SaveRowsResponse - Class in org.labkey.remoteapi.query

Response object used for commands that derive from SaveRowsCommand.

SaveRowsResponse(String, int, String, JSONObject, HasRequiredVersion) - Constructor for class org.labkey.remoteapi.query.SaveRowsResponse

Constructs a new SaveRowsResponse given the response text and status code

SelectRowsCommand - Class in org.labkey.remoteapi.query

Command for selecting data from any LabKey schema/query exposed on the server identified by the Connection object supplied to the Command.execute(org.labkey.remoteapi.Connection, String) method.

SelectRowsCommand(String, String) - Constructor for class org.labkey.remoteapi.query.SelectRowsCommand

Constructs a new SelectRowsCommand for the given schema and query name.

SelectRowsResponse - Class in org.labkey.remoteapi.query

The command response class returned from the Command.execute(org.labkey.remoteapi.Connection, String) method.

SelectRowsResponse(String, int, String, JSONObject, Command<? extends SelectRowsResponse, ?>) - Constructor for class org.labkey.remoteapi.query.SelectRowsResponse

Constructs a new SelectRowsResponse given the response text and HTTP status code.

SelectRowsResponse.ColumnDataType - Enum Class in org.labkey.remoteapi.query

An enumeration of the possible column data types

selectTest(Connection, String) - Static method in class org.labkey.remoteapi.test.Test

Sequest - Enum constant in enum class org.labkey.remoteapi.ms2.StartSearchCommand.SearchEngine

setAbsolutePath(String) - Method in class org.labkey.remoteapi.assay.Data

setAcceptSelfSignedCerts(boolean) - Method in class org.labkey.remoteapi.Connection

Sets the accept-self-signed certificates option.

setAddAlias(boolean) - Method in class org.labkey.remoteapi.security.RenameContainerCommand

setAllowPlateMetadata(Boolean) - Method in class org.labkey.remoteapi.assay.Protocol

setAssayName(String) - Method in class org.labkey.remoteapi.assay.nab.NAbRunsCommand

setAssignProjectAdmin(boolean) - Method in class org.labkey.remoteapi.security.CreateProjectCommand

setAuditBehavior(SaveRowsCommand.AuditBehavior) - Method in class org.labkey.remoteapi.query.SaveRowsCommand

Used to override the audit behavior for the schema/query.

setAuditUserComment(String) - Method in class org.labkey.remoteapi.assay.ImportRunCommand

setAuditUserComment(String) - Method in class org.labkey.remoteapi.query.SaveRowsCommand

Used to provide a comment that will be attached to certain detailed audit log records

setAutoCopyTargetContainerId(String) - Method in class org.labkey.remoteapi.assay.Protocol

setBackgroundColor(String) - Method in class org.labkey.remoteapi.domain.ConditionalFormat

Set the conditional background color.

setBackgroundUpload(Boolean) - Method in class org.labkey.remoteapi.assay.Protocol

setBatch(Batch) - Method in class org.labkey.remoteapi.assay.LoadAssayBatchCommand

setBatch(Batch) - Method in class org.labkey.remoteapi.assay.LoadAssayBatchResponse

setBatchId(int) - Method in class org.labkey.remoteapi.assay.ImportRunCommand

setBatchId(int) - Method in class org.labkey.remoteapi.assay.LoadAssayBatchCommand

setBatchProperties(Map<String, Object>) - Method in class org.labkey.remoteapi.assay.ImportRunCommand

setBold(boolean) - Method in class org.labkey.remoteapi.domain.ConditionalFormat

Set boldness flag for conditional format

setCalculateNeut(boolean) - Method in class org.labkey.remoteapi.assay.nab.NAbRunsCommand

setChildren(Boolean) - Method in class org.labkey.remoteapi.experiment.LineageCommand.Builder

setColumnName(String) - Method in class org.labkey.remoteapi.query.Filter

setColumnName(String) - Method in class org.labkey.remoteapi.query.Sort

setColumns(List<String>) - Method in class org.labkey.remoteapi.query.SelectRowsCommand

Sets an explicit list of columns to request.

setComment(String) - Method in class org.labkey.remoteapi.assay.ImportRunCommand

setComment(String) - Method in class org.labkey.remoteapi.assay.Run

setConditionalFormats(List<ConditionalFormat>) - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

setContainerFilter(ContainerFilter) - Method in class org.labkey.remoteapi.query.BaseQueryCommand

Sets the container filter for the sql to be executed.

setContainerFilter(ContainerFilter) - Method in interface org.labkey.remoteapi.query.BaseSelect

setContainerFilter(ContainerFilter) - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

Sets the container filter for the sql to be executed.

setContainerPath(String) - Method in class org.labkey.remoteapi.domain.ListDomainsCommand

setCopy(Boolean) - Method in class org.labkey.remoteapi.assay.GetProtocolCommand

setCpasType(String) - Method in class org.labkey.remoteapi.experiment.LineageCommand.Builder

setDataFileURL(String) - Method in class org.labkey.remoteapi.assay.Data

setDataInputs(List<Data>) - Method in class org.labkey.remoteapi.assay.Run

setDataOutputs(List<Data>) - Method in class org.labkey.remoteapi.assay.Run

setDeleteParticipantIds(Set<String>) - Method in class org.labkey.remoteapi.study.UpdateParticipantGroupCommand.UpdatedParticipantGroup

setDepth(Integer) - Method in class org.labkey.remoteapi.experiment.LineageCommand.Builder

setDerivationDataScope(String) - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

setDescription(String) - Method in class org.labkey.remoteapi.assay.Protocol

setDescription(String) - Method in class org.labkey.remoteapi.domain.Domain

setDescription(String) - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

setDescription(String) - Method in class org.labkey.remoteapi.security.CreateContainerCommand

setDescription(String) - Method in class org.labkey.remoteapi.study.ParticipantGroup

setDimension(Boolean) - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

setDirection(Sort.Direction) - Method in class org.labkey.remoteapi.query.Sort

setDomainDesign(Domain) - Method in class org.labkey.remoteapi.domain.SaveDomainCommand

Set the domain design that will be POSTed by this command.

setDomainId(Long) - Method in class org.labkey.remoteapi.domain.Domain

setDomainId(Long) - Method in class org.labkey.remoteapi.domain.GetDomainDetailsCommand

setDomainKinds(Set<String>) - Method in class org.labkey.remoteapi.domain.ListDomainsCommand

setDomains(List<Domain>) - Method in class org.labkey.remoteapi.assay.Protocol

setDomainURI(String) - Method in class org.labkey.remoteapi.domain.Domain

setEditableResults(Boolean) - Method in class org.labkey.remoteapi.assay.Protocol

setEditableRuns(Boolean) - Method in class org.labkey.remoteapi.assay.Protocol

setEmail(String) - Method in class org.labkey.remoteapi.security.CreateUserCommand

Set the email address for the new user.

setEnabled(Boolean) - Method in class org.labkey.remoteapi.di.UpdateTransformConfigurationCommand

setEnsureParticipantIds(Set<String>) - Method in class org.labkey.remoteapi.study.UpdateParticipantGroupCommand.UpdatedParticipantGroup

setExpType(String) - Method in class org.labkey.remoteapi.experiment.LineageCommand.Builder

setExtendedFormat(boolean) - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

Set to true to request the extended response format, which includes URLs, Missing-Value indicators and display values in addition to the raw values.

setExtendedFormat(boolean) - Method in class org.labkey.remoteapi.query.SelectRowsCommand

Set to true to request the extended response format, which includes URLs, Missing-Value indicators and display values in addition to the raw values.

setExtraContext(Map<String, Object>) - Method in class org.labkey.remoteapi.query.SaveRowsCommand

Sets the additional extra context.

setFields(List<PropertyDescriptor>) - Method in class org.labkey.remoteapi.domain.Domain

setFile(File) - Method in class org.labkey.remoteapi.assay.ImportRunCommand

setFile(File) - Method in class org.labkey.remoteapi.query.ImportDataCommand

Uploads a file for import.

setFiles(List<String>) - Method in class org.labkey.remoteapi.ms2.StartSearchCommand

setFilters(List<Filter>) - Method in class org.labkey.remoteapi.query.BaseQueryCommand

Sets the current list of filters.

setFolderType(String) - Method in class org.labkey.remoteapi.security.BaseCreateFolderCommand

setFolderType(String) - Method in class org.labkey.remoteapi.security.CreateContainerCommand

setFormat(String) - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

setFormat(String) - Method in class org.labkey.remoteapi.query.ImportDataCommand

setGroup(String) - Method in class org.labkey.remoteapi.security.GetUsersCommand

setGroupId(int) - Method in class org.labkey.remoteapi.security.DeleteGroupCommand

setGroupId(int) - Method in class org.labkey.remoteapi.security.GetUsersCommand

setGroupId(int) - Method in class org.labkey.remoteapi.security.GroupMembersCommand

setGroupId(int) - Method in class org.labkey.remoteapi.security.RenameGroupCommand

setHidden(Boolean) - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

setId(int) - Method in class org.labkey.remoteapi.assay.ExpObject

setId(Integer) - Method in class org.labkey.remoteapi.assay.AssayListCommand

Sets the current assay id filter.

setIgnoreFilter(boolean) - Method in class org.labkey.remoteapi.query.BaseQueryCommand

Pass true to ignore any filter that may be part of the chosen view.

setImportIdentity(Boolean) - Method in class org.labkey.remoteapi.query.ImportDataCommand

setImportLookupByAlternateKey(Boolean) - Method in class org.labkey.remoteapi.query.ImportDataCommand

setIncludeChildWorkbooks(Boolean) - Method in class org.labkey.remoteapi.security.GetContainersCommand

setIncludeColumns(boolean) - Method in class org.labkey.remoteapi.query.GetQueriesCommand

Pass false to omit information about the columns within each query.

setIncludeDeactivated(Boolean) - Method in class org.labkey.remoteapi.security.GetUsersCommand

Deprecated, for removal: This API element is subject to removal in a future version.

setIncludeDetailsColumn(boolean) - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

Include the Details link column in the set of columns (defaults to false).

setIncludeEffectivePermissions(Boolean) - Method in class org.labkey.remoteapi.security.GetContainersCommand

setIncludeFields(boolean) - Method in class org.labkey.remoteapi.domain.ListDomainsCommand

setIncludeFitParameters(boolean) - Method in class org.labkey.remoteapi.assay.nab.NAbRunsCommand

setIncludeInactive(boolean) - Method in class org.labkey.remoteapi.security.GetUsersCommand

setIncludeInputsAndOutputs(Boolean) - Method in class org.labkey.remoteapi.experiment.LineageCommand.Builder

setIncludeMetadata(boolean) - Method in class org.labkey.remoteapi.query.BaseQueryCommand

Pass false to omit metadata for the selected columns.

setIncludeProjectAndShared(boolean) - Method in class org.labkey.remoteapi.domain.ListDomainsCommand

setIncludeProperties(Boolean) - Method in class org.labkey.remoteapi.experiment.LineageCommand.Builder

setIncludeRunSteps(Boolean) - Method in class org.labkey.remoteapi.experiment.LineageCommand.Builder

setIncludeStandardProperties(Boolean) - Method in class org.labkey.remoteapi.security.GetContainersCommand

setIncludeStats(boolean) - Method in class org.labkey.remoteapi.assay.nab.NAbRunsCommand

setIncludeSubfolders(boolean) - Method in class org.labkey.remoteapi.security.GetContainersCommand

setIncludeSubfolders(boolean) - Method in class org.labkey.remoteapi.security.GetGroupPermsCommand

Sets whether this command should recurse down the subfolders of the folder in which the command is executed.

setIncludeTitle(boolean) - Method in class org.labkey.remoteapi.query.GetQueriesCommand

Pass false to omit custom query titles.

setIncludeTotalCount(boolean) - Method in class org.labkey.remoteapi.query.BaseQueryCommand

Pass false to omit total count from the response.

setIncludeTotalCount(boolean) - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

Include the total number of rows available (defaults to true).

setIncludeUserQueries(boolean) - Method in class org.labkey.remoteapi.query.GetQueriesCommand

Pass false to this method to omit user-defined queries from the results.

setIncludeViewDataUrl(boolean) - Method in class org.labkey.remoteapi.query.GetQueriesCommand

Pass false to omit view data URLs from the results.

setIncludeWells(boolean) - Method in class org.labkey.remoteapi.assay.nab.NAbRunsCommand

setInsertOption(ImportDataCommand.InsertOption) - Method in class org.labkey.remoteapi.query.ImportDataCommand

setItalic(boolean) - Method in class org.labkey.remoteapi.domain.ConditionalFormat

Set italic flag for conditional format

setJsonObject(JSONObject) - Method in class org.labkey.remoteapi.SimplePostCommand

Sets the JSON object to post.

setKind(String) - Method in class org.labkey.remoteapi.domain.CreateDomainCommand

Set the "kind" of the domain to be created.

setLabel(String) - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

setLabel(String) - Method in class org.labkey.remoteapi.study.ParticipantGroup

setLookup(String, String, String) - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

Convenience function for creating lookups

setLsid(String) - Method in class org.labkey.remoteapi.assay.GetAssayRunCommand

setLsid(String) - Method in class org.labkey.remoteapi.assay.Run

setMap(Map<String, Object>) - Method in class org.labkey.remoteapi.query.RowMap

setMaterialInputs(List<Material>) - Method in class org.labkey.remoteapi.assay.Run

setMaterialOutputs(List<Material>) - Method in class org.labkey.remoteapi.assay.Run

setMaxRows(int) - Method in class org.labkey.remoteapi.query.BaseQueryCommand

Sets the current row limit value.

setMaxRows(int) - Method in interface org.labkey.remoteapi.query.BaseSelect

setMaxRows(int) - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

Sets the current row limit value.

setMeasure(Boolean) - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

setModuleResource(String, String) - Method in class org.labkey.remoteapi.query.ImportDataCommand

Import data from a resource file embedded in a module.

setMvEnabled(Boolean) - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

setName(String) - Method in class org.labkey.remoteapi.assay.AssayListCommand

Sets the assay name to filter upon.

setName(String) - Method in class org.labkey.remoteapi.assay.ExpObject

setName(String) - Method in class org.labkey.remoteapi.assay.ImportRunCommand

setName(String) - Method in class org.labkey.remoteapi.assay.Protocol

setName(String) - Method in class org.labkey.remoteapi.domain.Domain

setName(String) - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

setName(String) - Method in class org.labkey.remoteapi.security.BaseCreateFolderCommand

setName(String) - Method in class org.labkey.remoteapi.security.CreateContainerCommand

setName(String) - Method in class org.labkey.remoteapi.security.CreateGroupCommand

setName(String) - Method in class org.labkey.remoteapi.security.GetUsersCommand

setName(String) - Method in class org.labkey.remoteapi.security.RenameContainerCommand

setNewName(String) - Method in class org.labkey.remoteapi.security.RenameGroupCommand

setOffset(int) - Method in class org.labkey.remoteapi.query.BaseQueryCommand

Sets the index of the first row in the resultset to return from the server.

setOffset(int) - Method in interface org.labkey.remoteapi.query.BaseSelect

setOffset(int) - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

Sets the index of the first row in the resultset to return from the server.

setOperator(Filter.Operator) - Method in class org.labkey.remoteapi.query.Filter

setOptions(Map<String, Object>) - Method in class org.labkey.remoteapi.domain.CreateDomainCommand

Set options for the domain to be created.

setParameters(Map<String, Object>) - Method in class org.labkey.remoteapi.SimpleGetCommand

Sets the URL parameter map.

setParameters(Map<String, Object>) - Method in class org.labkey.remoteapi.SimplePostCommand

Sets the URL parameter map.

setParents(Boolean) - Method in class org.labkey.remoteapi.experiment.LineageCommand.Builder

setParticipantIds(Set<String>) - Method in class org.labkey.remoteapi.study.ParticipantGroup

setPath(String) - Method in class org.labkey.remoteapi.ms2.StartSearchCommand

setPath(String) - Method in class org.labkey.remoteapi.query.ImportDataCommand

Import data from a file relative from the server's webdav root.

setPHI(String) - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

setPipelinePath(String) - Method in class org.labkey.remoteapi.assay.Data

setPlateMetadata(Boolean) - Method in class org.labkey.remoteapi.assay.Protocol

setPlateMetadata(JSONObject) - Method in class org.labkey.remoteapi.assay.ImportRunCommand

setPlateMetadata(JSONObject) - Method in class org.labkey.remoteapi.assay.Run

setProperties(Map<String, Object>) - Method in class org.labkey.remoteapi.assay.ExpObject

setProperties(Map<String, Object>) - Method in class org.labkey.remoteapi.assay.ImportRunCommand

setPropertyId(Long) - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

setPropertyURI(String) - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

setProps(Map<String, Object>) - Method in class org.labkey.remoteapi.storage.StorageRow

The additional properties for the storage item being created/updated can be provided as the "props" for the StorageRow.

setProtocol(String) - Method in class org.labkey.remoteapi.ms2.StartSearchCommand

setProtocolId(long) - Method in class org.labkey.remoteapi.assay.GetProtocolCommand

setProtocolName(String) - Method in class org.labkey.remoteapi.assay.LoadAssayBatchCommand

setProtocolName(String) - Method in class org.labkey.remoteapi.assay.SaveAssayRunsCommand

setProtocolParameters(Map<String, String>) - Method in class org.labkey.remoteapi.assay.Protocol

setProtocolTransformScripts(List<String>) - Method in class org.labkey.remoteapi.assay.Protocol

setProviderName(String) - Method in class org.labkey.remoteapi.assay.GetProtocolCommand

setProviderName(String) - Method in class org.labkey.remoteapi.assay.Protocol

setProxy(String, Integer) - Method in class org.labkey.remoteapi.Connection

Sets the proxy host and port for this Connection.
NOTE: Changing this setting will force the underlying http client to be recreated.

setQCEnabled(boolean) - Method in class org.labkey.remoteapi.assay.Protocol

setQueryFilter(List<ConditionalFormatFilter>) - Method in class org.labkey.remoteapi.domain.ConditionalFormat

Set conditional format conditions

setQueryName(String) - Method in class org.labkey.remoteapi.domain.DropDomainCommand

Set the target domain's name

setQueryName(String) - Method in class org.labkey.remoteapi.domain.GetDomainDetailsCommand

setQueryName(String) - Method in class org.labkey.remoteapi.query.GetQueryDetailsCommand

setQueryName(String) - Method in class org.labkey.remoteapi.query.SaveRowsCommand

Sets a new query name to update

setQueryName(String) - Method in class org.labkey.remoteapi.query.SelectRowsCommand

Sets the query name this command will request.

setQueryName(String) - Method in class org.labkey.remoteapi.query.TruncateTableCommand

Sets a new query name to update

setQueryParameters(Map<String, String>) - Method in class org.labkey.remoteapi.query.BaseQueryCommand

Map of name (string)/value pairs for the values of parameters if the SQL references underlying queries that are parameterized.

setQueryParameters(Map<String, String>) - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

Map of name (string)/value pairs for the values of parameters if the SQL references underlying queries that are parameterized.

setQueryParameters(Map<String, String>) - Method in class org.labkey.remoteapi.query.SqlExecuteCommand

Map of name (string)/value pairs for the values of parameters if the SQL references underlying queries that are parameterized.

setRangeURI(String) - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

setRequired(Boolean) - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

setRequiredVersion(double) - Method in class org.labkey.remoteapi.Command

Sets the required version number for this API call.

setRequiredVersion(double) - Method in interface org.labkey.remoteapi.query.BaseSelect

setResultData(List<Map<String, Object>>) - Method in class org.labkey.remoteapi.assay.Run

setRowId(Integer) - Method in class org.labkey.remoteapi.storage.StorageRow

For the UpdateCommand and DeleteCommand, the "rowId" primary key value is required to be set.

setRowId(Integer) - Method in class org.labkey.remoteapi.study.ParticipantGroup

setRows(List<Map<String, Object>>) - Method in class org.labkey.remoteapi.query.SaveRowsCommand

Sets the list of 'rows' (i.e., Maps) to be sent to the server.

setRun(Run) - Method in class org.labkey.remoteapi.assay.GetAssayRunResponse

setRunFilePath(String) - Method in class org.labkey.remoteapi.assay.ImportRunCommand

Absolute or relative path to assay data file to be imported.

setRuns(List<Run>) - Method in class org.labkey.remoteapi.assay.Batch

setRuns(List<Run>) - Method in class org.labkey.remoteapi.assay.SaveAssayRunsCommand

setRuns(List<Run>) - Method in class org.labkey.remoteapi.assay.SaveAssayRunsResponse

setSampleSetId(Long) - Method in class org.labkey.remoteapi.assay.Material

setSampleSetName(String) - Method in class org.labkey.remoteapi.assay.Material

setSaveInSession(boolean) - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

Whether the definition of this query should be stored for reuse during the current session.

setSaveScriptFiles(Boolean) - Method in class org.labkey.remoteapi.assay.Protocol

setSaveToPipeline(boolean) - Method in class org.labkey.remoteapi.query.ImportDataCommand

Save the uploaded file to the pipeline root under the "QueryImportFiles" directory.

setSchemaName(String) - Method in class org.labkey.remoteapi.domain.DropDomainCommand

Set the target domain's schema name

setSchemaName(String) - Method in class org.labkey.remoteapi.domain.GetDomainDetailsCommand

setSchemaName(String) - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

Sets the current schema name.

setSchemaName(String) - Method in class org.labkey.remoteapi.query.GetQueriesCommand

setSchemaName(String) - Method in class org.labkey.remoteapi.query.GetQueryDetailsCommand

setSchemaName(String) - Method in class org.labkey.remoteapi.query.SaveRowsCommand

Sets the schema name

setSchemaName(String) - Method in class org.labkey.remoteapi.query.SelectRowsCommand

Sets the schema name this command will query.

setSchemaName(String) - Method in class org.labkey.remoteapi.query.SqlExecuteCommand

Sets the current schema name.

setSchemaName(String) - Method in class org.labkey.remoteapi.query.TruncateTableCommand

Sets the schema name

setSelectedDetectionMethod(String) - Method in class org.labkey.remoteapi.assay.Protocol

setSelectedMetadataInputFormat(String) - Method in class org.labkey.remoteapi.assay.Protocol

setSelectedPlateTemplate(String) - Method in class org.labkey.remoteapi.assay.Protocol

setSendEmail(boolean) - Method in class org.labkey.remoteapi.security.CreateUserCommand

Set to true to send email to the user with login instructions, false to skip email.

setSort(List<Sort>) - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

A sort specification to apply over the rows returned by the SQL.

setSorts(List<Sort>) - Method in class org.labkey.remoteapi.query.BaseQueryCommand

Sets the current set of sort definitions.

setSql(String) - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

Sets the SQL query to execute.

setSql(String) - Method in class org.labkey.remoteapi.query.SqlExecuteCommand

Sets the SQL query to execute.

setStrikethrough(boolean) - Method in class org.labkey.remoteapi.domain.ConditionalFormat

Set strikethrough flag for conditional format

setTemplateIncludeSubfolders(boolean) - Method in class org.labkey.remoteapi.security.BaseCreateFolderCommand

setTemplateSourceId(String) - Method in class org.labkey.remoteapi.security.BaseCreateFolderCommand

setTemplateWriterTypes(String...) - Method in class org.labkey.remoteapi.security.BaseCreateFolderCommand

setText(String) - Method in class org.labkey.remoteapi.query.ImportDataCommand

Submits tsv or csv data as text to the server for import.

setTextColor(String) - Method in class org.labkey.remoteapi.domain.ConditionalFormat

Set the conditional text color.

setTimeout(Integer) - Method in class org.labkey.remoteapi.Command

Sets the timeout for this Command.

setTimeout(Integer) - Method in class org.labkey.remoteapi.Connection

Set a default timeout for Commands that have not established their own timeouts.

setTitle(String) - Method in class org.labkey.remoteapi.security.CreateContainerCommand

setTitle(String) - Method in class org.labkey.remoteapi.security.RenameContainerCommand

setType(String) - Method in class org.labkey.remoteapi.assay.AssayListCommand

Sets the assay type filter.

setType(String) - Method in class org.labkey.remoteapi.security.CreateContainerCommand

setType(StorageItemTypes) - Method in class org.labkey.remoteapi.storage.StorageRow

Storage items can be of the following types: Physical Location, Freezer, Shelf, Rack, Canister, Storage Unit Type, or Terminal Storage Location.

setUseAsync(boolean) - Method in class org.labkey.remoteapi.query.ImportDataCommand

Import the data in a pipeline job.

setUseJson(boolean) - Method in class org.labkey.remoteapi.assay.ImportRunCommand

setUserAgent(String) - Method in class org.labkey.remoteapi.Connection

setUserId(int) - Method in class org.labkey.remoteapi.security.DeleteUserCommand

setValue(Object) - Method in class org.labkey.remoteapi.query.Filter

setVerboseLogging(Boolean) - Method in class org.labkey.remoteapi.di.UpdateTransformConfigurationCommand

setViewName(String) - Method in class org.labkey.remoteapi.query.SelectRowsCommand

Sets a particular saved view to request.

setWafEncoding(boolean) - Method in class org.labkey.remoteapi.query.ExecuteSqlCommand

By default, this command encodes the SQL parameter to allow it to pass through web application firewalls.

setWorkbook(boolean) - Method in class org.labkey.remoteapi.security.CreateContainerCommand

SHA1 - Enum constant in enum class org.labkey.remoteapi.totp.HashingAlgorithm

SHA256 - Enum constant in enum class org.labkey.remoteapi.totp.HashingAlgorithm

SHA512 - Enum constant in enum class org.labkey.remoteapi.totp.HashingAlgorithm

Shelf - Enum constant in enum class org.labkey.remoteapi.storage.StorageItemTypes

shouldRetryRequest(CommandException, HttpUriRequest) - Method in class org.labkey.remoteapi.ApiKeyCredentialsProvider

shouldRetryRequest(CommandException, HttpUriRequest) - Method in interface org.labkey.remoteapi.CredentialsProvider

Should the Command attempt to retry the request?

SimpleGetCommand - Class in org.labkey.remoteapi

SimpleGetCommand(String, String) - Constructor for class org.labkey.remoteapi.SimpleGetCommand

SimplePostCommand - Class in org.labkey.remoteapi

SimplePostCommand(String, String) - Constructor for class org.labkey.remoteapi.SimplePostCommand

simpleSelectDemo() - Method in class org.labkey.remoteapi.test.Demo

Sort - Class in org.labkey.remoteapi.query

Represents a particular sort order entry, which consists of a column name and an optional direction

Sort(String) - Constructor for class org.labkey.remoteapi.query.Sort

Sort(String, Sort.Direction) - Constructor for class org.labkey.remoteapi.query.Sort

Sort(Sort) - Constructor for class org.labkey.remoteapi.query.Sort

Sort.Direction - Enum Class in org.labkey.remoteapi.query

sortFilterDemo() - Method in class org.labkey.remoteapi.test.Demo

SqlExecuteCommand - Class in org.labkey.remoteapi.query

Command for executing arbitrary LabKey SQL.

SqlExecuteCommand(String) - Constructor for class org.labkey.remoteapi.query.SqlExecuteCommand

Constructs an ExecuteSqlCommand, initialized with a schema name.

SqlExecuteCommand(String, String) - Constructor for class org.labkey.remoteapi.query.SqlExecuteCommand

Constructs an ExecuteSqlCommand, initialized with a schema name and SQL query.

STARTS_WITH - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

StartSearchCommand - Class in org.labkey.remoteapi.ms2

Initiates an MS2 search.

StartSearchCommand(StartSearchCommand.SearchEngine, String, String, List<String>) - Constructor for class org.labkey.remoteapi.ms2.StartSearchCommand

StartSearchCommand.SearchEngine - Enum Class in org.labkey.remoteapi.ms2

The set of supported search engines, which may or may not be available on any given server

StartSearchResponse - Class in org.labkey.remoteapi.ms2

StartSearchResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.ms2.StartSearchResponse

stopImpersonating() - Method in class org.labkey.remoteapi.Connection

Stop impersonating a user.

StopImpersonatingCommand - Class in org.labkey.remoteapi.security

Stop impersonating a user, group, or role(s).

StopImpersonatingCommand() - Constructor for class org.labkey.remoteapi.security.StopImpersonatingCommand

StorageCommandResponse - Class in org.labkey.remoteapi.storage

Response object used for the storage CreateCommand, UpdateCommand, and DeleteCommand.

StorageCommandResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.storage.StorageCommandResponse

Constructs a new StorageCommandResponse, initialized with the provided response text and status code.

StorageItemTypes - Enum Class in org.labkey.remoteapi.storage

StorageRow - Class in org.labkey.remoteapi.storage

The storage properties object used for the storage CreateCommand, UpdateCommand, and DeleteCommand.

StorageRow() - Constructor for class org.labkey.remoteapi.storage.StorageRow

StorageUnitType - Enum constant in enum class org.labkey.remoteapi.storage.StorageItemTypes

STRING - Enum constant in enum class org.labkey.remoteapi.query.SelectRowsResponse.ColumnDataType

SUMMARY - Enum constant in enum class org.labkey.remoteapi.query.SaveRowsCommand.AuditBehavior

T

TerminalStorageLocation - Enum constant in enum class org.labkey.remoteapi.storage.StorageItemTypes

Test - Class in org.labkey.remoteapi.test

Test() - Constructor for class org.labkey.remoteapi.test.Test

text - Enum constant in enum class org.labkey.remoteapi.query.ImportDataCommand.ImportDataType

TimeProvider - Class in org.labkey.remoteapi.totp

TimeProvider() - Constructor for class org.labkey.remoteapi.totp.TimeProvider

toJSON() - Method in class org.labkey.remoteapi.domain.ConditionalFormat

Convert bean to JSON for serialization

toJsonObject() - Method in class org.labkey.remoteapi.storage.StorageRow

toJSONObject() - Method in class org.labkey.remoteapi.assay.Batch

toJSONObject() - Method in class org.labkey.remoteapi.assay.Data

toJSONObject() - Method in class org.labkey.remoteapi.assay.ExpObject

toJSONObject() - Method in class org.labkey.remoteapi.assay.Material

toJSONObject() - Method in class org.labkey.remoteapi.assay.Protocol

toJSONObject() - Method in class org.labkey.remoteapi.assay.Run

toJSONObject() - Method in class org.labkey.remoteapi.domain.Domain

toJSONObject() - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

toJSONObject(boolean) - Method in class org.labkey.remoteapi.domain.Domain

toJSONObject(boolean) - Method in class org.labkey.remoteapi.domain.PropertyDescriptor

toQueryStringParam() - Method in class org.labkey.remoteapi.query.Sort

toString() - Method in class org.labkey.remoteapi.query.Filter

toString() - Method in class org.labkey.remoteapi.query.RowMap

TotpManager - Class in org.labkey.remoteapi.totp

TotpManager() - Constructor for class org.labkey.remoteapi.totp.TotpManager

truncateAssayFailsTest(Connection, String) - Static method in class org.labkey.remoteapi.test.Test

TruncateTableCommand - Class in org.labkey.remoteapi.query

Command for truncating a table from a read-write schema.

TruncateTableCommand(String, String) - Constructor for class org.labkey.remoteapi.query.TruncateTableCommand

Constructs a TruncateTableCommand for the given schemaName and queryName.

TruncateTableResponse - Class in org.labkey.remoteapi.query

Response object used for commands that derive from TruncateTableCommand.

TruncateTableResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.query.TruncateTableResponse

Constructs a new TruncateTableResponse given the response text and status code

truncateTableSuccessTest(Connection, String) - Static method in class org.labkey.remoteapi.test.Test

U

UpdateCommand - Class in org.labkey.remoteapi.storage

Update an existing LabKey Freezer Manager storage item to change its properties or location within the freezer hierarchy.

UpdateCommand(StorageRow) - Constructor for class org.labkey.remoteapi.storage.UpdateCommand

Constructs a new UpdateCommand for the given StorageRow.

UpdatedParticipantGroup() - Constructor for class org.labkey.remoteapi.study.UpdateParticipantGroupCommand.UpdatedParticipantGroup

UpdateParticipantGroupCommand - Class in org.labkey.remoteapi.study

Request to be sent to the server to update an existing participant group

UpdateParticipantGroupCommand(ParticipantGroup) - Constructor for class org.labkey.remoteapi.study.UpdateParticipantGroupCommand

UpdateParticipantGroupCommand.UpdatedParticipantGroup - Class in org.labkey.remoteapi.study

Special subclass that allows specifying just participants that should be added or removed, without needing to specify the full set of participants.

UpdateParticipantGroupResponse - Class in org.labkey.remoteapi.study

Result of making a request to the server to update an existing participant group

UpdateParticipantGroupResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.study.UpdateParticipantGroupResponse

UpdateRowsCommand - Class in org.labkey.remoteapi.query

Command for updating rows into a table in a read-write schema.

UpdateRowsCommand(String, String) - Constructor for class org.labkey.remoteapi.query.UpdateRowsCommand

Constructs an UpdateRowsCommand for the given schemaName and queryName.

UpdateTransformConfigurationCommand - Class in org.labkey.remoteapi.di

UpdateTransformConfigurationCommand(String) - Constructor for class org.labkey.remoteapi.di.UpdateTransformConfigurationCommand

UpdateTransformConfigurationResponse - Class in org.labkey.remoteapi.di

UpdateTransformConfigurationResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.di.UpdateTransformConfigurationResponse

Constructs a new CommandResponse, initialized with the provided response text and status code.

V

valueOf(String) - Static method in enum class org.labkey.remoteapi.Command.CommonParameters

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.labkey.remoteapi.ms2.StartSearchCommand.SearchEngine

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.labkey.remoteapi.query.ContainerFilter

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.labkey.remoteapi.query.Filter.Operator

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.labkey.remoteapi.query.ImportDataCommand.ImportDataType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.labkey.remoteapi.query.ImportDataCommand.InsertOption

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.labkey.remoteapi.query.SaveRowsCommand.AuditBehavior

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.labkey.remoteapi.query.SelectRowsResponse.ColumnDataType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.labkey.remoteapi.query.Sort.Direction

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.labkey.remoteapi.storage.StorageItemTypes

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.labkey.remoteapi.totp.HashingAlgorithm

Returns the enum constant of this class with the specified name.

values() - Static method in enum class org.labkey.remoteapi.Command.CommonParameters

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.labkey.remoteapi.ms2.StartSearchCommand.SearchEngine

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.labkey.remoteapi.query.ContainerFilter

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.labkey.remoteapi.query.Filter.Operator

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.labkey.remoteapi.query.ImportDataCommand.ImportDataType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.labkey.remoteapi.query.ImportDataCommand.InsertOption

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.labkey.remoteapi.query.SaveRowsCommand.AuditBehavior

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.labkey.remoteapi.query.SelectRowsResponse.ColumnDataType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.labkey.remoteapi.query.Sort.Direction

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.labkey.remoteapi.storage.StorageItemTypes

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.labkey.remoteapi.totp.HashingAlgorithm

Returns an array containing the constants of this enum class, in the order they are declared.

W

WAF_PREFIX - Static variable in class org.labkey.remoteapi.internal.EncodeUtils

wafEncode(String) - Static method in class org.labkey.remoteapi.internal.EncodeUtils

Obfuscates content that's often intercepted by web application firewalls that are scanning for likely SQL or script injection.

WHERE - Enum constant in enum class org.labkey.remoteapi.query.Filter.Operator

WhoAmICommand - Class in org.labkey.remoteapi.security

WhoAmICommand() - Constructor for class org.labkey.remoteapi.security.WhoAmICommand

WhoAmIResponse - Class in org.labkey.remoteapi.security

WhoAmIResponse(String, int, String, JSONObject) - Constructor for class org.labkey.remoteapi.security.WhoAmIResponse

X

X_LABKEY_CSRF - Static variable in class org.labkey.remoteapi.Connection

XTandem - Enum constant in enum class org.labkey.remoteapi.ms2.StartSearchCommand.SearchEngine

_

_allProperties - Variable in class org.labkey.remoteapi.ResponseObject

_containerFilter - Variable in class org.labkey.remoteapi.query.BaseQueryCommand

_execute(Connection, String) - Method in class org.labkey.remoteapi.Command

_filters - Variable in class org.labkey.remoteapi.query.BaseQueryCommand

_importIdentity - Variable in class org.labkey.remoteapi.query.ImportDataCommand

_importLookupByAlternateKey - Variable in class org.labkey.remoteapi.query.ImportDataCommand

_maxRows - Variable in class org.labkey.remoteapi.query.BaseQueryCommand

_offset - Variable in class org.labkey.remoteapi.query.BaseQueryCommand

_sorts - Variable in class org.labkey.remoteapi.query.BaseQueryCommand

A B C D E F G H I J L M N O P Q R S T U V W X _
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form