lumis.portal.website

Interface IWebsiteManagerSPI

All Superinterfaces:

IWebsiteManager

All Known Implementing Classes:

WebsiteManager

public interface IWebsiteManagerSPI
extends IWebsiteManager

Provides high-level operations on portal websites.

Since:

6.2.0

Version:

$Revision: 14187 $ $Date: 2012-04-02 14:44:41 +0000 (Mon, 02 Apr 2012) $

Method Summary

Modifier and Type	Method and Description
IWebsite	getDefaultWebsite() Returns the website flagged as the default website.
IWebsite	getWebsiteByChannelId(String channelId) Returns the website that the specific channel belongs to.
void	setDefaultWebsite(IWebsite website) Sets which website is the default website.

Methods inherited from interface lumis.portal.website.IWebsiteManager

getWebsiteBaseURL, getWebsiteBaseURL, getWebsiteBaseURLAsURI

Method Detail

getDefaultWebsite

IWebsite getDefaultWebsite()
                    throws PortalException

Returns the website flagged as the default website.

Returns:

the default website, or null if there is no website set as the default.

Throws:

PortalException

Since:

6.2.0

See Also:

IWebsite.isDefaultWebsite(), setDefaultWebsite(IWebsite)

setDefaultWebsite

void setDefaultWebsite(IWebsite website)
                throws PortalException

Sets which website is the default website.

If there is any website currently flagged as the default website, it will no longer be the default website. The given website (if any) will be set as the default website.

Parameters:

website - the website to be the default, or null for no website to be the default.

Throws:

AccessDeniedException - if the user does not have permission to change the default website.

PortalException

Since:

6.2.0

See Also:

IWebsite.isDefaultWebsite(), getDefaultWebsite()

getWebsiteByChannelId

IWebsite getWebsiteByChannelId(String channelId)
                        throws PortalException

Returns the website that the specific channel belongs to.

The specified channel and its ancestral are searched for the first channel that corresponds to a website root. The channel belongs to that website, and it is returned.

If neither the channel or its ancestral is a website root, then the channel does not belong to any website, and null is returned.

Parameters:

channelId - the channel identifier.

Returns:

the website the channel belongs to, or null if the channel does not belong to any website.

Throws:

PortalObjectNotFoundException - if the channel does not exist.

PortalException

Since:

6.2.0