com.gentics.contentnode.rest.model.request

Class PageSaveRequest

java.lang.Object

com.gentics.contentnode.rest.model.request.PageSaveRequest

public class PageSaveRequest
extends Object

Request used for saving a page. If not set otherwise, a new version will be created (if necessary) and the page will remain locked for the user.

Author:

floriangutmann

Constructor Summary

Constructors

Constructor and Description
PageSaveRequest() Constructor used by JAXB
PageSaveRequest(Page page) Creates a new PageSaveRequest with a specified page

Method Summary

Modifier and Type	Method and Description
List<String>	getDelete() List of tag names of tags, that shall be deleted.
Boolean	getDeriveFileName() Indicates whether the filename should be derived from the page name, when no filename is given in the request.
Boolean	getFailOnDuplicate() True if saving the page with a duplicate name will fail.
Page	getPage() Page to be saved
boolean	isClearOfflineAt() Flag to clear the "offline At" data (time)
boolean	isClearPublishAt() Flag to clear the "publish At" data (time and version)
boolean	isCreateVersion() True if a page version shall be created, false if not.
boolean	isUnlock() True if the page shall be unlocked after saving, false if not.
void	setClearOfflineAt(boolean clearOfflineAt) Set true to clear "offline At" data
void	setClearPublishAt(boolean clearPublishAt) Set true to clear "publish At" data
void	setCreateVersion(boolean createVersion) Set whether to create a page version
void	setDelete(List<String> delete) Set the list of tags that need to be deleted
void	setDeriveFileName(Boolean deriveFileName) Set whether the filename should be derived from the page name, when no filename is given in the request.
void	setFailOnDuplicate(Boolean failOnDuplicate) Set whether saving shall fail on duplicate names
void	setPage(Page page)
void	setUnlock(boolean unlock)

Methods inherited from class java.lang.Object

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

Constructor Detail

PageSaveRequest

public PageSaveRequest()

Constructor used by JAXB

PageSaveRequest

public PageSaveRequest(Page page)

Creates a new PageSaveRequest with a specified page

Parameters:

page - The page to save

Method Detail

getPage

public Page getPage()

Page to be saved

Returns:

page to be saved

setPage

public void setPage(Page page)

isUnlock

public boolean isUnlock()

True if the page shall be unlocked after saving, false if not. The default is false.

Returns:

the unlock

setUnlock

public void setUnlock(boolean unlock)

Parameters:

unlock - the unlock to set

isCreateVersion

public boolean isCreateVersion()

True if a page version shall be created, false if not. The default is true.

Returns:

true for creating a page version

setCreateVersion

public void setCreateVersion(boolean createVersion)

Set whether to create a page version

Parameters:

createVersion - true to create a page version

getDelete

public List<String> getDelete()

List of tag names of tags, that shall be deleted.

Returns:

the delete

setDelete

public void setDelete(List<String> delete)

Set the list of tags that need to be deleted

Parameters:

delete - list of tags that need to be deleted

getFailOnDuplicate

public Boolean getFailOnDuplicate()

True if saving the page 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

getDeriveFileName

public Boolean getDeriveFileName()

Indicates whether the filename should be derived from the page name, when no filename is given in the request. By default, the filename will not be derived from the page name. When the filename is provided in the request, this flag is ignored.

Returns:

true if the filename will be derived from the page name, when the request filename is empty. false otherwise.

setDeriveFileName

public void setDeriveFileName(Boolean deriveFileName)

Set whether the filename should be derived from the page name, when no filename is given in the request.

Parameters:

deriveFileName - When set to true and the request filename is empty, the filename will be derived from the page name. When set to false or the filename is not empty, the behavior while saving the page is not changed.

isClearPublishAt

public boolean isClearPublishAt()

Flag to clear the "publish At" data (time and version)

Returns:

true to clear

setClearPublishAt

public void setClearPublishAt(boolean clearPublishAt)

Set true to clear "publish At" data

Parameters:

clearPublishAt - flag

isClearOfflineAt

public boolean isClearOfflineAt()

Flag to clear the "offline At" data (time)

Returns:

true to clear

setClearOfflineAt

public void setClearOfflineAt(boolean clearOfflineAt)

Set true to clear "offline At" data

Parameters:

clearOfflineAt - flag