Package org.labkey.remoteapi.domain

Class CreateDomainCommand

java.lang.Object

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

org.labkey.remoteapi.PostCommand<DomainResponse>

org.labkey.remoteapi.domain.CreateDomainCommand

All Implemented Interfaces:

HasRequiredVersion

public class CreateDomainCommand
extends PostCommand<DomainResponse>

Command class for creating a new domain.

The domain definition can be customized by modifying the Domain returned by getDomainDesign().

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

Constructors

Constructor	Description
CreateDomainCommand(String kind, String domainName)	Initialize command to create a domain of the specified "kind".

Method Summary

Modifier and Type	Method	Description
protected DomainResponse	createResponse(String text, int status, String contentType, org.json.JSONObject json)	Creates an instance of the response class, initialized with the response text, the HTTP status code, and parsed JSONObject.
Domain	getDomainDesign()	Get the domain design that will be POSTed by this command.
org.json.JSONObject	getJsonObject()	Returns the JSON object to post or null for no JSON.
String	getKind()
Map<String,Object>	getOptions()	Get the 'options' map for the domain to be created.
void	setDomainDesign(Domain design)	Set the domain design that will be POSTed by this command.
void	setKind(String kind)	Set the "kind" of the domain to be created.
void	setOptions(Map<String,Object> options)	Set options for the domain to be created.

Methods inherited from class org.labkey.remoteapi.PostCommand

createRequest

Methods inherited from class org.labkey.remoteapi.Command

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

Methods inherited from class java.lang.Object

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

Constructor Details

CreateDomainCommand

public CreateDomainCommand(String kind,
 String domainName)

Initialize command to create a domain of the specified "kind". Available domain kinds depends on the modules installed on the target server.

Parameters:

kind - the "kind" of domain to create (e.g. "IntList", "DataClass")

domainName - name for the created domain

Method Details

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.

Returns:

The JSON object to post.

getKind

public String getKind()

Returns:

the "kind" of domain to be created

setKind

public void setKind(String kind)

Set the "kind" of the domain to be created.

Parameters:

kind - the "kind" of domain to create (e.g. "IntList", "DataClass")

getOptions

public Map<String,Object> getOptions()

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

Returns:

domain options

setOptions

public void setOptions(Map<String,Object> options)

Set options for the domain to be created. Recognized options vary based on the domain kind specified.

Parameters:

options - domain options

createResponse

protected DomainResponse createResponse(String text,
 int status,
 String contentType,
 org.json.JSONObject json)

Description copied from class: Command

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

Override this method to create an instance of a different class that extends CommandResponse

Overrides:

createResponse in class Command<DomainResponse,org.apache.hc.client5.http.classic.methods.HttpPost>

Parameters:

text - The response text from the server.

status - The HTTP status code.

contentType - The Content-Type header value.

json - The parsed JSONObject (or null if no JSON was returned).

Returns:

An instance of the response object.

getDomainDesign

public Domain getDomainDesign()

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

Returns:

reference to the domain design

setDomainDesign

public void setDomainDesign(Domain design)

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

Parameters:

design - domain design to be used by this command.