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.model; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.util.Accessor; 020 021 /** 022 * 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. 023 * 024 * @author Brian Wing Shun Chan 025 * @see LayoutSetModel 026 * @see com.liferay.portal.model.impl.LayoutSetImpl 027 * @see com.liferay.portal.model.impl.LayoutSetModelImpl 028 * @generated 029 */ 030 @ProviderType 031 public interface LayoutSet extends LayoutSetModel, PersistedModel { 032 /* 033 * NOTE FOR DEVELOPERS: 034 * 035 * 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. 036 */ 037 public static final Accessor<LayoutSet, Long> LAYOUT_SET_ID_ACCESSOR = new Accessor<LayoutSet, Long>() { 038 @Override 039 public Long get(LayoutSet layoutSet) { 040 return layoutSet.getLayoutSetId(); 041 } 042 043 @Override 044 public Class<Long> getAttributeClass() { 045 return Long.class; 046 } 047 048 @Override 049 public Class<LayoutSet> getTypeClass() { 050 return LayoutSet.class; 051 } 052 }; 053 054 /** 055 * Returns the layout set's color scheme. 056 * 057 * <p> 058 * Just like themes, color schemes can be configured on the layout set 059 * level. The layout set's color scheme can be overridden on the layout 060 * level. 061 * </p> 062 * 063 * @return the layout set's color scheme 064 */ 065 public com.liferay.portal.model.ColorScheme getColorScheme(); 066 067 public java.lang.String getCompanyFallbackVirtualHostname(); 068 069 /** 070 * Returns the layout set's group. 071 * 072 * @return the layout set's group 073 * @throws PortalException if a group with the primary key could not be 074 found 075 */ 076 public com.liferay.portal.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 * @throws PortalException if a matching layout set prototype could not be 090 found 091 */ 092 public long getLayoutSetPrototypeId() 093 throws com.liferay.portal.kernel.exception.PortalException; 094 095 public long getLiveLogoId(); 096 097 public boolean getLogo(); 098 099 public com.liferay.portal.kernel.util.UnicodeProperties getSettingsProperties(); 100 101 public java.lang.String getSettingsProperty(java.lang.String key); 102 103 public com.liferay.portal.model.Theme getTheme(); 104 105 public java.lang.String getThemeSetting(java.lang.String key, 106 java.lang.String device); 107 108 /** 109 * Returns the name of the layout set's virtual host. 110 * 111 * <p> 112 * When accessing a layout set that has a the virtual host, the URL elements 113 * "/web/sitename" or "/group/sitename" can be omitted. 114 * </p> 115 * 116 * @return the layout set's virtual host name, or an empty string if the 117 layout set has no virtual host configured 118 */ 119 public java.lang.String getVirtualHostname(); 120 121 public com.liferay.portal.model.ColorScheme getWapColorScheme(); 122 123 public com.liferay.portal.model.Theme getWapTheme(); 124 125 public boolean hasSetModifiedDate(); 126 127 public boolean isLayoutSetPrototypeLinkActive(); 128 129 public boolean isLogo(); 130 131 public void setCompanyFallbackVirtualHostname( 132 java.lang.String companyFallbackVirtualHostname); 133 134 public void setSettingsProperties( 135 com.liferay.portal.kernel.util.UnicodeProperties settingsProperties); 136 137 /** 138 * Sets the name of the layout set's virtual host. 139 * 140 * @param virtualHostname the name of the layout set's virtual host 141 * @see #getVirtualHostname() 142 */ 143 public void setVirtualHostname(java.lang.String virtualHostname); 144 }