com.gentics.contentnode.rest.model.request

Class FolderSaveRequest

java.lang.Object

com.gentics.contentnode.rest.model.request.FolderSaveRequest

public class FolderSaveRequest
extends Object

Request object for a request to save a folder

Author:

norbert

Constructor Summary

Constructors

Constructor and Description
FolderSaveRequest() Constructor used by JAXB

Method Summary

Modifier and Type	Method and Description
Boolean	getFailOnDuplicate() True if saving the folder with a duplicate name will fail.
Folder	getFolder()
Integer	getForegroundTime() Number of seconds, the job may run in the foreground
Integer	getNodeId() Node ID, when setting the publish directory recursively.
Boolean	getRecursive() True to set the publish directory recursively, false (default) to only change this given folder
List<String>	getTagsToSubfolders() List of object tags, that shall be passed on to subfolders.
void	setFailOnDuplicate(Boolean failOnDuplicate) Set whether saving shall fail on duplicate names
void	setFolder(Folder folder)
void	setForegroundTime(Integer foregroundTime) Set the foreground time
void	setNodeId(Integer nodeId) Set the node ID
void	setRecursive(Boolean recursive) Set true to change the publish directory recursively
void	setTagsToSubfolders(List<String> tagsToSubfolders) Set list of object tags to pass on to subfolders

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderSaveRequest

public FolderSaveRequest()

Constructor used by JAXB

Method Detail

getFolder

public Folder getFolder()

Returns:

the folder

setFolder

public void setFolder(Folder folder)

Parameters:

folder - the folder to set

getNodeId

public Integer getNodeId()

Node ID, when setting the publish directory recursively.

Returns:

node ID

getTagsToSubfolders

public List<String> getTagsToSubfolders()

List of object tags, that shall be passed on to subfolders. May contain names (with or without the prefix 'object.') or IDs

Returns:

list of object tags

setNodeId

public void setNodeId(Integer nodeId)

Set the node ID

Parameters:

nodeId - node ID

getRecursive

public Boolean getRecursive()

True to set the publish directory recursively, false (default) to only change this given folder

Returns:

true for setting recursively

setRecursive

public void setRecursive(Boolean recursive)

Set true to change the publish directory recursively

Parameters:

recursive - true to for setting recursively

getFailOnDuplicate

public Boolean getFailOnDuplicate()

True if saving the folder with a duplicate name will fail. If false (default) the name will be made unique before saving

Returns:

true or false

setFailOnDuplicate

public void setFailOnDuplicate(Boolean failOnDuplicate)

Set whether saving shall fail on duplicate names

Parameters:

failOnDuplicate - true to fail on duplicate names

setTagsToSubfolders

public void setTagsToSubfolders(List<String> tagsToSubfolders)

Set list of object tags to pass on to subfolders

Parameters:

tagsToSubfolders - list of object tags

getForegroundTime

public Integer getForegroundTime()

Number of seconds, the job may run in the foreground

Returns:

foreground time in seconds

setForegroundTime

public void setForegroundTime(Integer foregroundTime)

Set the foreground time

Parameters:

foregroundTime - foreground time