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