Package 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$ $Date$

    • Method Detail

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