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