Package org.labkey.remoteapi.domain
Class DropDomainCommand
java.lang.Object
org.labkey.remoteapi.Command<ResponseType,org.apache.hc.client5.http.classic.methods.HttpPost>
- All Implemented Interfaces:
HasRequiredVersion
Command to delete a domain.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.labkey.remoteapi.Command
Command.CommonParameters, Command.Response
-
Field Summary
Fields inherited from class org.labkey.remoteapi.Command
CONTENT_TYPE_JSON
-
Constructor Summary
ConstructorsConstructorDescriptionDropDomainCommand
(String schemaName, String queryName) Instantiate command to delete the specified domain. -
Method Summary
Modifier and TypeMethodDescriptionorg.json.JSONObject
Returns the JSON object to post or null for no JSON.void
setQueryName
(String queryName) Set the target domain's namevoid
setSchemaName
(String schemaName) Set the target domain's schema nameMethods inherited from class org.labkey.remoteapi.PostCommand
createRequest
Methods inherited from class org.labkey.remoteapi.Command
_execute, createParameterMap, createResponse, execute, getActionName, getControllerName, getHttpRequest, getParameters, getParamValueAsString, getRequiredVersion, getTimeout, setRequiredVersion, setTimeout
-
Constructor Details
-
DropDomainCommand
Instantiate command to delete the specified domain.- Parameters:
schemaName
- parent schema of the domain to deletequeryName
- name of the domain to delete
-
-
Method Details
-
getQueryName
- Returns:
- Name of the domain to delete
-
setQueryName
Set the target domain's name- Parameters:
queryName
- Name of the domain to delete
-
getSchemaName
- Returns:
- parent schema of the domain to delete
-
setSchemaName
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 classPostCommand<CommandResponse>
- Returns:
- The JSON object to post.
-