001 /** 002 * Copyright (c) 2000-present Liferay, Inc. All rights reserved. 003 * 004 * This library is free software; you can redistribute it and/or modify it under 005 * the terms of the GNU Lesser General Public License as published by the Free 006 * Software Foundation; either version 2.1 of the License, or (at your option) 007 * any later version. 008 * 009 * This library is distributed in the hope that it will be useful, but WITHOUT 010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 011 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 012 * details. 013 */ 014 015 package com.liferay.portal.kernel.model; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.annotation.ImplementationClassName; 020 import com.liferay.portal.kernel.util.Accessor; 021 022 /** 023 * 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. 024 * 025 * @author Brian Wing Shun Chan 026 * @see LayoutSetModel 027 * @see com.liferay.portal.model.impl.LayoutSetImpl 028 * @see com.liferay.portal.model.impl.LayoutSetModelImpl 029 * @generated 030 */ 031 @ImplementationClassName("com.liferay.portal.model.impl.LayoutSetImpl") 032 @ProviderType 033 public interface LayoutSet extends LayoutSetModel, PersistedModel { 034 /* 035 * NOTE FOR DEVELOPERS: 036 * 037 * Never modify this interface directly. Add methods to {@link com.liferay.portal.model.impl.LayoutSetImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 038 */ 039 public static final Accessor<LayoutSet, Long> LAYOUT_SET_ID_ACCESSOR = new Accessor<LayoutSet, Long>() { 040 @Override 041 public Long get(LayoutSet layoutSet) { 042 return layoutSet.getLayoutSetId(); 043 } 044 045 @Override 046 public Class<Long> getAttributeClass() { 047 return Long.class; 048 } 049 050 @Override 051 public Class<LayoutSet> getTypeClass() { 052 return LayoutSet.class; 053 } 054 }; 055 056 /** 057 * Returns the layout set's color scheme. 058 * 059 * <p> 060 * Just like themes, color schemes can be configured on the layout set 061 * level. The layout set's color scheme can be overridden on the layout 062 * level. 063 * </p> 064 * 065 * @return the layout set's color scheme 066 */ 067 public com.liferay.portal.kernel.model.ColorScheme getColorScheme(); 068 069 public java.lang.String getCompanyFallbackVirtualHostname(); 070 071 /** 072 * Returns the layout set's group. 073 * 074 * @return the layout set's group 075 */ 076 public com.liferay.portal.kernel.model.Group getGroup() 077 throws com.liferay.portal.kernel.exception.PortalException; 078 079 /** 080 * Returns the layout set prototype's ID, or <code>0</code> if it has no 081 * layout set prototype. 082 * 083 * <p> 084 * Prototype is Liferay's technical name for a site template. 085 * </p> 086 * 087 * @return the layout set prototype's ID, or <code>0</code> if it has no 088 layout set prototype 089 */ 090 public long getLayoutSetPrototypeId() 091 throws com.liferay.portal.kernel.exception.PortalException; 092 093 public long getLiveLogoId(); 094 095 public boolean getLogo(); 096 097 public com.liferay.portal.kernel.util.UnicodeProperties getSettingsProperties(); 098 099 public java.lang.String getSettingsProperty(java.lang.String key); 100 101 public com.liferay.portal.kernel.model.Theme getTheme(); 102 103 public java.lang.String getThemeSetting(java.lang.String key, 104 java.lang.String device); 105 106 /** 107 * Returns the name of the layout set's virtual host. 108 * 109 * <p> 110 * When accessing a layout set that has a the virtual host, the URL elements 111 * "/web/sitename" or "/group/sitename" can be omitted. 112 * </p> 113 * 114 * @return the layout set's virtual host name, or an empty string if the 115 layout set has no virtual host configured 116 */ 117 public java.lang.String getVirtualHostname(); 118 119 public boolean hasSetModifiedDate(); 120 121 public boolean isLayoutSetPrototypeLinkActive(); 122 123 public boolean isLogo(); 124 125 public void setCompanyFallbackVirtualHostname( 126 java.lang.String companyFallbackVirtualHostname); 127 128 public void setSettingsProperties( 129 com.liferay.portal.kernel.util.UnicodeProperties settingsProperties); 130 131 /** 132 * Sets the name of the layout set's virtual host. 133 * 134 * @param virtualHostname the name of the layout set's virtual host 135 * @see #getVirtualHostname() 136 */ 137 public void setVirtualHostname(java.lang.String virtualHostname); 138 }