Interface Website

    • Method Detail

      • getId

        @ReferField(indexed=true)
        int getId()
        Description copied from interface: Wrapper
        Returns the ID of the wrapped object.
        Specified by:
        getId in interface Wrapper
        Returns:
        the ID of the wrapped object.
      • getPagePart

        PagePart getPagePart​(String name)
        Get pagepart by name.
        Parameters:
        name -
        Returns:
        pagepart.
      • getPageModels

        @Deprecated
        nl.gx.webmanager.cms.pagemodel.PageModel[] getPageModels()
        Deprecated.
        Returns an array of all page models of this website.
        Returns:
        an array of all page models of this website
      • getIdentifier

        String getIdentifier()
        Returns the identifier of the Website. This identifier is meant to be unique among Website objects, and invariant across WM installations. The identifier string (which is specified in the "value" declaration of the wm_webinitiatif objecttype), should be of the following form (java.util.regex.Pattern): [a-zA-Z](\\w|[ -_])*
        Returns:
        the identifier of this website, or null if the website has no (or an invalid) identifier
      • getSiteWidePages

        Page[] getSiteWidePages()
        Return all sitewidepages.
        Returns:
        all sitewidepages.
      • getOrphanPages

        Page[] getOrphanPages()
        Return all orphan pages.
        Returns:
        all orphan pages.
      • getHomePage

        Page getHomePage()
        Return homepage.
        Returns:
        homepage.
      • getPageSectionPreviewPage

        Page getPageSectionPreviewPage()
        Return page at which the page section will be opened (be default) in the "in context" mode. Note that the names "block" and "page section" both refer to the same concept.
        Returns:
        page for page section editing.
      • getSiteMapPage

        Page getSiteMapPage()
        Return page with sitemap.
        Returns:
        page with sitemap.
      • getSearchResultPage

        Page getSearchResultPage()
        Return search result page.
        Returns:
        search result page.
      • getDefaultMediaPage

        Page getDefaultMediaPage()
        Return default media page.
        Returns:
        default media page.
      • getDisplayOnPages

        Page[] getDisplayOnPages​(String contentType)
        Return the display-on pages for a given content type.
        Parameters:
        contentType - The content type to get display-on pages for.
        Returns:
        the display-on pages for the given content type.
      • getDisplayOnPages

        Map<String,​Page[]> getDisplayOnPages()
        Return the display-on pages for all content types. This is a convenience method for use in JSP file, such that you can obtain the display-on pages with a statement like ${website.displayOnPages.myContentType}. When programming in Java, use getDisplayOnPages(String) for efficiency.
        Returns:
        a mapping from content type to an array of display-on pages.
      • getWhoIsWhoSearchPage

        @Deprecated
        Page getWhoIsWhoSearchPage()
        Deprecated.
        who-is-who functionality has been removed
        Return default who-is-who search page.
        Returns:
        default who-is-who search page.
      • getRootBlock

        Page getRootBlock()
        Returns the root page section of this website. All page sections of this website are stored under this root page section. Note that the names "block" and "page section" both refer to the same concept.
        Returns:
        the root page section of this website. Cannot be null.
      • getRootPageSection

        @Deprecated
        Page getRootPageSection()
        Deprecated.
        wrong naming, use getRootBlock() instead.
        Returns the root page section of this website under which all other page sections of this website are stored.
        Returns:
        the root page section of this website under which all other page sections of this website are stored
      • getBaseLevelPages

        Page[] getBaseLevelPages()
        Returns all sub pages of the homepage.
        Returns:
        all sub pages of the homepage.
      • getPortletPages

        Page[] getPortletPages()
        Returns portlet pages.
        Returns:
        portlet pages.
      • getRssFeedPages

        Page[] getRssFeedPages()
        Returns Rss Feed pages.
        Returns:
        Rss Feed pages.
      • getErrorPage

        Page getErrorPage()
        Returns default error page.
        Returns:
        default error page.
      • getLoginPage

        Page getLoginPage()
        Returns default login page.
        Returns:
        default login page.
      • isWebItemAvailable

        boolean isWebItemAvailable​(String webItemValue)
        Returns if webitem is available.
        Returns:
        boolean.
      • getWebAdminDataSource

        DataSource getWebAdminDataSource()
        Returns database for webadmin.
        Returns:
        database for webadmin.
      • getSearchResultReplacements

        String[] getSearchResultReplacements()
        Returns replacements for the url of the searchresult.
        Returns:
        replacements for the url of the searchresult
      • getHostName

        String getHostName()
        Returns frontend hostname.
        Returns:
        frontend hostname. The name may end with a colon and the port number if the port number is not 80/443.
      • getHostName

        String getHostName​(boolean includePortNr)
        Returns the frontend hostname, with or without the port number as specified.
        Parameters:
        includePortNr - If true, the port number is added to the hostname unless it is equal to 80 or 443. If false, the port number will not be added to the hostname, even when it is not 80/443.
        Returns:
        frontend hostname, with or without the port number as specified
        Since:
        10.31.0
      • getHostName

        String getHostName​(boolean includePortNr,
                           boolean includeProtocol)
        Parameters:
        includePortNr - If true, the port number is added to the hostname unless it is equal to 80 or 443. If false, the port number will not be added to the hostname, even when it is not 80/443.
        includeProtocol - If true, the protocol is attached to the host. If the frontend_use_https setting is enabled in the web/setup https will be used. Otherwise it will be http.
        Returns:
        frontend hostname, optionally including the protocol and the port depending on the provided parameters
        Since:
        10.32.0
      • getSecureHostName

        String getSecureHostName()
        Returns secure frontend hostname.
        Returns:
        secure frontend hostname. The name may end with a colon and the https port number if the port number is not 443.
      • getMediaRepository

        MediaRepository getMediaRepository()
        Returns the mediarepository for this site.
        Returns:
        the mediarepository.
      • getPresentation

        Presentation getPresentation​(String presentationName)
        Returns presentation by name.
        Parameters:
        presentationName -
        Returns:
        a Presentation object or null if there is no such presentation in this website.
      • getPresentationVariant

        PresentationVariant getPresentationVariant​(String presentationName,
                                                   String variantName)
        Returns the presentation variant by name of the presentation and the variant.
        Parameters:
        presentationName - Name of the presentation to which the variant belongs
        variantName - Name of the variant (without prefix of the presentation)
        Returns:
        a PresentationVariant object or null if there is no such presentation variant in this website.
      • getPresentationVariant

        PresentationVariant getPresentationVariant​(String variantName)
        Returns the presentation variant by name, looped over all presentations of the website.
        Parameters:
        variantName - Name of the variant (without prefix of the presentation)
        Returns:
        a PresentationVariant object or null if there is no such presentation variant in this website.
      • getAllPresentationVariants

        List<PresentationVariant> getAllPresentationVariants()
        Returns a list of all presentation variants that are created for every presentation and every scope.
        Returns:
        a list with all presentation variant objects.
      • getPresentation

        Presentation getPresentation​(String presentationName,
                                     String scope)
        Returns presentation by name, if it matches the scope.
        Parameters:
        presentationName -
        scope -
        Returns:
        the presentation or null.
      • getEmptyImage

        String getEmptyImage()
        Returns URL to e.gif.
        Returns:
        URL to e.gif
      • getStaticFilesUrl

        String getStaticFilesUrl()
        Returns URL to the static files.
        Returns:
        URL to the static files.
      • isAuthorized

        boolean isAuthorized()
        Return whether the user is authorized.
        Returns:
        true if the user is authorized.
      • getWwwRoot

        String getWwwRoot()
        Returns directory location of the webroot.
        Returns:
        directory location of the webroot.
      • getControllerAlias

        String getControllerAlias()
        Returns the controller alias of the host. For example, /web/show.
        Returns:
        controller alias of the host
      • getStatisticsUrl

        String getStatisticsUrl()
        Returns sitestat url.
        Returns:
        sitestat url
      • getBackEndAlias

        String getBackEndAlias()
        Returns backend alias. For example, /web/webmanager.
        Returns:
        backend alias.
      • getEditLoginUrl

        String getEditLoginUrl()
        Returns url to the login page for this website.
        Returns:
        url to the login page for this website.
      • getMailings

        Mailing[] getMailings()
        Returns mailings in this website.
        Returns:
        mailings.
      • getMailingLists

        MailingList[] getMailingLists()
        Returns mailinglists in this website.
        Returns:
        mailinglists.
      • getBlocks

        Page[] getBlocks()
        Returns page sections. Note that the names "block" and "page section" both refer to the same concept.
        Returns:
        page sections.
      • getForums

        Forum[] getForums()
        Returns forums.
        Returns:
        forums.
      • getDiscussionConfigurations

        DiscussionConfiguration[] getDiscussionConfigurations()
        Returns the discussion configurations.
        Returns:
        the discussion configurations
      • getPresentations

        Presentation[] getPresentations()
        Returns presentations.
        Returns:
        presentations.
      • getPresentationsByScope

        Presentation[] getPresentationsByScope​(String scope)
        Returns presentations for a certain scope, eg TextElement.
        Returns:
        presentations for a certain scope.
      • getQueries

        Query[] getQueries()
        Returns queries.
        Returns:
        queries.
      • getResourceEntities

        ResourceEntity[] getResourceEntities()
        Returns resources.
        Returns:
        resources.
      • getLanguages

        Language[] getLanguages()
        Returns all languages for the Website in priority order with the highest priority first.
        Returns:
        languages.
      • getLanguageById

        Language getLanguageById​(String langid)
        Retrieves a language by the String identifier of the language (i.e. 'dutch').
        Parameters:
        langid - Id of the language to retrieve. Preferably use the static String identifiers defined by this interface (i.e. Website.LANG_ENGLISH and Website. LANG_DUTCH)
        Returns:
        The language with the specified identifier
      • getLanguageById

        Language getLanguageById​(Integer langId)
        Retrieves a language by the numeric id of the language.
        Parameters:
        langId - numeric id of the language to retrieve
        Returns:
        The language with the specified numeric identifier
        Since:
        10.36.0
      • getLanguageByLocale

        Language getLanguageByLocale​(String locale)
        Retrieves a language by a locale string.
        Parameters:
        locale - the locale string representation of the language to retrieve like nl_NL or en_US
        Returns:
        the language with the specified locale
      • getWhoIsWhoClickableLists

        @Deprecated
        String[] getWhoIsWhoClickableLists()
        Deprecated.
        who-is-who functionality has been removed
        Returns values of clickable lists on who is who detail page.
        Returns:
        values of clickable lists on who is who detail page.
      • getWhoIsWhoUploadUrl

        @Deprecated
        String getWhoIsWhoUploadUrl()
        Deprecated.
        who-is-who functionality has been removed
        Returns relative location of who-is-who upload directory.
        Returns:
        relative location of who-is-who upload directory.
      • getPageParts

        PagePart[] getPageParts()
        Returns pageParts associated with this website.
        Returns:
        pageParts.
      • getSpecialPages

        Page[] getSpecialPages​(String label)
        Returns array of specialpages for a specfic label, eg confirmpage.
        Returns:
        array of specialpages for a specfic label.
      • isUsingBlockCaching

        boolean isUsingBlockCaching()
        Returns true if the block caching is used on the website. Note that the names "block" and "page section" both refer to the same concept.
        Returns:
        true if the block caching is used on the website.
      • isUseKeywordSearchEnabled

        boolean isUseKeywordSearchEnabled()
        Returns if keyword search is enabled or not.
        Returns:
        true if keyword search is enabled, false otherwise
      • getElementDeclarations

        @Deprecated
        String getElementDeclarations()
        Deprecated.
        Returns elementdeclarations for deleting or copying elements.
        Returns:
        String
      • handleSaveAction

        @Deprecated
        void handleSaveAction​(javax.servlet.http.HttpServletRequest request)
        Deprecated.
        call the handle_save_action for postprocessing requestvalues in siteworks.
        Parameters:
        request -
      • createSection

        @Deprecated
        int createSection​(int mastersectionid,
                          int languageid,
                          String pagetitle)
        Creates a new empty page version for a page identified by its siteworks object id in the given language and with the given title.
        Parameters:
        mastersectionid - Siteworks object id of the page to which the new empty page version should be assigned.
        languageid - Siteworks object id of the frontend language for the page version.
        pagetitle - Title for the page version.
        Returns:
        the Siteworks object id of the newly created page version.
      • getDatePickerUrl

        String getDatePickerUrl()
        Gets the Url for the datepicker.
        Returns:
        relative url for datepicker static files.
      • getFileUploadDirectory

        String getFileUploadDirectory()
        Returns the file upload directory for this Web Initiative and ensures that it always ends with a slash.
        Returns:
        The file upload directory for this Web Initiative ending with a slash
      • getFileUploadMultiMediaDirectory

        String getFileUploadMultiMediaDirectory()
        Returns the file upload directory for multimedia objects of this Web Initiative and ensures that it always ends with a slash.
        Returns:
        The file upload directory for multimedia objects of this Web Initiative ending with a slash
      • getFileUploadUrl

        String getFileUploadUrl()
        Returns the relative file upload URL for this Web Initiative and ensures that it always ends with a forward slash.
        Returns:
        The relative file upload URL for this Web Initiative ending with a forward slash
      • getFileUploadMultiMediaUrl

        String getFileUploadMultiMediaUrl()
        Returns the relative file upload URL for multimedia objects in this Web Initiative and ensures that it always ends with a forward slash.
        Returns:
        The relative file upload URL for for multimedia objects in this Web Initiative ending with a forward slash
      • getPersonalizationModels

        PersonalizationModel[] getPersonalizationModels()
        Returns all PersonalizationModel objects which may be used on this Website.
        Returns:
        All PersonalizationModel objects which may be used on this Website.
      • getPersonalizationExpressions

        PersonalizationExpression[] getPersonalizationExpressions()
        Returns all PersonalizationExpression objects which may be used on this Website.
        Returns:
        All PersonalizationExpression objects which may be used on this Website.
      • getPersonalizationExpressions

        PersonalizationExpression[] getPersonalizationExpressions​(PersonalizationExpression.Type type)
        Returns all PersonalizationExpression objects of the given type which may be used on this Website.
        Parameters:
        type - The type of PersonalizationExpression on which should be filtered.
        Returns:
        All PersonalizationExpression objects of the given type which may be used on this Website.
      • getPersonalizationItems

        PersonalizationItem[] getPersonalizationItems()
        Returns all personalization items sorted by name.
        Returns:
        All personalization items sorted by name.
      • getPersonalizationCategory

        PersonalizationCategory getPersonalizationCategory​(String value)
        Returns the personalization category with the given value.
        Parameters:
        value - Value of the personalization category, or an IllegalArgumentException is thrown if there is no personalization category with the given value.
        Returns:
        Personalization category with the give value.
      • getPersonalizationCategories

        PersonalizationCategory[] getPersonalizationCategories()
        Returns all personalization categories. If there are no personalization categories then an empty array is returned.
        Returns:
        Array of personalization categories.
      • isLanguageSwitchEnabled

        boolean isLanguageSwitchEnabled()
        Returns whether language switching is enabled for the web initiative.
        Returns:
        true if the option "Publish pages in multiple languages" in the web initiative configuration is turned on
      • getLinkModels

        LinkModel[] getLinkModels()
        Returns all link models. If there are no link models then an empty array is returned.
        Returns:
        Array of link models.
      • getFrontendHostname

        String getFrontendHostname()
        Returns the frontend hostname of this website.
        Returns:
        the frontend hostname.
      • getBackendHostname

        String getBackendHostname()
        Returns the backend hostname of this website.
        Returns:
        the backend hostname.
      • getFrontendAliases

        String[] getFrontendAliases()
        Returns the frontend hostname aliases of this website.
        Returns:
        the frontend hostname aliases.
      • getBackendAliases

        String[] getBackendAliases()
        Returns the backend hostname aliases of this website.
        Returns:
        the backend hostname aliases.
      • isFallbackLanguageEnabled

        boolean isFallbackLanguageEnabled()
        Returns whether fall-back to another language is enabled.
        Returns:
        true if language fall-back is enabled, false otherwise.
      • getEditLanguages

        EditLanguage[] getEditLanguages()
        Returns the languages used in the edit environment for this Website.
        Returns:
        the backend languages
      • getDefaultEditLanguage

        EditLanguage getDefaultEditLanguage()
        Returns the default EditLanguage for this website. Is typically used to provide a default edit language for a user if he doesn't have one yet.
        Returns:
        the default EditLanguage for this website
      • getDefaultContentLanguage

        Language getDefaultContentLanguage()
        Returns the default content Language for this website. The default content language is the language selected as first language in the list of languages managed in the Language Labels panel. The default content language is typically used to provide a default language for CRUD operations on content if a language is not provided by any other means. For example: if the default content language is Dutch, a new page is created using the Java API and no target language was provided for that page, the page will be created in Dutch.
        Returns:
        the default Language for CRUD operations on content for website
        Since:
        10.31.0
      • getOEmbedPage

        Page getOEmbedPage()
        Returns oEmbed page.
        Returns:
        oEmbed page
      • getAllowedWebsites

        List<Website> getAllowedWebsites​(ContentItem<?> contentItem)
        Returns all websites which are allowed to access specified content item. A website can access a content item if it owns the item, or if the item is shared by another website.
        Parameters:
        contentItem -
      • isAllowedToLinkToOtherWebsites

        boolean isAllowedToLinkToOtherWebsites()
        Returns whether links to other websites are allowed.
        Returns:
        true when links to other websites are allowed, false otherwise.
      • getStylingOptions

        List<StylingOption> getStylingOptions()
        Returns the styling options that can be selected in the Inline Editor
        Returns:
        styling options defined for this website
        Since:
        10.30.0