@ProviderType public interface GroupModel extends AttachedModel, BaseModel<Group>, LocalizedModel, MVCCModel, ShardedModel
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
.
Group
Modifier and Type | Method and Description |
---|---|
boolean |
getActive()
Returns the active of this group.
|
String[] |
getAvailableLanguageIds() |
String |
getClassName()
Returns the fully qualified class name of this group.
|
long |
getClassNameId()
Returns the class name ID of this group.
|
long |
getClassPK()
Returns the class pk of this group.
|
long |
getCompanyId()
Returns the company ID of this group.
|
long |
getCreatorUserId()
Returns the creator user ID of this group.
|
String |
getCreatorUserUuid()
Returns the creator user uuid of this group.
|
String |
getDefaultLanguageId() |
String |
getDescription()
Returns the description of this group.
|
String |
getDescription(Locale locale)
Returns the localized description of this group in the language.
|
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.
|
String |
getDescription(String languageId)
Returns the localized description of this group in the language.
|
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.
|
String |
getDescriptionCurrentLanguageId() |
String |
getDescriptionCurrentValue() |
Map<Locale,String> |
getDescriptionMap()
Returns a map of the locales and localized descriptions of this group.
|
String |
getFriendlyURL()
Returns the friendly url of this group.
|
long |
getGroupId()
Returns the group ID of this group.
|
String |
getGroupKey()
Returns the group key of this group.
|
boolean |
getInheritContent()
Returns the inherit content of this group.
|
long |
getLiveGroupId()
Returns the live group ID of this group.
|
boolean |
getManualMembership()
Returns the manual membership of this group.
|
int |
getMembershipRestriction()
Returns the membership restriction of this group.
|
long |
getMvccVersion()
Returns the mvcc version of this group.
|
String |
getName()
Returns the name of this group.
|
String |
getName(Locale locale)
Returns the localized name of this group in the language.
|
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.
|
String |
getName(String languageId)
Returns the localized name of this group in the language.
|
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.
|
String |
getNameCurrentLanguageId() |
String |
getNameCurrentValue() |
Map<Locale,String> |
getNameMap()
Returns a map of the locales and localized names of this group.
|
long |
getParentGroupId()
Returns the parent group ID of this group.
|
long |
getPrimaryKey()
Returns the primary key of this group.
|
int |
getRemoteStagingGroupCount()
Returns the remote staging group count of this group.
|
boolean |
getSite()
Returns the site of this group.
|
String |
getTreePath()
Returns the tree path of this group.
|
int |
getType()
Returns the type of this group.
|
String |
getTypeSettings()
Returns the type settings of this group.
|
String |
getUuid()
Returns the uuid of this group.
|
boolean |
isActive()
Returns
true if this group is active. |
boolean |
isInheritContent()
Returns
true if this group is inherit content. |
boolean |
isManualMembership()
Returns
true if this group is manual membership. |
boolean |
isSite()
Returns
true if this group is site. |
void |
prepareLocalizedFieldsForImport() |
void |
prepareLocalizedFieldsForImport(Locale defaultImportLocale) |
void |
setActive(boolean active)
Sets whether this group is active.
|
void |
setClassName(String className) |
void |
setClassNameId(long classNameId)
Sets the class name ID of this group.
|
void |
setClassPK(long classPK)
Sets the class pk of this group.
|
void |
setCompanyId(long companyId)
Sets the company ID of this group.
|
void |
setCreatorUserId(long creatorUserId)
Sets the creator user ID of this group.
|
void |
setCreatorUserUuid(String creatorUserUuid)
Sets the creator user uuid of this group.
|
void |
setDescription(String description)
Sets the description of this group.
|
void |
setDescription(String description,
Locale locale)
Sets the localized description of this group in the language.
|
void |
setDescription(String description,
Locale locale,
Locale defaultLocale)
Sets the localized description of this group in the language, and sets the default locale.
|
void |
setDescriptionCurrentLanguageId(String languageId) |
void |
setDescriptionMap(Map<Locale,String> descriptionMap)
Sets the localized descriptions of this group from the map of locales and localized descriptions.
|
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.
|
void |
setFriendlyURL(String friendlyURL)
Sets the friendly url of this group.
|
void |
setGroupId(long groupId)
Sets the group ID of this group.
|
void |
setGroupKey(String groupKey)
Sets the group key of this group.
|
void |
setInheritContent(boolean inheritContent)
Sets whether this group is inherit content.
|
void |
setLiveGroupId(long liveGroupId)
Sets the live group ID of this group.
|
void |
setManualMembership(boolean manualMembership)
Sets whether this group is manual membership.
|
void |
setMembershipRestriction(int membershipRestriction)
Sets the membership restriction of this group.
|
void |
setMvccVersion(long mvccVersion)
Sets the mvcc version of this group.
|
void |
setName(String name)
Sets the name of this group.
|
void |
setName(String name,
Locale locale)
Sets the localized name of this group in the language.
|
void |
setName(String name,
Locale locale,
Locale defaultLocale)
Sets the localized name of this group in the language, and sets the default locale.
|
void |
setNameCurrentLanguageId(String languageId) |
void |
setNameMap(Map<Locale,String> nameMap)
Sets the localized names of this group from the map of locales and localized names.
|
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.
|
void |
setParentGroupId(long parentGroupId)
Sets the parent group ID of this group.
|
void |
setPrimaryKey(long primaryKey)
Sets the primary key of this group.
|
void |
setRemoteStagingGroupCount(int remoteStagingGroupCount)
Sets the remote staging group count of this group.
|
void |
setSite(boolean site)
Sets whether this group is site.
|
void |
setTreePath(String treePath)
Sets the tree path of this group.
|
void |
setType(int type)
Sets the type of this group.
|
void |
setTypeSettings(String typeSettings)
Sets the type settings of this group.
|
void |
setUuid(String uuid)
Sets the uuid of this group.
|
clone, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel, toXmlString
getModelClass, getModelClassName
long getPrimaryKey()
void setPrimaryKey(long primaryKey)
primaryKey
- the primary key of this grouplong getMvccVersion()
getMvccVersion
in interface MVCCModel
void setMvccVersion(long mvccVersion)
setMvccVersion
in interface MVCCModel
mvccVersion
- the mvcc version of this group@AutoEscape String getUuid()
void setUuid(String uuid)
uuid
- the uuid of this grouplong getGroupId()
void setGroupId(long groupId)
groupId
- the group ID of this grouplong getCompanyId()
getCompanyId
in interface ShardedModel
void setCompanyId(long companyId)
setCompanyId
in interface ShardedModel
companyId
- the company ID of this grouplong getCreatorUserId()
void setCreatorUserId(long creatorUserId)
creatorUserId
- the creator user ID of this groupString getCreatorUserUuid()
void setCreatorUserUuid(String creatorUserUuid)
creatorUserUuid
- the creator user uuid of this groupString getClassName()
getClassName
in interface TypedModel
void setClassName(String className)
long getClassNameId()
getClassNameId
in interface TypedModel
void setClassNameId(long classNameId)
setClassNameId
in interface TypedModel
classNameId
- the class name ID of this grouplong getClassPK()
getClassPK
in interface AttachedModel
void setClassPK(long classPK)
setClassPK
in interface AttachedModel
classPK
- the class pk of this grouplong getParentGroupId()
void setParentGroupId(long parentGroupId)
parentGroupId
- the parent group ID of this grouplong getLiveGroupId()
void setLiveGroupId(long liveGroupId)
liveGroupId
- the live group ID of this group@AutoEscape String getTreePath()
void setTreePath(String treePath)
treePath
- the tree path of this group@AutoEscape String getGroupKey()
void setGroupKey(String groupKey)
groupKey
- the group key of this groupString getName()
@AutoEscape String getName(Locale locale)
locale
- the locale of the language@AutoEscape String getName(Locale locale, boolean useDefault)
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested languageuseDefault
is false
and no localization exists for the requested language, an empty string will be returned.@AutoEscape String getName(String languageId)
languageId
- the ID of the language@AutoEscape String getName(String languageId, boolean useDefault)
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language@AutoEscape String getNameCurrentLanguageId()
@AutoEscape String getNameCurrentValue()
Map<Locale,String> getNameMap()
void setName(String name)
name
- the name of this groupvoid setName(String name, Locale locale)
name
- the localized name of this grouplocale
- the locale of the languagevoid setName(String name, Locale locale, Locale defaultLocale)
name
- the localized name of this grouplocale
- the locale of the languagedefaultLocale
- the default localevoid setNameCurrentLanguageId(String languageId)
void setNameMap(Map<Locale,String> nameMap)
nameMap
- the locales and localized names of this groupvoid setNameMap(Map<Locale,String> nameMap, Locale defaultLocale)
nameMap
- the locales and localized names of this groupdefaultLocale
- the default localeString getDescription()
@AutoEscape String getDescription(Locale locale)
locale
- the locale of the language@AutoEscape String getDescription(Locale locale, boolean useDefault)
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested languageuseDefault
is false
and no localization exists for the requested language, an empty string will be returned.@AutoEscape String getDescription(String languageId)
languageId
- the ID of the language@AutoEscape String getDescription(String languageId, boolean useDefault)
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language@AutoEscape String getDescriptionCurrentLanguageId()
@AutoEscape String getDescriptionCurrentValue()
Map<Locale,String> getDescriptionMap()
void setDescription(String description)
description
- the description of this groupvoid setDescription(String description, Locale locale)
description
- the localized description of this grouplocale
- the locale of the languagevoid setDescription(String description, Locale locale, Locale defaultLocale)
description
- the localized description of this grouplocale
- the locale of the languagedefaultLocale
- the default localevoid setDescriptionCurrentLanguageId(String languageId)
void setDescriptionMap(Map<Locale,String> descriptionMap)
descriptionMap
- the locales and localized descriptions of this groupvoid setDescriptionMap(Map<Locale,String> descriptionMap, Locale defaultLocale)
descriptionMap
- the locales and localized descriptions of this groupdefaultLocale
- the default localeint getType()
void setType(int type)
type
- the type of this group@AutoEscape String getTypeSettings()
void setTypeSettings(String typeSettings)
typeSettings
- the type settings of this groupboolean getManualMembership()
boolean isManualMembership()
true
if this group is manual membership.true
if this group is manual membership; false
otherwisevoid setManualMembership(boolean manualMembership)
manualMembership
- the manual membership of this groupint getMembershipRestriction()
void setMembershipRestriction(int membershipRestriction)
membershipRestriction
- the membership restriction of this group@AutoEscape String getFriendlyURL()
void setFriendlyURL(String friendlyURL)
friendlyURL
- the friendly url of this groupboolean getSite()
boolean isSite()
true
if this group is site.true
if this group is site; false
otherwisevoid setSite(boolean site)
site
- the site of this groupint getRemoteStagingGroupCount()
void setRemoteStagingGroupCount(int remoteStagingGroupCount)
remoteStagingGroupCount
- the remote staging group count of this groupboolean getInheritContent()
boolean isInheritContent()
true
if this group is inherit content.true
if this group is inherit content; false
otherwisevoid setInheritContent(boolean inheritContent)
inheritContent
- the inherit content of this groupboolean getActive()
boolean isActive()
true
if this group is active.true
if this group is active; false
otherwisevoid setActive(boolean active)
active
- the active of this groupString[] getAvailableLanguageIds()
getAvailableLanguageIds
in interface LocalizedModel
String getDefaultLanguageId()
getDefaultLanguageId
in interface LocalizedModel
void prepareLocalizedFieldsForImport() throws LocaleException
prepareLocalizedFieldsForImport
in interface LocalizedModel
LocaleException
void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws LocaleException
prepareLocalizedFieldsForImport
in interface LocalizedModel
LocaleException