Interface GroupModel

All Superinterfaces:
AttachedModel, BaseModel<Group>, ClassedModel, Cloneable, Comparable<Group>, CTModel<Group>, ExternalReferenceCodeModel, LocalizedModel, MVCCModel, Serializable, ShardedModel, TypedModel
All Known Subinterfaces:
Group
All Known Implementing Classes:
GroupWrapper

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.

This interface and its corresponding implementation 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 com.liferay.portal.model.impl.GroupImpl.

Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Method Details

    • getPrimaryKey

      long getPrimaryKey()
      Returns the primary key of this group.
      Specified by:
      getPrimaryKey in interface CTModel<Group>
      Returns:
      the primary key of this group
    • setPrimaryKey

      void setPrimaryKey(long primaryKey)
      Sets the primary key of this group.
      Specified by:
      setPrimaryKey in interface CTModel<Group>
      Parameters:
      primaryKey - the primary key of this group
    • getMvccVersion

      long getMvccVersion()
      Returns the mvcc version of this group.
      Specified by:
      getMvccVersion in interface MVCCModel
      Returns:
      the mvcc version of this group
    • setMvccVersion

      void setMvccVersion(long mvccVersion)
      Sets the mvcc version of this group.
      Specified by:
      setMvccVersion in interface MVCCModel
      Parameters:
      mvccVersion - the mvcc version of this group
    • getCtCollectionId

      long getCtCollectionId()
      Returns the ct collection ID of this group.
      Specified by:
      getCtCollectionId in interface CTModel<Group>
      Returns:
      the ct collection ID of this group
    • setCtCollectionId

      void setCtCollectionId(long ctCollectionId)
      Sets the ct collection ID of this group.
      Specified by:
      setCtCollectionId in interface CTModel<Group>
      Parameters:
      ctCollectionId - the ct collection ID of this group
    • getUuid

      @AutoEscape String getUuid()
      Returns the uuid of this group.
      Returns:
      the uuid of this group
    • setUuid

      void setUuid(String uuid)
      Sets the uuid of this group.
      Parameters:
      uuid - the uuid of this group
    • getExternalReferenceCode

      @AutoEscape String getExternalReferenceCode()
      Returns the external reference code of this group.
      Specified by:
      getExternalReferenceCode in interface ExternalReferenceCodeModel
      Returns:
      the external reference code of this group
    • setExternalReferenceCode

      void setExternalReferenceCode(String externalReferenceCode)
      Sets the external reference code of this group.
      Specified by:
      setExternalReferenceCode in interface ExternalReferenceCodeModel
      Parameters:
      externalReferenceCode - the external reference code of this group
    • getGroupId

      long getGroupId()
      Returns the group ID of this group.
      Returns:
      the group ID of this group
    • setGroupId

      void setGroupId(long groupId)
      Sets the group ID of this group.
      Parameters:
      groupId - the group ID of this group
    • getCompanyId

      long getCompanyId()
      Returns the company ID of this group.
      Specified by:
      getCompanyId in interface ShardedModel
      Returns:
      the company ID of this group
    • setCompanyId

      void setCompanyId(long companyId)
      Sets the company ID of this group.
      Specified by:
      setCompanyId in interface ShardedModel
      Parameters:
      companyId - the company ID of this group
    • getCreatorUserId

      long getCreatorUserId()
      Returns the creator user ID of this group.
      Returns:
      the creator user ID of this group
    • setCreatorUserId

      void setCreatorUserId(long creatorUserId)
      Sets the creator user ID of this group.
      Parameters:
      creatorUserId - the creator user ID of this group
    • getCreatorUserUuid

      String getCreatorUserUuid()
      Returns the creator user uuid of this group.
      Returns:
      the creator user uuid of this group
    • setCreatorUserUuid

      void setCreatorUserUuid(String creatorUserUuid)
      Sets the creator user uuid of this group.
      Parameters:
      creatorUserUuid - the creator user uuid of this group
    • getModifiedDate

      Date getModifiedDate()
      Returns the modified date of this group.
      Returns:
      the modified date of this group
    • setModifiedDate

      void setModifiedDate(Date modifiedDate)
      Sets the modified date of this group.
      Parameters:
      modifiedDate - the modified date of this group
    • getClassName

      String getClassName()
      Returns the fully qualified class name of this group.
      Specified by:
      getClassName in interface TypedModel
      Returns:
      the fully qualified class name of this group
    • setClassName

      void setClassName(String className)
    • getClassNameId

      long getClassNameId()
      Returns the class name ID of this group.
      Specified by:
      getClassNameId in interface TypedModel
      Returns:
      the class name ID of this group
    • setClassNameId

      void setClassNameId(long classNameId)
      Sets the class name ID of this group.
      Specified by:
      setClassNameId in interface TypedModel
      Parameters:
      classNameId - the class name ID of this group
    • getClassPK

      long getClassPK()
      Returns the class pk of this group.
      Specified by:
      getClassPK in interface AttachedModel
      Returns:
      the class pk of this group
    • setClassPK

      void setClassPK(long classPK)
      Sets the class pk of this group.
      Specified by:
      setClassPK in interface AttachedModel
      Parameters:
      classPK - the class pk of this group
    • getParentGroupId

      long getParentGroupId()
      Returns the parent group ID of this group.
      Returns:
      the parent group ID of this group
    • setParentGroupId

      void setParentGroupId(long parentGroupId)
      Sets the parent group ID of this group.
      Parameters:
      parentGroupId - the parent group ID of this group
    • getLiveGroupId

      long getLiveGroupId()
      Returns the live group ID of this group.
      Returns:
      the live group ID of this group
    • setLiveGroupId

      void setLiveGroupId(long liveGroupId)
      Sets the live group ID of this group.
      Parameters:
      liveGroupId - the live group ID of this group
    • getTreePath

      @AutoEscape String getTreePath()
      Returns the tree path of this group.
      Returns:
      the tree path of this group
    • setTreePath

      void setTreePath(String treePath)
      Sets the tree path of this group.
      Parameters:
      treePath - the tree path of this group
    • getGroupKey

      @AutoEscape String getGroupKey()
      Returns the group key of this group.
      Returns:
      the group key of this group
    • setGroupKey

      void setGroupKey(String groupKey)
      Sets the group key of this group.
      Parameters:
      groupKey - the group key of this group
    • getName

      String getName()
      Returns the name of this group.
      Returns:
      the name of this group
    • getName

      @AutoEscape String getName(Locale locale)
      Returns the localized name of this group in the language. Uses the default language if no localization exists for the requested language.
      Parameters:
      locale - the locale of the language
      Returns:
      the localized name of this group
    • getName

      @AutoEscape String getName(Locale locale, boolean useDefault)
      Returns the localized name of this group in the language, optionally using the default language if no localization exists for the requested language.
      Parameters:
      locale - the local of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized name of this group. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
    • getName

      @AutoEscape String getName(String languageId)
      Returns the localized name of this group in the language. Uses the default language if no localization exists for the requested language.
      Parameters:
      languageId - the ID of the language
      Returns:
      the localized name of this group
    • getName

      @AutoEscape String getName(String languageId, boolean useDefault)
      Returns the localized name of this group in the language, optionally using the default language if no localization exists for the requested language.
      Parameters:
      languageId - the ID of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized name of this group
    • getNameCurrentLanguageId

      @AutoEscape String getNameCurrentLanguageId()
    • getNameCurrentValue

      @AutoEscape String getNameCurrentValue()
    • getNameMap

      Map<Locale,String> getNameMap()
      Returns a map of the locales and localized names of this group.
      Returns:
      the locales and localized names of this group
    • setName

      void setName(String name)
      Sets the name of this group.
      Parameters:
      name - the name of this group
    • setName

      void setName(String name, Locale locale)
      Sets the localized name of this group in the language.
      Parameters:
      name - the localized name of this group
      locale - the locale of the language
    • setName

      void setName(String name, Locale locale, Locale defaultLocale)
      Sets the localized name of this group in the language, and sets the default locale.
      Parameters:
      name - the localized name of this group
      locale - the locale of the language
      defaultLocale - the default locale
    • setNameCurrentLanguageId

      void setNameCurrentLanguageId(String languageId)
    • setNameMap

      void setNameMap(Map<Locale,String> nameMap)
      Sets the localized names of this group from the map of locales and localized names.
      Parameters:
      nameMap - the locales and localized names of this group
    • setNameMap

      void setNameMap(Map<Locale,String> nameMap, Locale defaultLocale)
      Sets the localized names of this group from the map of locales and localized names, and sets the default locale.
      Parameters:
      nameMap - the locales and localized names of this group
      defaultLocale - the default locale
    • getDescription

      String getDescription()
      Returns the description of this group.
      Returns:
      the description of this group
    • getDescription

      @AutoEscape String getDescription(Locale locale)
      Returns the localized description of this group in the language. Uses the default language if no localization exists for the requested language.
      Parameters:
      locale - the locale of the language
      Returns:
      the localized description of this group
    • getDescription

      @AutoEscape String getDescription(Locale locale, boolean useDefault)
      Returns the localized description of this group in the language, optionally using the default language if no localization exists for the requested language.
      Parameters:
      locale - the local of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized description of this group. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
    • getDescription

      @AutoEscape String getDescription(String languageId)
      Returns the localized description of this group in the language. Uses the default language if no localization exists for the requested language.
      Parameters:
      languageId - the ID of the language
      Returns:
      the localized description of this group
    • getDescription

      @AutoEscape String getDescription(String languageId, boolean useDefault)
      Returns the localized description of this group in the language, optionally using the default language if no localization exists for the requested language.
      Parameters:
      languageId - the ID of the language
      useDefault - whether to use the default language if no localization exists for the requested language
      Returns:
      the localized description of this group
    • getDescriptionCurrentLanguageId

      @AutoEscape String getDescriptionCurrentLanguageId()
    • getDescriptionCurrentValue

      @AutoEscape String getDescriptionCurrentValue()
    • getDescriptionMap

      Map<Locale,String> getDescriptionMap()
      Returns a map of the locales and localized descriptions of this group.
      Returns:
      the locales and localized descriptions of this group
    • setDescription

      void setDescription(String description)
      Sets the description of this group.
      Parameters:
      description - the description of this group
    • setDescription

      void setDescription(String description, Locale locale)
      Sets the localized description of this group in the language.
      Parameters:
      description - the localized description of this group
      locale - the locale of the language
    • setDescription

      void setDescription(String description, Locale locale, Locale defaultLocale)
      Sets the localized description of this group in the language, and sets the default locale.
      Parameters:
      description - the localized description of this group
      locale - the locale of the language
      defaultLocale - the default locale
    • setDescriptionCurrentLanguageId

      void setDescriptionCurrentLanguageId(String languageId)
    • setDescriptionMap

      void setDescriptionMap(Map<Locale,String> descriptionMap)
      Sets the localized descriptions of this group from the map of locales and localized descriptions.
      Parameters:
      descriptionMap - the locales and localized descriptions of this group
    • setDescriptionMap

      void setDescriptionMap(Map<Locale,String> descriptionMap, Locale defaultLocale)
      Sets the localized descriptions of this group from the map of locales and localized descriptions, and sets the default locale.
      Parameters:
      descriptionMap - the locales and localized descriptions of this group
      defaultLocale - the default locale
    • getType

      int getType()
      Returns the type of this group.
      Returns:
      the type of this group
    • setType

      void setType(int type)
      Sets the type of this group.
      Parameters:
      type - the type of this group
    • getTypeSettings

      @AutoEscape String getTypeSettings()
      Returns the type settings of this group.
      Returns:
      the type settings of this group
    • setTypeSettings

      void setTypeSettings(String typeSettings)
      Sets the type settings of this group.
      Parameters:
      typeSettings - the type settings of this group
    • getManualMembership

      boolean getManualMembership()
      Returns the manual membership of this group.
      Returns:
      the manual membership of this group
    • isManualMembership

      boolean isManualMembership()
      Returns true if this group is manual membership.
      Returns:
      true if this group is manual membership; false otherwise
    • setManualMembership

      void setManualMembership(boolean manualMembership)
      Sets whether this group is manual membership.
      Parameters:
      manualMembership - the manual membership of this group
    • getMembershipRestriction

      int getMembershipRestriction()
      Returns the membership restriction of this group.
      Returns:
      the membership restriction of this group
    • setMembershipRestriction

      void setMembershipRestriction(int membershipRestriction)
      Sets the membership restriction of this group.
      Parameters:
      membershipRestriction - the membership restriction of this group
    • getFriendlyURL

      @AutoEscape String getFriendlyURL()
      Returns the friendly url of this group.
      Returns:
      the friendly url of this group
    • setFriendlyURL

      void setFriendlyURL(String friendlyURL)
      Sets the friendly url of this group.
      Parameters:
      friendlyURL - the friendly url of this group
    • getSite

      boolean getSite()
      Returns the site of this group.
      Returns:
      the site of this group
    • isSite

      boolean isSite()
      Returns true if this group is site.
      Returns:
      true if this group is site; false otherwise
    • setSite

      void setSite(boolean site)
      Sets whether this group is site.
      Parameters:
      site - the site of this group
    • getRemoteStagingGroupCount

      int getRemoteStagingGroupCount()
      Returns the remote staging group count of this group.
      Returns:
      the remote staging group count of this group
    • setRemoteStagingGroupCount

      void setRemoteStagingGroupCount(int remoteStagingGroupCount)
      Sets the remote staging group count of this group.
      Parameters:
      remoteStagingGroupCount - the remote staging group count of this group
    • getInheritContent

      boolean getInheritContent()
      Returns the inherit content of this group.
      Returns:
      the inherit content of this group
    • isInheritContent

      boolean isInheritContent()
      Returns true if this group is inherit content.
      Returns:
      true if this group is inherit content; false otherwise
    • setInheritContent

      void setInheritContent(boolean inheritContent)
      Sets whether this group is inherit content.
      Parameters:
      inheritContent - the inherit content of this group
    • getActive

      boolean getActive()
      Returns the active of this group.
      Returns:
      the active of this group
    • isActive

      boolean isActive()
      Returns true if this group is active.
      Returns:
      true if this group is active; false otherwise
    • setActive

      void setActive(boolean active)
      Sets whether this group is active.
      Parameters:
      active - the active of this group
    • getAvailableLanguageIds

      String[] getAvailableLanguageIds()
      Specified by:
      getAvailableLanguageIds in interface LocalizedModel
    • getDefaultLanguageId

      String getDefaultLanguageId()
      Specified by:
      getDefaultLanguageId in interface LocalizedModel
    • prepareLocalizedFieldsForImport

      void prepareLocalizedFieldsForImport() throws LocaleException
      Specified by:
      prepareLocalizedFieldsForImport in interface LocalizedModel
      Throws:
      LocaleException
    • prepareLocalizedFieldsForImport

      void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws LocaleException
      Specified by:
      prepareLocalizedFieldsForImport in interface LocalizedModel
      Throws:
      LocaleException
    • cloneWithOriginalValues

      Group cloneWithOriginalValues()
      Specified by:
      cloneWithOriginalValues in interface BaseModel<Group>
    • toXmlString

      default String toXmlString()