com.liferay.portal.kernel.model.LayoutSet.java Source code

Introduction

Here is the source code for com.liferay.portal.kernel.model.LayoutSet.java

Source

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.portal.kernel.model;

import com.liferay.portal.kernel.annotation.ImplementationClassName;
import com.liferay.portal.kernel.util.Accessor;

import org.osgi.annotation.versioning.ProviderType;

/**
 * The extended model interface for the LayoutSet service. Represents a row in the "LayoutSet" database table, with each column mapped to a property of this class.
 *
 * @author Brian Wing Shun Chan
 * @see LayoutSetModel
 * @generated
 */
@ImplementationClassName("com.liferay.portal.model.impl.LayoutSetImpl")
@ProviderType
public interface LayoutSet extends LayoutSetModel, PersistedModel {

    /**
     * NOTE FOR DEVELOPERS:
     *
     * Never modify this interface directly. Add methods to <code>com.liferay.portal.model.impl.LayoutSetImpl</code> and rerun ServiceBuilder to automatically copy the method declarations to this interface.
     */
    public static final Accessor<LayoutSet, Long> LAYOUT_SET_ID_ACCESSOR = new Accessor<LayoutSet, Long>() {

        @Override
        public Long get(LayoutSet layoutSet) {
            return layoutSet.getLayoutSetId();
        }

        @Override
        public Class<Long> getAttributeClass() {
            return Long.class;
        }

        @Override
        public Class<LayoutSet> getTypeClass() {
            return LayoutSet.class;
        }

    };

    /**
     * Returns the layout set's color scheme.
     *
     * <p>
     * Just like themes, color schemes can be configured on the layout set
     * level. The layout set's color scheme can be overridden on the layout
     * level.
     * </p>
     *
     * @return the layout set's color scheme
     */
    public ColorScheme getColorScheme();

    public String getCompanyFallbackVirtualHostname();

    /**
     * Returns the layout set's group.
     *
     * @return the layout set's group
     */
    public Group getGroup() throws com.liferay.portal.kernel.exception.PortalException;

    /**
     * Returns the layout set prototype's ID, or <code>0</code> if it has no
     * layout set prototype.
     *
     * <p>
     * Prototype is Liferay's technical name for a site template.
     * </p>
     *
     * @return the layout set prototype's ID, or <code>0</code> if it has no
     layout set prototype
     */
    public long getLayoutSetPrototypeId() throws com.liferay.portal.kernel.exception.PortalException;

    public long getLiveLogoId();

    public boolean getLogo();

    public int getPageCount();

    public com.liferay.portal.kernel.util.UnicodeProperties getSettingsProperties();

    public String getSettingsProperty(String key);

    public Theme getTheme();

    public String getThemeSetting(String key, String device);

    /**
     * Returns the name of the layout set's default virtual host.
     *
     * <p>
     * When accessing a layout set that has a the virtual host, the URL elements
     * "/web/sitename" or "/group/sitename" can be omitted.
     * </p>
     *
     * @return the layout set's default virtual host name, or an empty string if
     the layout set has no virtual hosts configured
     * @deprecated As of Mueller (7.2.x), replaced by {@link
     #getVirtualHostnames()}
     */
    @Deprecated
    public String getVirtualHostname();

    /**
     * Returns the names of the layout set's virtual hosts.
     *
     * <p>
     * When accessing a layout set that has a the virtual host, the URL elements
     * "/web/sitename" or "/group/sitename" can be omitted.
     * </p>
     *
     * @return the layout set's virtual host names, or an empty string if
     the layout set has no virtual hosts configured
     */
    public java.util.TreeMap<String, String> getVirtualHostnames();

    public boolean hasSetModifiedDate();

    public boolean isLayoutSetPrototypeLinkActive();

    public boolean isLogo();

    public void setCompanyFallbackVirtualHostname(String companyFallbackVirtualHostname);

    public void setSettingsProperties(com.liferay.portal.kernel.util.UnicodeProperties settingsProperties);

    /**
     * Sets the name of the layout set's virtual host.
     *
     * @param virtualHostname the name of the layout set's virtual host
     * @see #getVirtualHostname()
     * @deprecated As of Mueller (7.2.x), replaced by {@link
     #setVirtualHostnames(TreeMap)}
     */
    @Deprecated
    public void setVirtualHostname(String virtualHostname);

    /**
     * Sets the names of the layout set's virtual host name and language IDs.
     *
     * @param virtualHostnames the map of the layout set's virtual host name and
     language IDs
     * @see #getVirtualHostnames()
     */
    public void setVirtualHostnames(java.util.TreeMap virtualHostnames);

}