001 /** 002 * Copyright (c) 2000-2013 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 com.liferay.portal.LocaleException; 018 import com.liferay.portal.kernel.bean.AutoEscape; 019 import com.liferay.portal.service.ServiceContext; 020 021 import com.liferay.portlet.expando.model.ExpandoBridge; 022 023 import java.io.Serializable; 024 025 import java.util.Locale; 026 import java.util.Map; 027 028 /** 029 * The base model interface for the LayoutPrototype service. Represents a row in the "LayoutPrototype" database table, with each column mapped to a property of this class. 030 * 031 * <p> 032 * This interface and its corresponding implementation {@link com.liferay.portal.model.impl.LayoutPrototypeModelImpl} exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in {@link com.liferay.portal.model.impl.LayoutPrototypeImpl}. 033 * </p> 034 * 035 * @author Brian Wing Shun Chan 036 * @see LayoutPrototype 037 * @see com.liferay.portal.model.impl.LayoutPrototypeImpl 038 * @see com.liferay.portal.model.impl.LayoutPrototypeModelImpl 039 * @generated 040 */ 041 public interface LayoutPrototypeModel extends BaseModel<LayoutPrototype> { 042 /* 043 * NOTE FOR DEVELOPERS: 044 * 045 * Never modify or reference this interface directly. All methods that expect a layout prototype model instance should use the {@link LayoutPrototype} interface instead. 046 */ 047 048 /** 049 * Returns the primary key of this layout prototype. 050 * 051 * @return the primary key of this layout prototype 052 */ 053 public long getPrimaryKey(); 054 055 /** 056 * Sets the primary key of this layout prototype. 057 * 058 * @param primaryKey the primary key of this layout prototype 059 */ 060 public void setPrimaryKey(long primaryKey); 061 062 /** 063 * Returns the uuid of this layout prototype. 064 * 065 * @return the uuid of this layout prototype 066 */ 067 @AutoEscape 068 public String getUuid(); 069 070 /** 071 * Sets the uuid of this layout prototype. 072 * 073 * @param uuid the uuid of this layout prototype 074 */ 075 public void setUuid(String uuid); 076 077 /** 078 * Returns the layout prototype ID of this layout prototype. 079 * 080 * @return the layout prototype ID of this layout prototype 081 */ 082 public long getLayoutPrototypeId(); 083 084 /** 085 * Sets the layout prototype ID of this layout prototype. 086 * 087 * @param layoutPrototypeId the layout prototype ID of this layout prototype 088 */ 089 public void setLayoutPrototypeId(long layoutPrototypeId); 090 091 /** 092 * Returns the company ID of this layout prototype. 093 * 094 * @return the company ID of this layout prototype 095 */ 096 public long getCompanyId(); 097 098 /** 099 * Sets the company ID of this layout prototype. 100 * 101 * @param companyId the company ID of this layout prototype 102 */ 103 public void setCompanyId(long companyId); 104 105 /** 106 * Returns the name of this layout prototype. 107 * 108 * @return the name of this layout prototype 109 */ 110 public String getName(); 111 112 /** 113 * Returns the localized name of this layout prototype in the language. Uses the default language if no localization exists for the requested language. 114 * 115 * @param locale the locale of the language 116 * @return the localized name of this layout prototype 117 */ 118 @AutoEscape 119 public String getName(Locale locale); 120 121 /** 122 * Returns the localized name of this layout prototype in the language, optionally using the default language if no localization exists for the requested language. 123 * 124 * @param locale the local of the language 125 * @param useDefault whether to use the default language if no localization exists for the requested language 126 * @return the localized name of this layout prototype. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned. 127 */ 128 @AutoEscape 129 public String getName(Locale locale, boolean useDefault); 130 131 /** 132 * Returns the localized name of this layout prototype in the language. Uses the default language if no localization exists for the requested language. 133 * 134 * @param languageId the ID of the language 135 * @return the localized name of this layout prototype 136 */ 137 @AutoEscape 138 public String getName(String languageId); 139 140 /** 141 * Returns the localized name of this layout prototype in the language, optionally using the default language if no localization exists for the requested language. 142 * 143 * @param languageId the ID of the language 144 * @param useDefault whether to use the default language if no localization exists for the requested language 145 * @return the localized name of this layout prototype 146 */ 147 @AutoEscape 148 public String getName(String languageId, boolean useDefault); 149 150 @AutoEscape 151 public String getNameCurrentLanguageId(); 152 153 @AutoEscape 154 public String getNameCurrentValue(); 155 156 /** 157 * Returns a map of the locales and localized names of this layout prototype. 158 * 159 * @return the locales and localized names of this layout prototype 160 */ 161 public Map<Locale, String> getNameMap(); 162 163 /** 164 * Sets the name of this layout prototype. 165 * 166 * @param name the name of this layout prototype 167 */ 168 public void setName(String name); 169 170 /** 171 * Sets the localized name of this layout prototype in the language. 172 * 173 * @param name the localized name of this layout prototype 174 * @param locale the locale of the language 175 */ 176 public void setName(String name, Locale locale); 177 178 /** 179 * Sets the localized name of this layout prototype in the language, and sets the default locale. 180 * 181 * @param name the localized name of this layout prototype 182 * @param locale the locale of the language 183 * @param defaultLocale the default locale 184 */ 185 public void setName(String name, Locale locale, Locale defaultLocale); 186 187 public void setNameCurrentLanguageId(String languageId); 188 189 /** 190 * Sets the localized names of this layout prototype from the map of locales and localized names. 191 * 192 * @param nameMap the locales and localized names of this layout prototype 193 */ 194 public void setNameMap(Map<Locale, String> nameMap); 195 196 /** 197 * Sets the localized names of this layout prototype from the map of locales and localized names, and sets the default locale. 198 * 199 * @param nameMap the locales and localized names of this layout prototype 200 * @param defaultLocale the default locale 201 */ 202 public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale); 203 204 /** 205 * Returns the description of this layout prototype. 206 * 207 * @return the description of this layout prototype 208 */ 209 @AutoEscape 210 public String getDescription(); 211 212 /** 213 * Sets the description of this layout prototype. 214 * 215 * @param description the description of this layout prototype 216 */ 217 public void setDescription(String description); 218 219 /** 220 * Returns the settings of this layout prototype. 221 * 222 * @return the settings of this layout prototype 223 */ 224 @AutoEscape 225 public String getSettings(); 226 227 /** 228 * Sets the settings of this layout prototype. 229 * 230 * @param settings the settings of this layout prototype 231 */ 232 public void setSettings(String settings); 233 234 /** 235 * Returns the active of this layout prototype. 236 * 237 * @return the active of this layout prototype 238 */ 239 public boolean getActive(); 240 241 /** 242 * Returns <code>true</code> if this layout prototype is active. 243 * 244 * @return <code>true</code> if this layout prototype is active; <code>false</code> otherwise 245 */ 246 public boolean isActive(); 247 248 /** 249 * Sets whether this layout prototype is active. 250 * 251 * @param active the active of this layout prototype 252 */ 253 public void setActive(boolean active); 254 255 public boolean isNew(); 256 257 public void setNew(boolean n); 258 259 public boolean isCachedModel(); 260 261 public void setCachedModel(boolean cachedModel); 262 263 public boolean isEscapedModel(); 264 265 public Serializable getPrimaryKeyObj(); 266 267 public void setPrimaryKeyObj(Serializable primaryKeyObj); 268 269 public ExpandoBridge getExpandoBridge(); 270 271 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 272 273 public void prepareLocalizedFieldsForImport(Locale defaultImportLocale) 274 throws LocaleException; 275 276 public Object clone(); 277 278 public int compareTo(LayoutPrototype layoutPrototype); 279 280 public int hashCode(); 281 282 public CacheModel<LayoutPrototype> toCacheModel(); 283 284 public LayoutPrototype toEscapedModel(); 285 286 public LayoutPrototype toUnescapedModel(); 287 288 public String toString(); 289 290 public String toXmlString(); 291 }