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.LocaleException; 020 import com.liferay.portal.kernel.bean.AutoEscape; 021 import com.liferay.portal.service.ServiceContext; 022 023 import com.liferay.portlet.expando.model.ExpandoBridge; 024 025 import java.io.Serializable; 026 027 import java.util.Date; 028 import java.util.Locale; 029 import java.util.Map; 030 031 /** 032 * 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. 033 * 034 * <p> 035 * 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}. 036 * </p> 037 * 038 * @author Brian Wing Shun Chan 039 * @see LayoutPrototype 040 * @see com.liferay.portal.model.impl.LayoutPrototypeImpl 041 * @see com.liferay.portal.model.impl.LayoutPrototypeModelImpl 042 * @generated 043 */ 044 @ProviderType 045 public interface LayoutPrototypeModel extends BaseModel<LayoutPrototype>, 046 LocalizedModel, MVCCModel, ShardedModel, StagedAuditedModel { 047 /* 048 * NOTE FOR DEVELOPERS: 049 * 050 * Never modify or reference this interface directly. All methods that expect a layout prototype model instance should use the {@link LayoutPrototype} interface instead. 051 */ 052 053 /** 054 * Returns the primary key of this layout prototype. 055 * 056 * @return the primary key of this layout prototype 057 */ 058 public long getPrimaryKey(); 059 060 /** 061 * Sets the primary key of this layout prototype. 062 * 063 * @param primaryKey the primary key of this layout prototype 064 */ 065 public void setPrimaryKey(long primaryKey); 066 067 /** 068 * Returns the mvcc version of this layout prototype. 069 * 070 * @return the mvcc version of this layout prototype 071 */ 072 @Override 073 public long getMvccVersion(); 074 075 /** 076 * Sets the mvcc version of this layout prototype. 077 * 078 * @param mvccVersion the mvcc version of this layout prototype 079 */ 080 @Override 081 public void setMvccVersion(long mvccVersion); 082 083 /** 084 * Returns the uuid of this layout prototype. 085 * 086 * @return the uuid of this layout prototype 087 */ 088 @AutoEscape 089 @Override 090 public String getUuid(); 091 092 /** 093 * Sets the uuid of this layout prototype. 094 * 095 * @param uuid the uuid of this layout prototype 096 */ 097 @Override 098 public void setUuid(String uuid); 099 100 /** 101 * Returns the layout prototype ID of this layout prototype. 102 * 103 * @return the layout prototype ID of this layout prototype 104 */ 105 public long getLayoutPrototypeId(); 106 107 /** 108 * Sets the layout prototype ID of this layout prototype. 109 * 110 * @param layoutPrototypeId the layout prototype ID of this layout prototype 111 */ 112 public void setLayoutPrototypeId(long layoutPrototypeId); 113 114 /** 115 * Returns the company ID of this layout prototype. 116 * 117 * @return the company ID of this layout prototype 118 */ 119 @Override 120 public long getCompanyId(); 121 122 /** 123 * Sets the company ID of this layout prototype. 124 * 125 * @param companyId the company ID of this layout prototype 126 */ 127 @Override 128 public void setCompanyId(long companyId); 129 130 /** 131 * Returns the user ID of this layout prototype. 132 * 133 * @return the user ID of this layout prototype 134 */ 135 @Override 136 public long getUserId(); 137 138 /** 139 * Sets the user ID of this layout prototype. 140 * 141 * @param userId the user ID of this layout prototype 142 */ 143 @Override 144 public void setUserId(long userId); 145 146 /** 147 * Returns the user uuid of this layout prototype. 148 * 149 * @return the user uuid of this layout prototype 150 */ 151 @Override 152 public String getUserUuid(); 153 154 /** 155 * Sets the user uuid of this layout prototype. 156 * 157 * @param userUuid the user uuid of this layout prototype 158 */ 159 @Override 160 public void setUserUuid(String userUuid); 161 162 /** 163 * Returns the user name of this layout prototype. 164 * 165 * @return the user name of this layout prototype 166 */ 167 @AutoEscape 168 @Override 169 public String getUserName(); 170 171 /** 172 * Sets the user name of this layout prototype. 173 * 174 * @param userName the user name of this layout prototype 175 */ 176 @Override 177 public void setUserName(String userName); 178 179 /** 180 * Returns the create date of this layout prototype. 181 * 182 * @return the create date of this layout prototype 183 */ 184 @Override 185 public Date getCreateDate(); 186 187 /** 188 * Sets the create date of this layout prototype. 189 * 190 * @param createDate the create date of this layout prototype 191 */ 192 @Override 193 public void setCreateDate(Date createDate); 194 195 /** 196 * Returns the modified date of this layout prototype. 197 * 198 * @return the modified date of this layout prototype 199 */ 200 @Override 201 public Date getModifiedDate(); 202 203 /** 204 * Sets the modified date of this layout prototype. 205 * 206 * @param modifiedDate the modified date of this layout prototype 207 */ 208 @Override 209 public void setModifiedDate(Date modifiedDate); 210 211 /** 212 * Returns the name of this layout prototype. 213 * 214 * @return the name of this layout prototype 215 */ 216 public String getName(); 217 218 /** 219 * Returns the localized name of this layout prototype in the language. Uses the default language if no localization exists for the requested language. 220 * 221 * @param locale the locale of the language 222 * @return the localized name of this layout prototype 223 */ 224 @AutoEscape 225 public String getName(Locale locale); 226 227 /** 228 * Returns the localized name of this layout prototype in the language, optionally using the default language if no localization exists for the requested language. 229 * 230 * @param locale the local of the language 231 * @param useDefault whether to use the default language if no localization exists for the requested language 232 * @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. 233 */ 234 @AutoEscape 235 public String getName(Locale locale, boolean useDefault); 236 237 /** 238 * Returns the localized name of this layout prototype in the language. Uses the default language if no localization exists for the requested language. 239 * 240 * @param languageId the ID of the language 241 * @return the localized name of this layout prototype 242 */ 243 @AutoEscape 244 public String getName(String languageId); 245 246 /** 247 * Returns the localized name of this layout prototype in the language, optionally using the default language if no localization exists for the requested language. 248 * 249 * @param languageId the ID of the language 250 * @param useDefault whether to use the default language if no localization exists for the requested language 251 * @return the localized name of this layout prototype 252 */ 253 @AutoEscape 254 public String getName(String languageId, boolean useDefault); 255 256 @AutoEscape 257 public String getNameCurrentLanguageId(); 258 259 @AutoEscape 260 public String getNameCurrentValue(); 261 262 /** 263 * Returns a map of the locales and localized names of this layout prototype. 264 * 265 * @return the locales and localized names of this layout prototype 266 */ 267 public Map<Locale, String> getNameMap(); 268 269 /** 270 * Sets the name of this layout prototype. 271 * 272 * @param name the name of this layout prototype 273 */ 274 public void setName(String name); 275 276 /** 277 * Sets the localized name of this layout prototype in the language. 278 * 279 * @param name the localized name of this layout prototype 280 * @param locale the locale of the language 281 */ 282 public void setName(String name, Locale locale); 283 284 /** 285 * Sets the localized name of this layout prototype in the language, and sets the default locale. 286 * 287 * @param name the localized name of this layout prototype 288 * @param locale the locale of the language 289 * @param defaultLocale the default locale 290 */ 291 public void setName(String name, Locale locale, Locale defaultLocale); 292 293 public void setNameCurrentLanguageId(String languageId); 294 295 /** 296 * Sets the localized names of this layout prototype from the map of locales and localized names. 297 * 298 * @param nameMap the locales and localized names of this layout prototype 299 */ 300 public void setNameMap(Map<Locale, String> nameMap); 301 302 /** 303 * Sets the localized names of this layout prototype from the map of locales and localized names, and sets the default locale. 304 * 305 * @param nameMap the locales and localized names of this layout prototype 306 * @param defaultLocale the default locale 307 */ 308 public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale); 309 310 /** 311 * Returns the description of this layout prototype. 312 * 313 * @return the description of this layout prototype 314 */ 315 public String getDescription(); 316 317 /** 318 * Returns the localized description of this layout prototype in the language. Uses the default language if no localization exists for the requested language. 319 * 320 * @param locale the locale of the language 321 * @return the localized description of this layout prototype 322 */ 323 @AutoEscape 324 public String getDescription(Locale locale); 325 326 /** 327 * Returns the localized description of this layout prototype in the language, optionally using the default language if no localization exists for the requested language. 328 * 329 * @param locale the local of the language 330 * @param useDefault whether to use the default language if no localization exists for the requested language 331 * @return the localized description 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. 332 */ 333 @AutoEscape 334 public String getDescription(Locale locale, boolean useDefault); 335 336 /** 337 * Returns the localized description of this layout prototype in the language. Uses the default language if no localization exists for the requested language. 338 * 339 * @param languageId the ID of the language 340 * @return the localized description of this layout prototype 341 */ 342 @AutoEscape 343 public String getDescription(String languageId); 344 345 /** 346 * Returns the localized description of this layout prototype in the language, optionally using the default language if no localization exists for the requested language. 347 * 348 * @param languageId the ID of the language 349 * @param useDefault whether to use the default language if no localization exists for the requested language 350 * @return the localized description of this layout prototype 351 */ 352 @AutoEscape 353 public String getDescription(String languageId, boolean useDefault); 354 355 @AutoEscape 356 public String getDescriptionCurrentLanguageId(); 357 358 @AutoEscape 359 public String getDescriptionCurrentValue(); 360 361 /** 362 * Returns a map of the locales and localized descriptions of this layout prototype. 363 * 364 * @return the locales and localized descriptions of this layout prototype 365 */ 366 public Map<Locale, String> getDescriptionMap(); 367 368 /** 369 * Sets the description of this layout prototype. 370 * 371 * @param description the description of this layout prototype 372 */ 373 public void setDescription(String description); 374 375 /** 376 * Sets the localized description of this layout prototype in the language. 377 * 378 * @param description the localized description of this layout prototype 379 * @param locale the locale of the language 380 */ 381 public void setDescription(String description, Locale locale); 382 383 /** 384 * Sets the localized description of this layout prototype in the language, and sets the default locale. 385 * 386 * @param description the localized description of this layout prototype 387 * @param locale the locale of the language 388 * @param defaultLocale the default locale 389 */ 390 public void setDescription(String description, Locale locale, 391 Locale defaultLocale); 392 393 public void setDescriptionCurrentLanguageId(String languageId); 394 395 /** 396 * Sets the localized descriptions of this layout prototype from the map of locales and localized descriptions. 397 * 398 * @param descriptionMap the locales and localized descriptions of this layout prototype 399 */ 400 public void setDescriptionMap(Map<Locale, String> descriptionMap); 401 402 /** 403 * Sets the localized descriptions of this layout prototype from the map of locales and localized descriptions, and sets the default locale. 404 * 405 * @param descriptionMap the locales and localized descriptions of this layout prototype 406 * @param defaultLocale the default locale 407 */ 408 public void setDescriptionMap(Map<Locale, String> descriptionMap, 409 Locale defaultLocale); 410 411 /** 412 * Returns the settings of this layout prototype. 413 * 414 * @return the settings of this layout prototype 415 */ 416 @AutoEscape 417 public String getSettings(); 418 419 /** 420 * Sets the settings of this layout prototype. 421 * 422 * @param settings the settings of this layout prototype 423 */ 424 public void setSettings(String settings); 425 426 /** 427 * Returns the active of this layout prototype. 428 * 429 * @return the active of this layout prototype 430 */ 431 public boolean getActive(); 432 433 /** 434 * Returns <code>true</code> if this layout prototype is active. 435 * 436 * @return <code>true</code> if this layout prototype is active; <code>false</code> otherwise 437 */ 438 public boolean isActive(); 439 440 /** 441 * Sets whether this layout prototype is active. 442 * 443 * @param active the active of this layout prototype 444 */ 445 public void setActive(boolean active); 446 447 @Override 448 public boolean isNew(); 449 450 @Override 451 public void setNew(boolean n); 452 453 @Override 454 public boolean isCachedModel(); 455 456 @Override 457 public void setCachedModel(boolean cachedModel); 458 459 @Override 460 public boolean isEscapedModel(); 461 462 @Override 463 public Serializable getPrimaryKeyObj(); 464 465 @Override 466 public void setPrimaryKeyObj(Serializable primaryKeyObj); 467 468 @Override 469 public ExpandoBridge getExpandoBridge(); 470 471 @Override 472 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 473 474 @Override 475 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 476 477 @Override 478 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 479 480 @Override 481 public String[] getAvailableLanguageIds(); 482 483 @Override 484 public String getDefaultLanguageId(); 485 486 @Override 487 public void prepareLocalizedFieldsForImport() throws LocaleException; 488 489 @Override 490 public void prepareLocalizedFieldsForImport(Locale defaultImportLocale) 491 throws LocaleException; 492 493 @Override 494 public Object clone(); 495 496 @Override 497 public int compareTo( 498 com.liferay.portal.model.LayoutPrototype layoutPrototype); 499 500 @Override 501 public int hashCode(); 502 503 @Override 504 public CacheModel<com.liferay.portal.model.LayoutPrototype> toCacheModel(); 505 506 @Override 507 public com.liferay.portal.model.LayoutPrototype toEscapedModel(); 508 509 @Override 510 public com.liferay.portal.model.LayoutPrototype toUnescapedModel(); 511 512 @Override 513 public String toString(); 514 515 @Override 516 public String toXmlString(); 517 }