Class PageCreateRequest


  • public class PageCreateRequest
    extends Object
    Page create request
    Author:
    norbert
    • Constructor Detail

      • PageCreateRequest

        public PageCreateRequest()
        Constructor for JAXB
    • Method Detail

      • getFolderId

        public String 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

        public Integer getTemplateId()
        Id of the template the created page shall use
        Returns:
        the templateId
      • getVariantId

        public Integer getVariantId()
        Id of the page, this page shall be a variant of
        Returns:
        the page id to create a variant from
      • getLanguage

        public String getLanguage()
        Language of the created page
        Returns:
        the language
      • setFolderId

        public PageCreateRequest setFolderId​(String folderId)
        Parameters:
        folderId - the folderId to set
        Returns:
        fluent API
      • setTemplateId

        public PageCreateRequest setTemplateId​(Integer templateId)
        Parameters:
        templateId - the templateId to set
        Returns:
        fluent API
      • setVariantId

        public PageCreateRequest setVariantId​(Integer variantId)
        Parameters:
        variantId -
        Returns:
        fluent API
      • setLanguage

        public PageCreateRequest setLanguage​(String language)
        Parameters:
        language - the language to set
        Returns:
        fluent API
      • setNodeId

        public PageCreateRequest setNodeId​(Integer nodeId)
        Set the node id of the page
        Parameters:
        nodeId -
        Returns:
        fluent API
      • getNodeId

        public Integer getNodeId()
        Id of the node we want to create page in.
        Returns:
        the node id of the page
      • getPageName

        public String getPageName()
        Name of the page
        Returns:
        the page name
      • setPageName

        public PageCreateRequest setPageName​(String pageName)
        Set the pagename
        Parameters:
        pageName -
        Returns:
        fluent API
      • getFileName

        public String getFileName()
        Filename of the page
        Returns:
        the filename
      • setFileName

        public PageCreateRequest setFileName​(String fileName)
        Set the filename
        Parameters:
        fileName -
        Returns:
        fluent API
      • getNiceUrl

        public String getNiceUrl()
        Nice URL of the page
        Returns:
        Nice URL
      • setNiceUrl

        public PageCreateRequest setNiceUrl​(String niceUrl)
        Set the nice URL
        Parameters:
        niceUrl - nice URL
        Returns:
        fluent API
      • getAlternateUrls

        public SortedSet<String> getAlternateUrls()
        Alternate URLs (in alphabetical order)
        Returns:
        sorted alternate URLs
      • setAlternateUrls

        public PageCreateRequest setAlternateUrls​(SortedSet<String> alternateUrls)
        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

        public PageCreateRequest setForceExtension​(boolean forceExtension)
        Set whether the
        Parameters:
        forceExtension -
        Returns:
        fluent API
      • getDescription

        public String getDescription()
        Description of the page
        Returns:
        the description of the new page
      • setDescription

        public PageCreateRequest setDescription​(String description)
        Set the description of the page
        Parameters:
        description -
        Returns:
        fluent API
      • getPriority

        public Integer getPriority()
        Priority of the page
        Returns:
        the priority of the new page
      • setPriority

        public PageCreateRequest setPriority​(Integer priority)
        Set the priority of the page
        Parameters:
        priority - the page priotiry
        Returns:
        fluent API
      • getContentSetId

        public Integer getContentSetId()
        Contentset ID of the page
        Returns:
        the contentset id of the new page
      • setContentSetId

        public PageCreateRequest setContentSetId​(Integer contentSetId)
        Set the contentSetId of the page
        Parameters:
        contentSetId -
        Returns:
        fluent API
      • getFailOnDuplicate

        public Boolean 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

        public PageCreateRequest setFailOnDuplicate​(Boolean failOnDuplicate)
        Set whether creating shall fail on duplicate names
        Parameters:
        failOnDuplicate - true to fail on duplicate names
        Returns:
        fluent API
      • getVariantChannelId

        public Integer 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

        public PageCreateRequest setVariantChannelId​(Integer variantChannelId)
        Set the source channel for the page to create
        Parameters:
        variantChannelId -
        Returns:
        fluent API