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.portlet.dynamicdatamapping.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.model.AttachedModel; 021 import com.liferay.portal.model.BaseModel; 022 import com.liferay.portal.model.CacheModel; 023 import com.liferay.portal.model.StagedGroupedModel; 024 import com.liferay.portal.service.ServiceContext; 025 026 import com.liferay.portlet.expando.model.ExpandoBridge; 027 028 import java.io.Serializable; 029 030 import java.util.Date; 031 import java.util.Locale; 032 import java.util.Map; 033 034 /** 035 * The base model interface for the DDMTemplate service. Represents a row in the "DDMTemplate" database table, with each column mapped to a property of this class. 036 * 037 * <p> 038 * This interface and its corresponding implementation {@link com.liferay.portlet.dynamicdatamapping.model.impl.DDMTemplateModelImpl} 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.portlet.dynamicdatamapping.model.impl.DDMTemplateImpl}. 039 * </p> 040 * 041 * @author Brian Wing Shun Chan 042 * @see DDMTemplate 043 * @see com.liferay.portlet.dynamicdatamapping.model.impl.DDMTemplateImpl 044 * @see com.liferay.portlet.dynamicdatamapping.model.impl.DDMTemplateModelImpl 045 * @generated 046 */ 047 public interface DDMTemplateModel extends AttachedModel, BaseModel<DDMTemplate>, 048 StagedGroupedModel { 049 /* 050 * NOTE FOR DEVELOPERS: 051 * 052 * Never modify or reference this interface directly. All methods that expect a d d m template model instance should use the {@link DDMTemplate} interface instead. 053 */ 054 055 /** 056 * Returns the primary key of this d d m template. 057 * 058 * @return the primary key of this d d m template 059 */ 060 public long getPrimaryKey(); 061 062 /** 063 * Sets the primary key of this d d m template. 064 * 065 * @param primaryKey the primary key of this d d m template 066 */ 067 public void setPrimaryKey(long primaryKey); 068 069 /** 070 * Returns the uuid of this d d m template. 071 * 072 * @return the uuid of this d d m template 073 */ 074 @AutoEscape 075 @Override 076 public String getUuid(); 077 078 /** 079 * Sets the uuid of this d d m template. 080 * 081 * @param uuid the uuid of this d d m template 082 */ 083 @Override 084 public void setUuid(String uuid); 085 086 /** 087 * Returns the template ID of this d d m template. 088 * 089 * @return the template ID of this d d m template 090 */ 091 public long getTemplateId(); 092 093 /** 094 * Sets the template ID of this d d m template. 095 * 096 * @param templateId the template ID of this d d m template 097 */ 098 public void setTemplateId(long templateId); 099 100 /** 101 * Returns the group ID of this d d m template. 102 * 103 * @return the group ID of this d d m template 104 */ 105 @Override 106 public long getGroupId(); 107 108 /** 109 * Sets the group ID of this d d m template. 110 * 111 * @param groupId the group ID of this d d m template 112 */ 113 @Override 114 public void setGroupId(long groupId); 115 116 /** 117 * Returns the company ID of this d d m template. 118 * 119 * @return the company ID of this d d m template 120 */ 121 @Override 122 public long getCompanyId(); 123 124 /** 125 * Sets the company ID of this d d m template. 126 * 127 * @param companyId the company ID of this d d m template 128 */ 129 @Override 130 public void setCompanyId(long companyId); 131 132 /** 133 * Returns the user ID of this d d m template. 134 * 135 * @return the user ID of this d d m template 136 */ 137 @Override 138 public long getUserId(); 139 140 /** 141 * Sets the user ID of this d d m template. 142 * 143 * @param userId the user ID of this d d m template 144 */ 145 @Override 146 public void setUserId(long userId); 147 148 /** 149 * Returns the user uuid of this d d m template. 150 * 151 * @return the user uuid of this d d m template 152 * @throws SystemException if a system exception occurred 153 */ 154 @Override 155 public String getUserUuid() throws SystemException; 156 157 /** 158 * Sets the user uuid of this d d m template. 159 * 160 * @param userUuid the user uuid of this d d m template 161 */ 162 @Override 163 public void setUserUuid(String userUuid); 164 165 /** 166 * Returns the user name of this d d m template. 167 * 168 * @return the user name of this d d m template 169 */ 170 @AutoEscape 171 @Override 172 public String getUserName(); 173 174 /** 175 * Sets the user name of this d d m template. 176 * 177 * @param userName the user name of this d d m template 178 */ 179 @Override 180 public void setUserName(String userName); 181 182 /** 183 * Returns the create date of this d d m template. 184 * 185 * @return the create date of this d d m template 186 */ 187 @Override 188 public Date getCreateDate(); 189 190 /** 191 * Sets the create date of this d d m template. 192 * 193 * @param createDate the create date of this d d m template 194 */ 195 @Override 196 public void setCreateDate(Date createDate); 197 198 /** 199 * Returns the modified date of this d d m template. 200 * 201 * @return the modified date of this d d m template 202 */ 203 @Override 204 public Date getModifiedDate(); 205 206 /** 207 * Sets the modified date of this d d m template. 208 * 209 * @param modifiedDate the modified date of this d d m template 210 */ 211 @Override 212 public void setModifiedDate(Date modifiedDate); 213 214 /** 215 * Returns the fully qualified class name of this d d m template. 216 * 217 * @return the fully qualified class name of this d d m template 218 */ 219 @Override 220 public String getClassName(); 221 222 public void setClassName(String className); 223 224 /** 225 * Returns the class name ID of this d d m template. 226 * 227 * @return the class name ID of this d d m template 228 */ 229 @Override 230 public long getClassNameId(); 231 232 /** 233 * Sets the class name ID of this d d m template. 234 * 235 * @param classNameId the class name ID of this d d m template 236 */ 237 @Override 238 public void setClassNameId(long classNameId); 239 240 /** 241 * Returns the class p k of this d d m template. 242 * 243 * @return the class p k of this d d m template 244 */ 245 @Override 246 public long getClassPK(); 247 248 /** 249 * Sets the class p k of this d d m template. 250 * 251 * @param classPK the class p k of this d d m template 252 */ 253 @Override 254 public void setClassPK(long classPK); 255 256 /** 257 * Returns the template key of this d d m template. 258 * 259 * @return the template key of this d d m template 260 */ 261 @AutoEscape 262 public String getTemplateKey(); 263 264 /** 265 * Sets the template key of this d d m template. 266 * 267 * @param templateKey the template key of this d d m template 268 */ 269 public void setTemplateKey(String templateKey); 270 271 /** 272 * Returns the name of this d d m template. 273 * 274 * @return the name of this d d m template 275 */ 276 public String getName(); 277 278 /** 279 * Returns the localized name of this d d m template in the language. Uses the default language if no localization exists for the requested language. 280 * 281 * @param locale the locale of the language 282 * @return the localized name of this d d m template 283 */ 284 @AutoEscape 285 public String getName(Locale locale); 286 287 /** 288 * Returns the localized name of this d d m template in the language, optionally using the default language if no localization exists for the requested language. 289 * 290 * @param locale the local of the language 291 * @param useDefault whether to use the default language if no localization exists for the requested language 292 * @return the localized name of this d d m template. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned. 293 */ 294 @AutoEscape 295 public String getName(Locale locale, boolean useDefault); 296 297 /** 298 * Returns the localized name of this d d m template in the language. Uses the default language if no localization exists for the requested language. 299 * 300 * @param languageId the ID of the language 301 * @return the localized name of this d d m template 302 */ 303 @AutoEscape 304 public String getName(String languageId); 305 306 /** 307 * Returns the localized name of this d d m template in the language, optionally using the default language if no localization exists for the requested language. 308 * 309 * @param languageId the ID of the language 310 * @param useDefault whether to use the default language if no localization exists for the requested language 311 * @return the localized name of this d d m template 312 */ 313 @AutoEscape 314 public String getName(String languageId, boolean useDefault); 315 316 @AutoEscape 317 public String getNameCurrentLanguageId(); 318 319 @AutoEscape 320 public String getNameCurrentValue(); 321 322 /** 323 * Returns a map of the locales and localized names of this d d m template. 324 * 325 * @return the locales and localized names of this d d m template 326 */ 327 public Map<Locale, String> getNameMap(); 328 329 /** 330 * Sets the name of this d d m template. 331 * 332 * @param name the name of this d d m template 333 */ 334 public void setName(String name); 335 336 /** 337 * Sets the localized name of this d d m template in the language. 338 * 339 * @param name the localized name of this d d m template 340 * @param locale the locale of the language 341 */ 342 public void setName(String name, Locale locale); 343 344 /** 345 * Sets the localized name of this d d m template in the language, and sets the default locale. 346 * 347 * @param name the localized name of this d d m template 348 * @param locale the locale of the language 349 * @param defaultLocale the default locale 350 */ 351 public void setName(String name, Locale locale, Locale defaultLocale); 352 353 public void setNameCurrentLanguageId(String languageId); 354 355 /** 356 * Sets the localized names of this d d m template from the map of locales and localized names. 357 * 358 * @param nameMap the locales and localized names of this d d m template 359 */ 360 public void setNameMap(Map<Locale, String> nameMap); 361 362 /** 363 * Sets the localized names of this d d m template from the map of locales and localized names, and sets the default locale. 364 * 365 * @param nameMap the locales and localized names of this d d m template 366 * @param defaultLocale the default locale 367 */ 368 public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale); 369 370 /** 371 * Returns the description of this d d m template. 372 * 373 * @return the description of this d d m template 374 */ 375 public String getDescription(); 376 377 /** 378 * Returns the localized description of this d d m template in the language. Uses the default language if no localization exists for the requested language. 379 * 380 * @param locale the locale of the language 381 * @return the localized description of this d d m template 382 */ 383 @AutoEscape 384 public String getDescription(Locale locale); 385 386 /** 387 * Returns the localized description of this d d m template in the language, optionally using the default language if no localization exists for the requested language. 388 * 389 * @param locale the local of the language 390 * @param useDefault whether to use the default language if no localization exists for the requested language 391 * @return the localized description of this d d m template. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned. 392 */ 393 @AutoEscape 394 public String getDescription(Locale locale, boolean useDefault); 395 396 /** 397 * Returns the localized description of this d d m template in the language. Uses the default language if no localization exists for the requested language. 398 * 399 * @param languageId the ID of the language 400 * @return the localized description of this d d m template 401 */ 402 @AutoEscape 403 public String getDescription(String languageId); 404 405 /** 406 * Returns the localized description of this d d m template in the language, optionally using the default language if no localization exists for the requested language. 407 * 408 * @param languageId the ID of the language 409 * @param useDefault whether to use the default language if no localization exists for the requested language 410 * @return the localized description of this d d m template 411 */ 412 @AutoEscape 413 public String getDescription(String languageId, boolean useDefault); 414 415 @AutoEscape 416 public String getDescriptionCurrentLanguageId(); 417 418 @AutoEscape 419 public String getDescriptionCurrentValue(); 420 421 /** 422 * Returns a map of the locales and localized descriptions of this d d m template. 423 * 424 * @return the locales and localized descriptions of this d d m template 425 */ 426 public Map<Locale, String> getDescriptionMap(); 427 428 /** 429 * Sets the description of this d d m template. 430 * 431 * @param description the description of this d d m template 432 */ 433 public void setDescription(String description); 434 435 /** 436 * Sets the localized description of this d d m template in the language. 437 * 438 * @param description the localized description of this d d m template 439 * @param locale the locale of the language 440 */ 441 public void setDescription(String description, Locale locale); 442 443 /** 444 * Sets the localized description of this d d m template in the language, and sets the default locale. 445 * 446 * @param description the localized description of this d d m template 447 * @param locale the locale of the language 448 * @param defaultLocale the default locale 449 */ 450 public void setDescription(String description, Locale locale, 451 Locale defaultLocale); 452 453 public void setDescriptionCurrentLanguageId(String languageId); 454 455 /** 456 * Sets the localized descriptions of this d d m template from the map of locales and localized descriptions. 457 * 458 * @param descriptionMap the locales and localized descriptions of this d d m template 459 */ 460 public void setDescriptionMap(Map<Locale, String> descriptionMap); 461 462 /** 463 * Sets the localized descriptions of this d d m template from the map of locales and localized descriptions, and sets the default locale. 464 * 465 * @param descriptionMap the locales and localized descriptions of this d d m template 466 * @param defaultLocale the default locale 467 */ 468 public void setDescriptionMap(Map<Locale, String> descriptionMap, 469 Locale defaultLocale); 470 471 /** 472 * Returns the type of this d d m template. 473 * 474 * @return the type of this d d m template 475 */ 476 @AutoEscape 477 public String getType(); 478 479 /** 480 * Sets the type of this d d m template. 481 * 482 * @param type the type of this d d m template 483 */ 484 public void setType(String type); 485 486 /** 487 * Returns the mode of this d d m template. 488 * 489 * @return the mode of this d d m template 490 */ 491 @AutoEscape 492 public String getMode(); 493 494 /** 495 * Sets the mode of this d d m template. 496 * 497 * @param mode the mode of this d d m template 498 */ 499 public void setMode(String mode); 500 501 /** 502 * Returns the language of this d d m template. 503 * 504 * @return the language of this d d m template 505 */ 506 @AutoEscape 507 public String getLanguage(); 508 509 /** 510 * Sets the language of this d d m template. 511 * 512 * @param language the language of this d d m template 513 */ 514 public void setLanguage(String language); 515 516 /** 517 * Returns the script of this d d m template. 518 * 519 * @return the script of this d d m template 520 */ 521 @AutoEscape 522 public String getScript(); 523 524 /** 525 * Sets the script of this d d m template. 526 * 527 * @param script the script of this d d m template 528 */ 529 public void setScript(String script); 530 531 /** 532 * Returns the cacheable of this d d m template. 533 * 534 * @return the cacheable of this d d m template 535 */ 536 public boolean getCacheable(); 537 538 /** 539 * Returns <code>true</code> if this d d m template is cacheable. 540 * 541 * @return <code>true</code> if this d d m template is cacheable; <code>false</code> otherwise 542 */ 543 public boolean isCacheable(); 544 545 /** 546 * Sets whether this d d m template is cacheable. 547 * 548 * @param cacheable the cacheable of this d d m template 549 */ 550 public void setCacheable(boolean cacheable); 551 552 /** 553 * Returns the small image of this d d m template. 554 * 555 * @return the small image of this d d m template 556 */ 557 public boolean getSmallImage(); 558 559 /** 560 * Returns <code>true</code> if this d d m template is small image. 561 * 562 * @return <code>true</code> if this d d m template is small image; <code>false</code> otherwise 563 */ 564 public boolean isSmallImage(); 565 566 /** 567 * Sets whether this d d m template is small image. 568 * 569 * @param smallImage the small image of this d d m template 570 */ 571 public void setSmallImage(boolean smallImage); 572 573 /** 574 * Returns the small image ID of this d d m template. 575 * 576 * @return the small image ID of this d d m template 577 */ 578 public long getSmallImageId(); 579 580 /** 581 * Sets the small image ID of this d d m template. 582 * 583 * @param smallImageId the small image ID of this d d m template 584 */ 585 public void setSmallImageId(long smallImageId); 586 587 /** 588 * Returns the small image u r l of this d d m template. 589 * 590 * @return the small image u r l of this d d m template 591 */ 592 @AutoEscape 593 public String getSmallImageURL(); 594 595 /** 596 * Sets the small image u r l of this d d m template. 597 * 598 * @param smallImageURL the small image u r l of this d d m template 599 */ 600 public void setSmallImageURL(String smallImageURL); 601 602 @Override 603 public boolean isNew(); 604 605 @Override 606 public void setNew(boolean n); 607 608 @Override 609 public boolean isCachedModel(); 610 611 @Override 612 public void setCachedModel(boolean cachedModel); 613 614 @Override 615 public boolean isEscapedModel(); 616 617 @Override 618 public Serializable getPrimaryKeyObj(); 619 620 @Override 621 public void setPrimaryKeyObj(Serializable primaryKeyObj); 622 623 @Override 624 public ExpandoBridge getExpandoBridge(); 625 626 @Override 627 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 628 629 @Override 630 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 631 632 @Override 633 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 634 635 public String[] getAvailableLanguageIds(); 636 637 public String getDefaultLanguageId(); 638 639 public void prepareLocalizedFieldsForImport() throws LocaleException; 640 641 public void prepareLocalizedFieldsForImport(Locale defaultImportLocale) 642 throws LocaleException; 643 644 @Override 645 public Object clone(); 646 647 @Override 648 public int compareTo(DDMTemplate ddmTemplate); 649 650 @Override 651 public int hashCode(); 652 653 @Override 654 public CacheModel<DDMTemplate> toCacheModel(); 655 656 @Override 657 public DDMTemplate toEscapedModel(); 658 659 @Override 660 public DDMTemplate toUnescapedModel(); 661 662 @Override 663 public String toString(); 664 665 @Override 666 public String toXmlString(); 667 }