nl.gx.webmanager.cms.core
Interface Website

All Superinterfaces:

Presentable, Wrapper

public interface Website
extends Presentable

Representation of website.

Method Summary

int	createSection(int mastersectionid, int languageid, java.lang.String pagetitle) Deprecated. Use PageManagementService.createPageVersion(Page, Language) instead.
Application[]	getApplications() Return applications in this website.
java.lang.String	getBackEndAlias() Return backend alias.
Page[]	getBaseLevelPages() Return all sub pages of the homepage.
Page[]	getBlocks() Return blocks.
java.lang.String	getControllerAlias() Return the controller alias of the host.
java.lang.String	getDatePickerUrl() Gets the Url for the datepicker.
Page	getDefaultMediaPage() Return default media page.
Page	getDigitalCounterOrderPage() Return a page with a form for ordering products.
java.util.Map<java.lang.String,Page[]>	getDisplayOnPages() Return the display-on pages for all content types.
Page[]	getDisplayOnPages(java.lang.String contentType) Return the display-on pages for a given content type.
Page	getEcardpage() Return the ecard page.
Ecard[]	getEcards() Return array of all ecards.
java.lang.String	getEditLoginUrl() Return url to the login page for this website.
java.lang.String	getElementDeclarations() Return elementdeclarations for deleting or copying elements.
java.lang.String	getEmptyImage() Return url to e.gif.
Page	getErrorPage() Return default error page.
java.lang.String	getFileUploadDirectory() Returns the file upload directory for this Web Initiative and ensures that it always ends with a slash.
java.lang.String	getFileUploadMultiMediaDirectory() Returns the file upload directory for multimedia objects of this Web Initiative and ensures that it always ends with a slash.
java.lang.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.
java.lang.String	getFileUploadUrl() Returns the relative file upload URL for this Web Initiative and ensures that it always ends with a forward slash.
Form[]	getForms() Return forms defined in this website.
Forum[]	getForums() Return forums.
GovernmentRegistry	getGovernmentRegistry() Returns the government specific settings for this website.
Page	getHomePage() Return homepage.
java.lang.String	getHostName() Return frontend hostname.
java.lang.String	getIdentifier() Returns the identifier of the Website.
Language	getLanguageById(java.lang.String langid) Retrieves a language by the language id.
Language[]	getLanguages() Return languages.
LinkModel[]	getLinkModels() Returns all link models.
Page	getLoginPage() Return default login page.
MailingList[]	getMailingLists() Return mailinglists in this website.
Mailing[]	getMailings() Return mailings in this website.
MediaRepository	getMediaRepository() Return the mediarepository for this site.
Page[]	getOrphanPages() Return all orphan pages.
PageModel[]	getPageModels() Returns an array of all page models of this website.
PagePart	getPagePart(java.lang.String name) Get pagepart by name.
PagePart[]	getPageParts() Return pageParts associated with this website.
PersonalizationCategory[]	getPersonalizationCategories() Returns all personalization categories.
PersonalizationCategory	getPersonalizationCategory(java.lang.String value) Returns the personalization category with the given value.
PersonalizationExpression[]	getPersonalizationExpressions() Returns all PersonalizationExpression objects which may be used on this Website.
PersonalizationExpression[]	getPersonalizationExpressions(PersonalizationExpression.Type type) Returns all PersonalizationExpression objects of the given type which may be used on this Website.
PersonalizationItem[]	getPersonalizationItems() Returns all personalization items.
PersonalizationModel[]	getPersonalizationModels() Returns all PersonalizationModel objects which may be used on this Website.
Personalization[]	getPersonalizations() Return personalizations.
Page[]	getPortletPages() Return portlet pages.
Presentation	getPresentation(java.lang.String presentationName) Get presentation by name.
Presentation	getPresentation(java.lang.String presentationName, java.lang.String scope) Get presention by name, if it matches the scope.
Presentation[]	getPresentations() Return presentations.
Presentation[]	getPresentationsByScope(java.lang.String scope) Return presentations for a certain scope, eg TextElement.
java.lang.String	getProductCatalogUploadUrl() Return relative location of productcatalog upload directory.
Query[]	getQueries() Return queries.
ResourceEntity[]	getResourceEntities() Return resources.
Resource[]	getResources() Return resources.
Page	getRootBlock() Returns the root block of this website.
Page	getRootPageSection() Deprecated. wrong naming, use getRootBlock() instead.
Page[]	getRssFeedPages() Return Rss Feed pages.
Page	getSearchResultPage() Return search result page.
java.lang.String[]	getSearchResultReplacements() Return replacements for the url of the searchresult.
java.lang.String	getSecureHostName() Return secure frontend hostname.
Page	getSiteMapPage() Return page with sitemap.
Page[]	getSiteWidePages() Return all sitewidepages.
Page[]	getSpecialPages(java.lang.String label) Return array of specialpages for a specfic label, eg confirmpage.
java.lang.String	getStaticFilesUrl() Return url to the static files.
java.lang.String	getStatisticsUrl() Return sitestat url.
java.lang.String	getTitle() Return website title.
javax.sql.DataSource	getWebAdminDataSource() Return database for webadmin.
java.lang.String[]	getWhoIsWhoClickableLists() Return values of clickable lists on who is who detail page.
Page	getWhoIsWhoSearchPage() Return default who-is-who search page.
java.lang.String	getWhoIsWhoUploadUrl() Return relative location of who-is-who upload directory.
java.lang.String	getWwwRoot() Return directory location of the webroot.
void	handleSaveAction(javax.servlet.http.HttpServletRequest request) call the handle_save_action for postprocessing requestvalues in siteworks.
boolean	hasRisDocuments() Returns true if the RIS documents module is used on the website.
boolean	isAuthorized() Return true if the user is authorized.
boolean	isLanguageSwitchEnabled() Returns whether language switching is enabled for the web initiative.
boolean	isUseKeywordSearchEnabled() Returns if keyword search is enabled or not.
boolean	isUsingBlockCaching() Returns true if the block caching is used on the website.
boolean	isWebItemAvailable(java.lang.String webItemValue) Return if webitem is available.

Methods inherited from interface nl.gx.webmanager.cms.core.Presentable

getPresentation, render, render, setPresentation

Methods inherited from interface nl.gx.webmanager.wrapper.Wrapper

getId, getUUID, setId, setUUID

Method Detail

getPagePart

PagePart getPagePart(java.lang.String name)

Get pagepart by name.

Parameters:

name -

Returns:

pagepart.

getPageModels

PageModel[] getPageModels()

Returns an array of all page models of this website.

Returns:

an array of all page models of this website

getTitle

java.lang.String getTitle()

Return website title.

Returns:

website title.

getIdentifier

java.lang.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.

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(java.lang.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

java.util.Map<java.lang.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.

getDigitalCounterOrderPage

Page getDigitalCounterOrderPage()

Return a page with a form for ordering products.

Returns:

orderpage.

getEcardpage

Page getEcardpage()

Return the ecard page. This is the page which will used as base for the view ecard URL that is send by e-mail. Be sure it contains an ecard element!

Returns:

the default ecard page as set in sitewide pages, or null if it was not defined

getWhoIsWhoSearchPage

Page getWhoIsWhoSearchPage()

Return default who-is-who search page.

Returns:

default who-is-who search page.

getRootBlock

Page getRootBlock()

Returns the root block of this website. All blocks of this website are stored under this root block.

Returns:

the root block 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()

Return all sub pages of the homepage.

Returns:

all sub pages of the homepage.

getPortletPages

Page[] getPortletPages()

Return portlet pages.

Returns:

portlet pages.

getRssFeedPages

Page[] getRssFeedPages()

Return Rss Feed pages.

Returns:

Rss Feed pages.

getErrorPage

Page getErrorPage()

Return default error page.

Returns:

default error page.

getLoginPage

Page getLoginPage()

Return default login page.

Returns:

default login page.

isWebItemAvailable

boolean isWebItemAvailable(java.lang.String webItemValue)

Return if webitem is available.

Returns:

boolean.

getWebAdminDataSource

javax.sql.DataSource getWebAdminDataSource()

Return database for webadmin.

Returns:

database for webadmin.

getSearchResultReplacements

java.lang.String[] getSearchResultReplacements()

Return replacements for the url of the searchresult.

Returns:

replacements for the url of the searchresult

getHostName

java.lang.String getHostName()

Return frontend hostname.

Returns:

frontend hostname. The name may end with a colon and the port number if the port number is not 80.

getSecureHostName

java.lang.String getSecureHostName()

Return 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()

Return the mediarepository for this site.

Returns:

the mediarepository.

getPresentation

Presentation getPresentation(java.lang.String presentationName)

Get presentation by name.

Parameters:

presentationName -

Returns:

a Presentation object or null if there is no such presentation in this website.

getPresentation

Presentation getPresentation(java.lang.String presentationName,
                             java.lang.String scope)

Get presention by name, if it matches the scope.

Parameters:

presentationName -

scope -

Returns:

the presentation or null.

getEmptyImage

java.lang.String getEmptyImage()

Return url to e.gif.

Returns:

url to e.gif

getStaticFilesUrl

java.lang.String getStaticFilesUrl()

Return url to the static files.

Returns:

url to the static files.

isAuthorized

boolean isAuthorized()

Return true if the user is authorized.

Returns:

true if the user is authorized.

getWwwRoot

java.lang.String getWwwRoot()

Return directory location of the webroot.

Returns:

directory location of the webroot.

getControllerAlias

java.lang.String getControllerAlias()

Return the controller alias of the host. For example, /web/show.

Returns:

controller alias of the host

getStatisticsUrl

java.lang.String getStatisticsUrl()

Return sitestat url.

Returns:

sitestat url

getBackEndAlias

java.lang.String getBackEndAlias()

Return backend alias. For example, /web/webmanager.

Returns:

backend alias.

getEditLoginUrl

java.lang.String getEditLoginUrl()

Return url to the login page for this website.

Returns:

url to the login page for this website.

getMailings

Mailing[] getMailings()

Return mailings in this website.

Returns:

mailings.

getForms

Form[] getForms()

Return forms defined in this website.

Returns:

forms.

getMailingLists

MailingList[] getMailingLists()

Return mailinglists in this website.

Returns:

mailinglists.

getApplications

Application[] getApplications()

Return applications in this website.

Returns:

applications.

getBlocks

Page[] getBlocks()

Return blocks.

Returns:

blocks.

getForums

Forum[] getForums()

Return forums.

Returns:

forums.

getPersonalizations

Personalization[] getPersonalizations()

Return personalizations.

Returns:

personalizations.

getPresentations

Presentation[] getPresentations()

Return presentations.

Returns:

presentations.

getPresentationsByScope

Presentation[] getPresentationsByScope(java.lang.String scope)

Return presentations for a certain scope, eg TextElement.

Returns:

presentations for a certain scope.

getQueries

Query[] getQueries()

Return queries.

Returns:

queries.

getResources

Resource[] getResources()

Return resources.

Returns:

resources.

getResourceEntities

ResourceEntity[] getResourceEntities()

Return resources.

Returns:

resources.

getLanguages

Language[] getLanguages()

Return languages.

Returns:

languages.

getLanguageById

Language getLanguageById(java.lang.String langid)

Retrieves a language by the language id.

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 ID

getWhoIsWhoClickableLists

java.lang.String[] getWhoIsWhoClickableLists()

Return values of clickable lists on who is who detail page.

Returns:

values of clickable lists on who is who detail page.

getWhoIsWhoUploadUrl

java.lang.String getWhoIsWhoUploadUrl()

Return relative location of who-is-who upload directory.

Returns:

relative location of who-is-who upload directory.

getProductCatalogUploadUrl

java.lang.String getProductCatalogUploadUrl()

Return relative location of productcatalog upload directory.

Returns:

relative location of productcatalog upload directory.

hasRisDocuments

boolean hasRisDocuments()

Returns true if the RIS documents module is used on the website.

Returns:

true if the RIS documents module is used on the website.

getPageParts

PagePart[] getPageParts()

Return pageParts associated with this website.

Returns:

pageParts.

getSpecialPages

Page[] getSpecialPages(java.lang.String label)

Return array of specialpages for a specfic label, eg confirmpage.

Returns:

array of specialpages for a specfic label.

getEcards

Ecard[] getEcards()

Return array of all ecards.

Returns:

array of all ecards.

isUsingBlockCaching

boolean isUsingBlockCaching()

Returns true if the block caching is used on the website.

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

java.lang.String getElementDeclarations()

Return elementdeclarations for deleting or copying elements.

Returns:

String

handleSaveAction

void handleSaveAction(javax.servlet.http.HttpServletRequest request)

call the handle_save_action for postprocessing requestvalues in siteworks.

Parameters:

request -

createSection

@Deprecated
int createSection(int mastersectionid,
                             int languageid,
                             java.lang.String pagetitle)

Deprecated. Use PageManagementService.createPageVersion(Page, Language) instead.

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

java.lang.String getDatePickerUrl()

Gets the Url for the datepicker.

Returns:

relative url for datepicker static files.

getFileUploadDirectory

java.lang.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

java.lang.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

java.lang.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

java.lang.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

getGovernmentRegistry

GovernmentRegistry getGovernmentRegistry()

Returns the government specific settings for this website.

Returns:

the government specific settings for this website

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.

Returns:

All personalization items.

getPersonalizationCategory

PersonalizationCategory getPersonalizationCategory(java.lang.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.

Since:

9.12.0