Package org.labkey.remoteapi.security

Class CreateContainerCommand

java.lang.Object

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

org.labkey.remoteapi.PostCommand<CreateContainerResponse>

org.labkey.remoteapi.security.CreateContainerCommand

All Implemented Interfaces:

HasRequiredVersion

public class CreateContainerCommand
extends PostCommand<CreateContainerResponse>

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

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
CreateContainerCommand(String name)

Method Summary

Modifier and Type	Method	Description
protected CreateContainerResponse	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.
String	getDescription()
String	getFolderType()
org.json.JSONObject	getJsonObject()	Returns the JSON object to post or null for no JSON.
String	getName()
String	getTitle()
String	getType()
boolean	isWorkbook()
void	setDescription(String description)
void	setFolderType(String folderType)
void	setName(String name)
void	setTitle(String title)
void	setType(String type)
void	setWorkbook(boolean workbook)

Methods inherited from class org.labkey.remoteapi.PostCommand

createRequest

Methods inherited from class org.labkey.remoteapi.Command

_execute, checkThrowError, 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

CreateContainerCommand

public CreateContainerCommand(String name)

Parameters:

name - the name of the container to create

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.

Overrides:

getJsonObject in class PostCommand<CreateContainerResponse>

Returns:

The JSON object to post.

getName

public String getName()

setName

public void setName(String name)

getType

public String getType()

setType

public void setType(String type)

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

isWorkbook

public boolean isWorkbook()

setWorkbook

public void setWorkbook(boolean workbook)

getFolderType

public String getFolderType()

setFolderType

public void setFolderType(String folderType)

createResponse

protected CreateContainerResponse 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<CreateContainerResponse,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.