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