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