Package org.labkey.remoteapi.security

Class BaseCreateFolderCommand<COMMAND extends BaseCreateFolderCommand<?>>

java.lang.Object

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

org.labkey.remoteapi.PostCommand<CommandResponse>

org.labkey.remoteapi.security.BaseCreateFolderCommand<COMMAND>

All Implemented Interfaces:

HasRequiredVersion

Direct Known Subclasses:

CreateFolderCommand, CreateProjectCommand

public abstract class BaseCreateFolderCommand<COMMAND extends BaseCreateFolderCommand<?>>
extends PostCommand<CommandResponse>

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

Modifier	Constructor	Description
protected	BaseCreateFolderCommand(String actionName)

Method Summary

Modifier and Type	Method	Description
protected org.apache.hc.client5.http.classic.methods.HttpPost	createRequest(URI uri)	Creates the HttpPost instance used for the request.
protected List<org.apache.hc.core5.http.message.BasicNameValuePair>	getPostData()
COMMAND	setFolderType(String folderType)
COMMAND	setName(String name)
COMMAND	setTemplateIncludeSubfolders(boolean templateIncludeSubfolders)
COMMAND	setTemplateSourceId(String templateSourceId)
COMMAND	setTemplateWriterTypes(String... templateWriterTypes)

Methods inherited from class org.labkey.remoteapi.PostCommand

getJsonObject

Methods inherited from class org.labkey.remoteapi.Command

_execute, createParameterMap, createResponse, 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

BaseCreateFolderCommand

protected BaseCreateFolderCommand(String actionName)

Method Details

setName

public COMMAND setName(String name)

setFolderType

public COMMAND setFolderType(String folderType)

setTemplateSourceId

public COMMAND setTemplateSourceId(String templateSourceId)

setTemplateIncludeSubfolders

public COMMAND setTemplateIncludeSubfolders(boolean templateIncludeSubfolders)

setTemplateWriterTypes

public COMMAND setTemplateWriterTypes(String... templateWriterTypes)

getPostData

protected List<org.apache.hc.core5.http.message.BasicNameValuePair> getPostData()

createRequest

protected org.apache.hc.client5.http.classic.methods.HttpPost createRequest(URI uri)

Description copied from class: PostCommand

Creates the HttpPost instance used for the request. Override to modify the HttpPost object before use or to send something other than JSON in the post body. In your override, create the HttpPost and set the request entity appropriately.

Overrides:

createRequest in class PostCommand<CommandResponse>

Parameters:

uri - the uri to convert

Returns:

The PostMethod object.