Class DropDomainCommand

java.lang.Object

org.labkey.remoteapi.Command<CommandResponse, org.apache.hc.client5.http.classic.methods.HttpPost>

org.labkey.remoteapi.PostCommand<CommandResponse>

org.labkey.remoteapi.domain.DropDomainCommand

All Implemented Interfaces:

HasRequiredVersion

public class DropDomainCommand
extends PostCommand<CommandResponse>

Command to delete a domain.

Nested Class Summary

Nested classes/interfaces inherited from class Command

Command.CommonParameters, Command.Response

Field Summary

Fields inherited from class Command

CONTENT_TYPE_JSON

Constructor Summary

Constructors

Constructor	Description
DropDomainCommand(String schemaName, String queryName)	Instantiate command to delete the specified domain.

Method Summary

Modifier and Type	Method	Description
org.json.JSONObject	getJsonObject()	Returns the JSON object to post or null for no JSON.
String	getQueryName()
String	getSchemaName()
void	setQueryName(String queryName)	Set the target domain's name
void	setSchemaName(String schemaName)	Set the target domain's schema name

Methods inherited from class PostCommand

createRequest

Methods inherited from class Command

_execute, createParameterMap, createResponse, execute, getActionName, getControllerName, getHttpRequest, getParameters, getParamValueAsString, getRequiredVersion, getTimeout, setRequiredVersion, setTimeout

Methods inherited from class Object

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

Constructor Details

DropDomainCommand

public DropDomainCommand(String schemaName,
 String queryName)

Instantiate command to delete the specified domain.

Parameters:

schemaName - parent schema of the domain to delete

queryName - name of the domain to delete

Method Details

getQueryName

public String getQueryName()

Returns:

Name of the domain to delete

setQueryName

public void setQueryName(String queryName)

Set the target domain's name

Parameters:

queryName - Name of the domain to delete

getSchemaName

public String getSchemaName()

Returns:

parent schema of the domain to delete

setSchemaName

public void setSchemaName(String schemaName)

Set the target domain's schema name

Parameters:

schemaName - parent schema of the domain to delete

getJsonObject

public org.json.JSONObject getJsonObject()

Description copied from class: PostCommand

Returns the JSON object to post or null for no JSON. Override this method to provide parameters as JSON.

Overrides:

getJsonObject in class PostCommand<CommandResponse>

Returns:

The JSON object to post.