Class PageCreateRequest
java.lang.Object
com.gentics.contentnode.rest.model.request.PageCreateRequest
Page create request
- Author:
- norbert
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionAlternate URLs (in alphabetical order)Contentset ID of the pageDescription of the pageTrue if creating the page with a duplicate name will fail.Filename of the pageThe ID of the folder, where the page shall be created.Language of the created pageNice URL of the pageId of the node we want to create page in.Name of the pagePriority of the pageId of the template the created page shall useThe channel of the source page of the variant.Id of the page, this page shall be a variant ofboolean
Flag for forcing creating of page with the given filename, even if the extension does not match the template's extension.setAlternateUrls
(SortedSet<String> alternateUrls) Set the alternate URLssetContentSetId
(Integer contentSetId) Set the contentSetId of the pagesetDescription
(String description) Set the description of the pagesetFailOnDuplicate
(Boolean failOnDuplicate) Set whether creating shall fail on duplicate namessetFileName
(String fileName) Set the filenamesetFolderId
(String folderId) setForceExtension
(boolean forceExtension) Set whether thesetLanguage
(String language) setNiceUrl
(String niceUrl) Set the nice URLSet the node id of the pagesetPageName
(String pageName) Set the pagenamesetPriority
(Integer priority) Set the priority of the pagesetTemplateId
(Integer templateId) setVariantChannelId
(Integer variantChannelId) Set the source channel for the page to createsetVariantId
(Integer variantId)
-
Constructor Details
-
PageCreateRequest
public PageCreateRequest()Constructor for JAXB
-
-
Method Details
-
getFolderId
The ID of the folder, where the page shall be created. This may either be the local or the global folder id.- Returns:
- the folderId
-
getTemplateId
Id of the template the created page shall use- Returns:
- the templateId
-
getVariantId
Id of the page, this page shall be a variant of- Returns:
- the page id to create a variant from
-
getLanguage
Language of the created page- Returns:
- the language
-
setFolderId
- Parameters:
folderId
- the folderId to set- Returns:
- fluent API
-
setTemplateId
- Parameters:
templateId
- the templateId to set- Returns:
- fluent API
-
setVariantId
- Parameters:
variantId
-- Returns:
- fluent API
-
setLanguage
- Parameters:
language
- the language to set- Returns:
- fluent API
-
setNodeId
Set the node id of the page- Parameters:
nodeId
-- Returns:
- fluent API
-
getNodeId
Id of the node we want to create page in.- Returns:
- the node id of the page
-
getPageName
Name of the page- Returns:
- the page name
-
setPageName
Set the pagename- Parameters:
pageName
-- Returns:
- fluent API
-
getFileName
Filename of the page- Returns:
- the filename
-
setFileName
Set the filename- Parameters:
fileName
-- Returns:
- fluent API
-
getNiceUrl
Nice URL of the page- Returns:
- Nice URL
-
setNiceUrl
Set the nice URL- Parameters:
niceUrl
- nice URL- Returns:
- fluent API
-
getAlternateUrls
Alternate URLs (in alphabetical order)- Returns:
- sorted alternate URLs
-
setAlternateUrls
Set the alternate URLs- Parameters:
alternateUrls
- alternate URLs- Returns:
- fluent API
-
isForceExtension
public boolean isForceExtension()Flag for forcing creating of page with the given filename, even if the extension does not match the template's extension. If this flag is false, and the proposed filename does not have the correct extension, the extension will be appended. If the flag is true, no extension will be appended.- Returns:
- force filename extension
-
setForceExtension
Set whether the- Parameters:
forceExtension
-- Returns:
- fluent API
-
getDescription
Description of the page- Returns:
- the description of the new page
-
setDescription
Set the description of the page- Parameters:
description
-- Returns:
- fluent API
-
getPriority
Priority of the page- Returns:
- the priority of the new page
-
setPriority
Set the priority of the page- Parameters:
priority
- the page priotiry- Returns:
- fluent API
-
getContentSetId
Contentset ID of the page- Returns:
- the contentset id of the new page
-
setContentSetId
Set the contentSetId of the page- Parameters:
contentSetId
-- Returns:
- fluent API
-
getFailOnDuplicate
True if creating the page with a duplicate name will fail. If false (default) the name will be made unique before saving.- Returns:
- true or false
-
setFailOnDuplicate
Set whether creating shall fail on duplicate names- Parameters:
failOnDuplicate
- true to fail on duplicate names- Returns:
- fluent API
-
getVariantChannelId
The channel of the source page of the variant. If a variant is created, the source page and its translation are taken from this channel. If not specified, the channel in which the page specified by variantId was created is used instead.- Returns:
- the channel id of the source page
-
setVariantChannelId
Set the source channel for the page to create- Parameters:
variantChannelId
-- Returns:
- fluent API
-