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.kernel.exception.SystemException; 020 import com.liferay.portal.service.ServiceContext; 021 022 import com.liferay.portlet.expando.model.ExpandoBridge; 023 024 import java.io.Serializable; 025 026 import java.util.Date; 027 import java.util.Locale; 028 import java.util.Map; 029 030 /** 031 * 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. 032 * 033 * <p> 034 * 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}. 035 * </p> 036 * 037 * @author Brian Wing Shun Chan 038 * @see LayoutSetPrototype 039 * @see com.liferay.portal.model.impl.LayoutSetPrototypeImpl 040 * @see com.liferay.portal.model.impl.LayoutSetPrototypeModelImpl 041 * @generated 042 */ 043 public interface LayoutSetPrototypeModel extends BaseModel<LayoutSetPrototype>, 044 StagedAuditedModel { 045 /* 046 * NOTE FOR DEVELOPERS: 047 * 048 * Never modify or reference this interface directly. All methods that expect a layout set prototype model instance should use the {@link LayoutSetPrototype} interface instead. 049 */ 050 051 /** 052 * Returns the primary key of this layout set prototype. 053 * 054 * @return the primary key of this layout set prototype 055 */ 056 public long getPrimaryKey(); 057 058 /** 059 * Sets the primary key of this layout set prototype. 060 * 061 * @param primaryKey the primary key of this layout set prototype 062 */ 063 public void setPrimaryKey(long primaryKey); 064 065 /** 066 * Returns the uuid of this layout set prototype. 067 * 068 * @return the uuid of this layout set prototype 069 */ 070 @AutoEscape 071 @Override 072 public String getUuid(); 073 074 /** 075 * Sets the uuid of this layout set prototype. 076 * 077 * @param uuid the uuid of this layout set prototype 078 */ 079 @Override 080 public void setUuid(String uuid); 081 082 /** 083 * Returns the layout set prototype ID of this layout set prototype. 084 * 085 * @return the layout set prototype ID of this layout set prototype 086 */ 087 public long getLayoutSetPrototypeId(); 088 089 /** 090 * Sets the layout set prototype ID of this layout set prototype. 091 * 092 * @param layoutSetPrototypeId the layout set prototype ID of this layout set prototype 093 */ 094 public void setLayoutSetPrototypeId(long layoutSetPrototypeId); 095 096 /** 097 * Returns the company ID of this layout set prototype. 098 * 099 * @return the company ID of this layout set prototype 100 */ 101 @Override 102 public long getCompanyId(); 103 104 /** 105 * Sets the company ID of this layout set prototype. 106 * 107 * @param companyId the company ID of this layout set prototype 108 */ 109 @Override 110 public void setCompanyId(long companyId); 111 112 /** 113 * Returns the user ID of this layout set prototype. 114 * 115 * @return the user ID of this layout set prototype 116 */ 117 @Override 118 public long getUserId(); 119 120 /** 121 * Sets the user ID of this layout set prototype. 122 * 123 * @param userId the user ID of this layout set prototype 124 */ 125 @Override 126 public void setUserId(long userId); 127 128 /** 129 * Returns the user uuid of this layout set prototype. 130 * 131 * @return the user uuid of this layout set prototype 132 * @throws SystemException if a system exception occurred 133 */ 134 @Override 135 public String getUserUuid() throws SystemException; 136 137 /** 138 * Sets the user uuid of this layout set prototype. 139 * 140 * @param userUuid the user uuid of this layout set prototype 141 */ 142 @Override 143 public void setUserUuid(String userUuid); 144 145 /** 146 * Returns the user name of this layout set prototype. 147 * 148 * @return the user name of this layout set prototype 149 */ 150 @AutoEscape 151 @Override 152 public String getUserName(); 153 154 /** 155 * Sets the user name of this layout set prototype. 156 * 157 * @param userName the user name of this layout set prototype 158 */ 159 @Override 160 public void setUserName(String userName); 161 162 /** 163 * Returns the create date of this layout set prototype. 164 * 165 * @return the create date of this layout set prototype 166 */ 167 @Override 168 public Date getCreateDate(); 169 170 /** 171 * Sets the create date of this layout set prototype. 172 * 173 * @param createDate the create date of this layout set prototype 174 */ 175 @Override 176 public void setCreateDate(Date createDate); 177 178 /** 179 * Returns the modified date of this layout set prototype. 180 * 181 * @return the modified date of this layout set prototype 182 */ 183 @Override 184 public Date getModifiedDate(); 185 186 /** 187 * Sets the modified date of this layout set prototype. 188 * 189 * @param modifiedDate the modified date of this layout set prototype 190 */ 191 @Override 192 public void setModifiedDate(Date modifiedDate); 193 194 /** 195 * Returns the name of this layout set prototype. 196 * 197 * @return the name of this layout set prototype 198 */ 199 public String getName(); 200 201 /** 202 * Returns the localized name of this layout set prototype in the language. Uses the default language if no localization exists for the requested language. 203 * 204 * @param locale the locale of the language 205 * @return the localized name of this layout set prototype 206 */ 207 @AutoEscape 208 public String getName(Locale locale); 209 210 /** 211 * 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. 212 * 213 * @param locale the local of the language 214 * @param useDefault whether to use the default language if no localization exists for the requested language 215 * @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. 216 */ 217 @AutoEscape 218 public String getName(Locale locale, boolean useDefault); 219 220 /** 221 * Returns the localized name of this layout set prototype in the language. Uses the default language if no localization exists for the requested language. 222 * 223 * @param languageId the ID of the language 224 * @return the localized name of this layout set prototype 225 */ 226 @AutoEscape 227 public String getName(String languageId); 228 229 /** 230 * 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. 231 * 232 * @param languageId the ID of the language 233 * @param useDefault whether to use the default language if no localization exists for the requested language 234 * @return the localized name of this layout set prototype 235 */ 236 @AutoEscape 237 public String getName(String languageId, boolean useDefault); 238 239 @AutoEscape 240 public String getNameCurrentLanguageId(); 241 242 @AutoEscape 243 public String getNameCurrentValue(); 244 245 /** 246 * Returns a map of the locales and localized names of this layout set prototype. 247 * 248 * @return the locales and localized names of this layout set prototype 249 */ 250 public Map<Locale, String> getNameMap(); 251 252 /** 253 * Sets the name of this layout set prototype. 254 * 255 * @param name the name of this layout set prototype 256 */ 257 public void setName(String name); 258 259 /** 260 * Sets the localized name of this layout set prototype in the language. 261 * 262 * @param name the localized name of this layout set prototype 263 * @param locale the locale of the language 264 */ 265 public void setName(String name, Locale locale); 266 267 /** 268 * Sets the localized name of this layout set prototype in the language, and sets the default locale. 269 * 270 * @param name the localized name of this layout set prototype 271 * @param locale the locale of the language 272 * @param defaultLocale the default locale 273 */ 274 public void setName(String name, Locale locale, Locale defaultLocale); 275 276 public void setNameCurrentLanguageId(String languageId); 277 278 /** 279 * Sets the localized names of this layout set prototype from the map of locales and localized names. 280 * 281 * @param nameMap the locales and localized names of this layout set prototype 282 */ 283 public void setNameMap(Map<Locale, String> nameMap); 284 285 /** 286 * Sets the localized names of this layout set prototype from the map of locales and localized names, and sets the default locale. 287 * 288 * @param nameMap the locales and localized names of this layout set prototype 289 * @param defaultLocale the default locale 290 */ 291 public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale); 292 293 /** 294 * Returns the description of this layout set prototype. 295 * 296 * @return the description of this layout set prototype 297 */ 298 @AutoEscape 299 public String getDescription(); 300 301 /** 302 * Sets the description of this layout set prototype. 303 * 304 * @param description the description of this layout set prototype 305 */ 306 public void setDescription(String description); 307 308 /** 309 * Returns the settings of this layout set prototype. 310 * 311 * @return the settings of this layout set prototype 312 */ 313 @AutoEscape 314 public String getSettings(); 315 316 /** 317 * Sets the settings of this layout set prototype. 318 * 319 * @param settings the settings of this layout set prototype 320 */ 321 public void setSettings(String settings); 322 323 /** 324 * Returns the active of this layout set prototype. 325 * 326 * @return the active of this layout set prototype 327 */ 328 public boolean getActive(); 329 330 /** 331 * Returns <code>true</code> if this layout set prototype is active. 332 * 333 * @return <code>true</code> if this layout set prototype is active; <code>false</code> otherwise 334 */ 335 public boolean isActive(); 336 337 /** 338 * Sets whether this layout set prototype is active. 339 * 340 * @param active the active of this layout set prototype 341 */ 342 public void setActive(boolean active); 343 344 @Override 345 public boolean isNew(); 346 347 @Override 348 public void setNew(boolean n); 349 350 @Override 351 public boolean isCachedModel(); 352 353 @Override 354 public void setCachedModel(boolean cachedModel); 355 356 @Override 357 public boolean isEscapedModel(); 358 359 @Override 360 public Serializable getPrimaryKeyObj(); 361 362 @Override 363 public void setPrimaryKeyObj(Serializable primaryKeyObj); 364 365 @Override 366 public ExpandoBridge getExpandoBridge(); 367 368 @Override 369 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 370 371 @Override 372 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 373 374 @Override 375 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 376 377 public String[] getAvailableLanguageIds(); 378 379 public String getDefaultLanguageId(); 380 381 public void prepareLocalizedFieldsForImport() throws LocaleException; 382 383 public void prepareLocalizedFieldsForImport(Locale defaultImportLocale) 384 throws LocaleException; 385 386 @Override 387 public Object clone(); 388 389 @Override 390 public int compareTo(LayoutSetPrototype layoutSetPrototype); 391 392 @Override 393 public int hashCode(); 394 395 @Override 396 public CacheModel<LayoutSetPrototype> toCacheModel(); 397 398 @Override 399 public LayoutSetPrototype toEscapedModel(); 400 401 @Override 402 public LayoutSetPrototype toUnescapedModel(); 403 404 @Override 405 public String toString(); 406 407 @Override 408 public String toXmlString(); 409 }