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