com.liferay.portal.kernel.model

Class GroupWrapper

java.lang.Object

com.liferay.portal.kernel.model.wrapper.BaseModelWrapper<Group>

com.liferay.portal.kernel.model.GroupWrapper

All Implemented Interfaces:

AttachedModel, BaseModel<Group>, CTModel<Group>, ClassedModel, Group, GroupModel, LocalizedModel, ModelWrapper<Group>, MVCCModel, PersistedModel, ShardedModel, TreeModel, TypedModel, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Group>

public class GroupWrapper
extends BaseModelWrapper<Group>
implements Group, ModelWrapper<Group>

This class is a wrapper for Group.

Author:

Brian Wing Shun Chan

See Also:

Group, Serialized Form

Generated:

Field Summary

Fields inherited from class com.liferay.portal.kernel.model.wrapper.BaseModelWrapper

model

Fields inherited from interface com.liferay.portal.kernel.model.Group

GROUP_ID_ACCESSOR

Constructor Summary

Constructors

Constructor and Description
GroupWrapper(Group group)

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildTreePath()
void	clearStagingGroup()
boolean	getActive() Returns the active of this group.
java.util.List<Group>	getAncestors()
java.util.Map<java.lang.String,java.util.function.Function<Group,java.lang.Object>>	getAttributeGetterFunctions()
java.util.Map<java.lang.String,java.util.function.BiConsumer<Group,java.lang.Object>>	getAttributeSetterBiConsumers()
java.lang.String[]	getAvailableLanguageIds()
java.util.List<Group>	getChildren(boolean site)
java.util.List<Group>	getChildrenWithLayouts(boolean site, int start, int end, OrderByComparator<Group> orderByComparator)
int	getChildrenWithLayoutsCount(boolean site)
java.lang.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.
java.lang.String	getCreatorUserUuid() Returns the creator user uuid of this group.
long	getCtCollectionId() Returns the ct collection ID of this group.
java.lang.String	getDefaultLanguageId()
long	getDefaultPrivatePlid()
long	getDefaultPublicPlid()
java.util.List<Group>	getDescendants(boolean site)
java.lang.String	getDescription() Returns the description of this group.
java.lang.String	getDescription(java.util.Locale locale) Returns the localized description of this group in the language.
java.lang.String	getDescription(java.util.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.
java.lang.String	getDescription(java.lang.String languageId) Returns the localized description of this group in the language.
java.lang.String	getDescription(java.lang.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.
java.lang.String	getDescriptionCurrentLanguageId()
java.lang.String	getDescriptionCurrentValue()
java.util.Map<java.util.Locale,java.lang.String>	getDescriptionMap() Returns a map of the locales and localized descriptions of this group.
java.lang.String	getDescriptiveName()
java.lang.String	getDescriptiveName(java.util.Locale locale)
java.lang.String	getDisplayURL(ThemeDisplay themeDisplay)
java.lang.String	getDisplayURL(ThemeDisplay themeDisplay, boolean privateLayout)
java.lang.String	getFriendlyURL() Returns the friendly url of this group.
long	getGroupId() Returns the group ID of this group.
java.lang.String	getGroupKey() Returns the group key of this group.
java.lang.String	getIconCssClass()
java.lang.String	getIconURL(ThemeDisplay themeDisplay)
boolean	getInheritContent() Returns the inherit content of this group.
java.lang.String	getLayoutRootNodeName(boolean privateLayout, java.util.Locale locale)
Group	getLiveGroup()
long	getLiveGroupId() Returns the live group ID of this group.
java.lang.String	getLiveParentTypeSettingsProperty(java.lang.String key)
java.lang.String	getLogoURL(ThemeDisplay themeDisplay, boolean useDefault)
boolean	getManualMembership() Returns the manual membership of this group.
int	getMembershipRestriction() Returns the membership restriction of this group.
java.util.Map<java.lang.String,java.lang.Object>	getModelAttributes()
long	getMvccVersion() Returns the mvcc version of this group.
java.lang.String	getName() Returns the name of this group.
java.lang.String	getName(java.util.Locale locale) Returns the localized name of this group in the language.
java.lang.String	getName(java.util.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.
java.lang.String	getName(java.lang.String languageId) Returns the localized name of this group in the language.
java.lang.String	getName(java.lang.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.
java.lang.String	getNameCurrentLanguageId()
java.lang.String	getNameCurrentValue()
java.util.Map<java.util.Locale,java.lang.String>	getNameMap() Returns a map of the locales and localized names of this group.
long	getOrganizationId()
Group	getParentGroup()
long	getParentGroupId() Returns the parent group ID of this group.
UnicodeProperties	getParentLiveGroupTypeSettingsProperties()
java.lang.String	getPathFriendlyURL(boolean privateLayout, ThemeDisplay themeDisplay)
long	getPrimaryKey() Returns the primary key of this group.
LayoutSet	getPrivateLayoutSet()
int	getPrivateLayoutsPageCount()
LayoutSet	getPublicLayoutSet()
int	getPublicLayoutsPageCount()
long	getRemoteLiveGroupId()
int	getRemoteStagingGroupCount() Returns the remote staging group count of this group.
java.lang.String	getScopeDescriptiveName(ThemeDisplay themeDisplay)
java.lang.String	getScopeLabel(ThemeDisplay themeDisplay)
java.lang.String	getScopeSimpleName(ThemeDisplay themeDisplay)
boolean	getSite() Returns the site of this group.
Group	getStagingGroup()
java.lang.String	getTreePath() Returns the tree path of this group.
int	getType() Returns the type of this group.
java.lang.String	getTypeLabel()
java.lang.String	getTypeSettings() Returns the type settings of this group.
UnicodeProperties	getTypeSettingsProperties()
java.lang.String	getTypeSettingsProperty(java.lang.String key)
java.lang.String	getUnambiguousName(java.lang.String name, java.util.Locale locale)
java.lang.String	getUuid() Returns the uuid of this group.
boolean	hasAncestor(long groupId)
boolean	hasLocalOrRemoteStagingGroup()
boolean	hasPrivateLayouts()
boolean	hasPublicLayouts()
boolean	hasRemoteStagingGroup()
boolean	hasStagingGroup()
boolean	isActive() Returns true if this group is active.
boolean	isCompany()
boolean	isCompanyStagingGroup()
boolean	isControlPanel()
boolean	isDepot()
boolean	isGuest()
boolean	isInheritContent() Returns true if this group is inherit content.
boolean	isInStagingPortlet(java.lang.String portletId)
boolean	isLayout()
boolean	isLayoutPrototype()
boolean	isLayoutSetPrototype()
boolean	isLimitedToParentSiteMembers()
boolean	isManualMembership() Returns true if this group is manual membership.
boolean	isOrganization()
boolean	isRegularSite()
boolean	isRoot()
boolean	isShowSite(PermissionChecker permissionChecker, boolean privateSite)
boolean	isSite() Returns true if this group is site.
boolean	isStaged()
boolean	isStagedPortlet(java.lang.String portletId)
boolean	isStagedRemotely()
boolean	isStagingGroup()
boolean	isUser()
boolean	isUserGroup()
boolean	isUserPersonalSite()
void	persist() Updates this model instance in the database or adds it if it does not yet exist.
void	prepareLocalizedFieldsForImport()
void	prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
void	setActive(boolean active) Sets whether this group is active.
void	setClassName(java.lang.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(java.lang.String creatorUserUuid) Sets the creator user uuid of this group.
void	setCtCollectionId(long ctCollectionId) Sets the ct collection ID of this group.
void	setDescription(java.lang.String description) Sets the description of this group.
void	setDescription(java.lang.String description, java.util.Locale locale) Sets the localized description of this group in the language.
void	setDescription(java.lang.String description, java.util.Locale locale, java.util.Locale defaultLocale) Sets the localized description of this group in the language, and sets the default locale.
void	setDescriptionCurrentLanguageId(java.lang.String languageId)
void	setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap) Sets the localized descriptions of this group from the map of locales and localized descriptions.
void	setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.util.Locale defaultLocale) Sets the localized descriptions of this group from the map of locales and localized descriptions, and sets the default locale.
void	setFriendlyURL(java.lang.String friendlyURL) Sets the friendly url of this group.
void	setGroupId(long groupId) Sets the group ID of this group.
void	setGroupKey(java.lang.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	setModelAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)
void	setMvccVersion(long mvccVersion) Sets the mvcc version of this group.
void	setName(java.lang.String name) Sets the name of this group.
void	setName(java.lang.String name, java.util.Locale locale) Sets the localized name of this group in the language.
void	setName(java.lang.String name, java.util.Locale locale, java.util.Locale defaultLocale) Sets the localized name of this group in the language, and sets the default locale.
void	setNameCurrentLanguageId(java.lang.String languageId)
void	setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap) Sets the localized names of this group from the map of locales and localized names.
void	setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.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(java.lang.String treePath) Sets the tree path of this group.
void	setType(int type) Sets the type of this group.
void	setTypeSettings(java.lang.String typeSettings) Sets the type settings of this group.
void	setTypeSettingsProperties(UnicodeProperties typeSettingsUnicodeProperties)
void	setUuid(java.lang.String uuid) Sets the uuid of this group.
void	updateTreePath(java.lang.String treePath)
protected GroupWrapper	wrap(Group group)

Methods inherited from class com.liferay.portal.kernel.model.wrapper.BaseModelWrapper

clone, compareTo, equals, getExpandoBridge, getModelClass, getModelClassName, getPrimaryKeyObj, getWrappedModel, hashCode, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toString, toUnescapedModel, toXmlString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.liferay.portal.kernel.model.BaseModel

clone, getExpandoBridge, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel, toXmlString

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

getModelClass, getModelClassName

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.liferay.portal.kernel.model.TreeModel

getPrimaryKeyObj

Methods inherited from interface com.liferay.portal.kernel.model.ModelWrapper

getWrappedModel

Constructor Detail

GroupWrapper

public GroupWrapper(Group group)

Method Detail

getModelAttributes

public java.util.Map<java.lang.String,java.lang.Object> getModelAttributes()

Specified by:

getModelAttributes in interface BaseModel<Group>

setModelAttributes

public void setModelAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)

Specified by:

setModelAttributes in interface BaseModel<Group>

buildTreePath

public java.lang.String buildTreePath()
                               throws PortalException

Specified by:

buildTreePath in interface TreeModel

Throws:

PortalException

clearStagingGroup

public void clearStagingGroup()

Specified by:

clearStagingGroup in interface Group

getActive

public boolean getActive()

Returns the active of this group.

Specified by:

getActive in interface GroupModel

Returns:

the active of this group

getAncestors

public java.util.List<Group> getAncestors()

Specified by:

getAncestors in interface Group

getAvailableLanguageIds

public java.lang.String[] getAvailableLanguageIds()

Specified by:

getAvailableLanguageIds in interface GroupModel

Specified by:

getAvailableLanguageIds in interface LocalizedModel

getChildren

public java.util.List<Group> getChildren(boolean site)

Specified by:

getChildren in interface Group

getChildrenWithLayouts

public java.util.List<Group> getChildrenWithLayouts(boolean site,
                                                    int start,
                                                    int end,
                                                    OrderByComparator<Group> orderByComparator)

Specified by:

getChildrenWithLayouts in interface Group

getChildrenWithLayoutsCount

public int getChildrenWithLayoutsCount(boolean site)

Specified by:

getChildrenWithLayoutsCount in interface Group

getClassName

public java.lang.String getClassName()

Returns the fully qualified class name of this group.

Specified by:

getClassName in interface GroupModel

Specified by:

getClassName in interface TypedModel

Returns:

the fully qualified class name of this group

getClassNameId

public long getClassNameId()

Returns the class name ID of this group.

Specified by:

getClassNameId in interface GroupModel

Specified by:

getClassNameId in interface TypedModel

Returns:

the class name ID of this group

getClassPK

public long getClassPK()

Returns the class pk of this group.

Specified by:

getClassPK in interface AttachedModel

Specified by:

getClassPK in interface GroupModel

Returns:

the class pk of this group

getCompanyId

public long getCompanyId()

Returns the company ID of this group.

Specified by:

getCompanyId in interface GroupModel

Specified by:

getCompanyId in interface ShardedModel

Returns:

the company ID of this group

getCreatorUserId

public long getCreatorUserId()

Returns the creator user ID of this group.

Specified by:

getCreatorUserId in interface GroupModel

Returns:

the creator user ID of this group

getCreatorUserUuid

public java.lang.String getCreatorUserUuid()

Returns the creator user uuid of this group.

Specified by:

getCreatorUserUuid in interface GroupModel

Returns:

the creator user uuid of this group

getCtCollectionId

public long getCtCollectionId()

Returns the ct collection ID of this group.

Specified by:

getCtCollectionId in interface CTModel<Group>

Specified by:

getCtCollectionId in interface GroupModel

Returns:

the ct collection ID of this group

getDefaultLanguageId

public java.lang.String getDefaultLanguageId()

Specified by:

getDefaultLanguageId in interface GroupModel

Specified by:

getDefaultLanguageId in interface LocalizedModel

getDefaultPrivatePlid

public long getDefaultPrivatePlid()

Specified by:

getDefaultPrivatePlid in interface Group

getDefaultPublicPlid

public long getDefaultPublicPlid()

Specified by:

getDefaultPublicPlid in interface Group

getDescendants

public java.util.List<Group> getDescendants(boolean site)

Specified by:

getDescendants in interface Group

getDescription

public java.lang.String getDescription()

Returns the description of this group.

Specified by:

getDescription in interface GroupModel

Returns:

the description of this group

getDescription

public java.lang.String getDescription(java.util.Locale locale)

Returns the localized description of this group in the language. Uses the default language if no localization exists for the requested language.

Specified by:

getDescription in interface GroupModel

Parameters:

locale - the locale of the language

Returns:

the localized description of this group

getDescription

public java.lang.String getDescription(java.util.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.

Specified by:

getDescription in interface GroupModel

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

public java.lang.String getDescription(java.lang.String languageId)

Returns the localized description of this group in the language. Uses the default language if no localization exists for the requested language.

Specified by:

getDescription in interface GroupModel

Parameters:

languageId - the ID of the language

Returns:

the localized description of this group

getDescription

public java.lang.String getDescription(java.lang.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.

Specified by:

getDescription in interface GroupModel

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

public java.lang.String getDescriptionCurrentLanguageId()

Specified by:

getDescriptionCurrentLanguageId in interface GroupModel

getDescriptionCurrentValue

public java.lang.String getDescriptionCurrentValue()

Specified by:

getDescriptionCurrentValue in interface GroupModel

getDescriptionMap

public java.util.Map<java.util.Locale,java.lang.String> getDescriptionMap()

Returns a map of the locales and localized descriptions of this group.

Specified by:

getDescriptionMap in interface GroupModel

Returns:

the locales and localized descriptions of this group

getDescriptiveName

public java.lang.String getDescriptiveName()
                                    throws PortalException

Specified by:

getDescriptiveName in interface Group

Throws:

PortalException

getDescriptiveName

public java.lang.String getDescriptiveName(java.util.Locale locale)
                                    throws PortalException

Specified by:

getDescriptiveName in interface Group

Throws:

PortalException

getDisplayURL

public java.lang.String getDisplayURL(ThemeDisplay themeDisplay)

Specified by:

getDisplayURL in interface Group

getDisplayURL

public java.lang.String getDisplayURL(ThemeDisplay themeDisplay,
                                      boolean privateLayout)

Specified by:

getDisplayURL in interface Group

getFriendlyURL

public java.lang.String getFriendlyURL()

Returns the friendly url of this group.

Specified by:

getFriendlyURL in interface GroupModel

Returns:

the friendly url of this group

getGroupId

public long getGroupId()

Returns the group ID of this group.

Specified by:

getGroupId in interface GroupModel

Returns:

the group ID of this group

getGroupKey

public java.lang.String getGroupKey()

Returns the group key of this group.

Specified by:

getGroupKey in interface GroupModel

Returns:

the group key of this group

getIconCssClass

public java.lang.String getIconCssClass()

Specified by:

getIconCssClass in interface Group

getIconURL

public java.lang.String getIconURL(ThemeDisplay themeDisplay)

Specified by:

getIconURL in interface Group

getInheritContent

public boolean getInheritContent()

Returns the inherit content of this group.

Specified by:

getInheritContent in interface GroupModel

Returns:

the inherit content of this group

getLayoutRootNodeName

public java.lang.String getLayoutRootNodeName(boolean privateLayout,
                                              java.util.Locale locale)

Specified by:

getLayoutRootNodeName in interface Group

getLiveGroup

public Group getLiveGroup()

Specified by:

getLiveGroup in interface Group

getLiveGroupId

public long getLiveGroupId()

Returns the live group ID of this group.

Specified by:

getLiveGroupId in interface GroupModel

Returns:

the live group ID of this group

getLiveParentTypeSettingsProperty

public java.lang.String getLiveParentTypeSettingsProperty(java.lang.String key)

Specified by:

getLiveParentTypeSettingsProperty in interface Group

getLogoURL

public java.lang.String getLogoURL(ThemeDisplay themeDisplay,
                                   boolean useDefault)

Specified by:

getLogoURL in interface Group

getManualMembership

public boolean getManualMembership()

Returns the manual membership of this group.

Specified by:

getManualMembership in interface GroupModel

Returns:

the manual membership of this group

getMembershipRestriction

public int getMembershipRestriction()

Returns the membership restriction of this group.

Specified by:

getMembershipRestriction in interface GroupModel

Returns:

the membership restriction of this group

getMvccVersion

public long getMvccVersion()

Returns the mvcc version of this group.

Specified by:

getMvccVersion in interface GroupModel

Specified by:

getMvccVersion in interface MVCCModel

Returns:

the mvcc version of this group

getName

public java.lang.String getName()

Returns the name of this group.

Specified by:

getName in interface GroupModel

Returns:

the name of this group

getName

public java.lang.String getName(java.util.Locale locale)

Returns the localized name of this group in the language. Uses the default language if no localization exists for the requested language.

Specified by:

getName in interface GroupModel

Parameters:

locale - the locale of the language

Returns:

the localized name of this group

getName

public java.lang.String getName(java.util.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.

Specified by:

getName in interface GroupModel

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

public java.lang.String getName(java.lang.String languageId)

Returns the localized name of this group in the language. Uses the default language if no localization exists for the requested language.

Specified by:

getName in interface GroupModel

Parameters:

languageId - the ID of the language

Returns:

the localized name of this group

getName

public java.lang.String getName(java.lang.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.

Specified by:

getName in interface GroupModel

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

public java.lang.String getNameCurrentLanguageId()

Specified by:

getNameCurrentLanguageId in interface GroupModel

getNameCurrentValue

public java.lang.String getNameCurrentValue()

Specified by:

getNameCurrentValue in interface GroupModel

getNameMap

public java.util.Map<java.util.Locale,java.lang.String> getNameMap()

Returns a map of the locales and localized names of this group.

Specified by:

getNameMap in interface GroupModel

Returns:

the locales and localized names of this group

getOrganizationId

public long getOrganizationId()

Specified by:

getOrganizationId in interface Group

getParentGroup

public Group getParentGroup()

Specified by:

getParentGroup in interface Group

getParentGroupId

public long getParentGroupId()

Returns the parent group ID of this group.

Specified by:

getParentGroupId in interface GroupModel

Returns:

the parent group ID of this group

getParentLiveGroupTypeSettingsProperties

public UnicodeProperties getParentLiveGroupTypeSettingsProperties()

Specified by:

getParentLiveGroupTypeSettingsProperties in interface Group

getPathFriendlyURL

public java.lang.String getPathFriendlyURL(boolean privateLayout,
                                           ThemeDisplay themeDisplay)

Specified by:

getPathFriendlyURL in interface Group

getPrimaryKey

public long getPrimaryKey()

Returns the primary key of this group.

Specified by:

getPrimaryKey in interface CTModel<Group>

Specified by:

getPrimaryKey in interface GroupModel

Returns:

the primary key of this group

getPrivateLayoutSet

public LayoutSet getPrivateLayoutSet()

Specified by:

getPrivateLayoutSet in interface Group

getPrivateLayoutsPageCount

public int getPrivateLayoutsPageCount()

Specified by:

getPrivateLayoutsPageCount in interface Group

getPublicLayoutSet

public LayoutSet getPublicLayoutSet()

Specified by:

getPublicLayoutSet in interface Group

getPublicLayoutsPageCount

public int getPublicLayoutsPageCount()

Specified by:

getPublicLayoutsPageCount in interface Group

getRemoteLiveGroupId

public long getRemoteLiveGroupId()

Specified by:

getRemoteLiveGroupId in interface Group

getRemoteStagingGroupCount

public int getRemoteStagingGroupCount()

Returns the remote staging group count of this group.

Specified by:

getRemoteStagingGroupCount in interface GroupModel

Returns:

the remote staging group count of this group

getScopeDescriptiveName

public java.lang.String getScopeDescriptiveName(ThemeDisplay themeDisplay)
                                         throws PortalException

Specified by:

getScopeDescriptiveName in interface Group

Throws:

PortalException

getScopeLabel

public java.lang.String getScopeLabel(ThemeDisplay themeDisplay)

Specified by:

getScopeLabel in interface Group

getScopeSimpleName

public java.lang.String getScopeSimpleName(ThemeDisplay themeDisplay)

Specified by:

getScopeSimpleName in interface Group

getSite

public boolean getSite()

Returns the site of this group.

Specified by:

getSite in interface GroupModel

Returns:

the site of this group

getStagingGroup

public Group getStagingGroup()

Specified by:

getStagingGroup in interface Group

getTreePath

public java.lang.String getTreePath()

Returns the tree path of this group.

Specified by:

getTreePath in interface GroupModel

Specified by:

getTreePath in interface TreeModel

Returns:

the tree path of this group

getType

public int getType()

Returns the type of this group.

Specified by:

getType in interface GroupModel

Returns:

the type of this group

getTypeLabel

public java.lang.String getTypeLabel()

Specified by:

getTypeLabel in interface Group

getTypeSettings

public java.lang.String getTypeSettings()

Returns the type settings of this group.

Specified by:

getTypeSettings in interface GroupModel

Returns:

the type settings of this group

getTypeSettingsProperties

public UnicodeProperties getTypeSettingsProperties()

Specified by:

getTypeSettingsProperties in interface Group

getTypeSettingsProperty

public java.lang.String getTypeSettingsProperty(java.lang.String key)

Specified by:

getTypeSettingsProperty in interface Group

getUnambiguousName

public java.lang.String getUnambiguousName(java.lang.String name,
                                           java.util.Locale locale)

Specified by:

getUnambiguousName in interface Group

getUuid

public java.lang.String getUuid()

Returns the uuid of this group.

Specified by:

getUuid in interface GroupModel

Returns:

the uuid of this group

hasAncestor

public boolean hasAncestor(long groupId)

Specified by:

hasAncestor in interface Group

hasLocalOrRemoteStagingGroup

public boolean hasLocalOrRemoteStagingGroup()

Specified by:

hasLocalOrRemoteStagingGroup in interface Group

hasPrivateLayouts

public boolean hasPrivateLayouts()

Specified by:

hasPrivateLayouts in interface Group

hasPublicLayouts

public boolean hasPublicLayouts()

Specified by:

hasPublicLayouts in interface Group

hasRemoteStagingGroup

public boolean hasRemoteStagingGroup()

Specified by:

hasRemoteStagingGroup in interface Group

hasStagingGroup

public boolean hasStagingGroup()

Specified by:

hasStagingGroup in interface Group

isActive

public boolean isActive()

Returns true if this group is active.

Specified by:

isActive in interface GroupModel

Returns:

true if this group is active; false otherwise

isCompany

public boolean isCompany()

Specified by:

isCompany in interface Group

isCompanyStagingGroup

public boolean isCompanyStagingGroup()

Specified by:

isCompanyStagingGroup in interface Group

isControlPanel

public boolean isControlPanel()

Specified by:

isControlPanel in interface Group

isDepot

public boolean isDepot()

Specified by:

isDepot in interface Group

isGuest

public boolean isGuest()

Specified by:

isGuest in interface Group

isInheritContent

public boolean isInheritContent()

Returns true if this group is inherit content.

Specified by:

isInheritContent in interface GroupModel

Returns:

true if this group is inherit content; false otherwise

isInStagingPortlet

public boolean isInStagingPortlet(java.lang.String portletId)

Specified by:

isInStagingPortlet in interface Group

isLayout

public boolean isLayout()

Specified by:

isLayout in interface Group

isLayoutPrototype

public boolean isLayoutPrototype()

Specified by:

isLayoutPrototype in interface Group

isLayoutSetPrototype

public boolean isLayoutSetPrototype()

Specified by:

isLayoutSetPrototype in interface Group

isLimitedToParentSiteMembers

public boolean isLimitedToParentSiteMembers()

Specified by:

isLimitedToParentSiteMembers in interface Group

isManualMembership

public boolean isManualMembership()

Returns true if this group is manual membership.

Specified by:

isManualMembership in interface GroupModel

Returns:

true if this group is manual membership; false otherwise

isOrganization

public boolean isOrganization()

Specified by:

isOrganization in interface Group

isRegularSite

public boolean isRegularSite()

Specified by:

isRegularSite in interface Group

isRoot

public boolean isRoot()

Specified by:

isRoot in interface Group

isShowSite

public boolean isShowSite(PermissionChecker permissionChecker,
                          boolean privateSite)
                   throws PortalException

Specified by:

isShowSite in interface Group

Throws:

PortalException

isSite

public boolean isSite()

Returns true if this group is site.

Specified by:

isSite in interface GroupModel

Returns:

true if this group is site; false otherwise

isStaged

public boolean isStaged()

Specified by:

isStaged in interface Group

isStagedPortlet

public boolean isStagedPortlet(java.lang.String portletId)

Specified by:

isStagedPortlet in interface Group

isStagedRemotely

public boolean isStagedRemotely()

Specified by:

isStagedRemotely in interface Group

isStagingGroup

public boolean isStagingGroup()

Specified by:

isStagingGroup in interface Group

isUser

public boolean isUser()

Specified by:

isUser in interface Group

isUserGroup

public boolean isUserGroup()

Specified by:

isUserGroup in interface Group

isUserPersonalSite

public boolean isUserPersonalSite()

Specified by:

isUserPersonalSite in interface Group

persist

public void persist()

Description copied from interface: PersistedModel

Updates this model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Specified by:

persist in interface PersistedModel

prepareLocalizedFieldsForImport

public void prepareLocalizedFieldsForImport()
                                     throws LocaleException

Specified by:

prepareLocalizedFieldsForImport in interface GroupModel

Specified by:

prepareLocalizedFieldsForImport in interface LocalizedModel

Throws:

LocaleException

prepareLocalizedFieldsForImport

public void prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
                                     throws LocaleException

Specified by:

prepareLocalizedFieldsForImport in interface GroupModel

Specified by:

prepareLocalizedFieldsForImport in interface LocalizedModel

Throws:

LocaleException

setActive

public void setActive(boolean active)

Sets whether this group is active.

Specified by:

setActive in interface GroupModel

Parameters:

active - the active of this group

setClassName

public void setClassName(java.lang.String className)

Specified by:

setClassName in interface GroupModel

setClassNameId

public void setClassNameId(long classNameId)

Sets the class name ID of this group.

Specified by:

setClassNameId in interface GroupModel

Specified by:

setClassNameId in interface TypedModel

Parameters:

classNameId - the class name ID of this group

setClassPK

public void setClassPK(long classPK)

Sets the class pk of this group.

Specified by:

setClassPK in interface AttachedModel

Specified by:

setClassPK in interface GroupModel

Parameters:

classPK - the class pk of this group

setCompanyId

public void setCompanyId(long companyId)

Sets the company ID of this group.

Specified by:

setCompanyId in interface GroupModel

Specified by:

setCompanyId in interface ShardedModel

Parameters:

companyId - the company ID of this group

setCreatorUserId

public void setCreatorUserId(long creatorUserId)

Sets the creator user ID of this group.

Specified by:

setCreatorUserId in interface GroupModel

Parameters:

creatorUserId - the creator user ID of this group

setCreatorUserUuid

public void setCreatorUserUuid(java.lang.String creatorUserUuid)

Sets the creator user uuid of this group.

Specified by:

setCreatorUserUuid in interface GroupModel

Parameters:

creatorUserUuid - the creator user uuid of this group

setCtCollectionId

public void setCtCollectionId(long ctCollectionId)

Sets the ct collection ID of this group.

Specified by:

setCtCollectionId in interface CTModel<Group>

Specified by:

setCtCollectionId in interface GroupModel

Parameters:

ctCollectionId - the ct collection ID of this group

setDescription

public void setDescription(java.lang.String description)

Sets the description of this group.

Specified by:

setDescription in interface GroupModel

Parameters:

description - the description of this group

setDescription

public void setDescription(java.lang.String description,
                           java.util.Locale locale)

Sets the localized description of this group in the language.

Specified by:

setDescription in interface GroupModel

Parameters:

description - the localized description of this group

locale - the locale of the language

setDescription

public void setDescription(java.lang.String description,
                           java.util.Locale locale,
                           java.util.Locale defaultLocale)

Sets the localized description of this group in the language, and sets the default locale.

Specified by:

setDescription in interface GroupModel

Parameters:

description - the localized description of this group

locale - the locale of the language

defaultLocale - the default locale

setDescriptionCurrentLanguageId

public void setDescriptionCurrentLanguageId(java.lang.String languageId)

Specified by:

setDescriptionCurrentLanguageId in interface GroupModel

setDescriptionMap

public void setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap)

Sets the localized descriptions of this group from the map of locales and localized descriptions.

Specified by:

setDescriptionMap in interface GroupModel

Parameters:

descriptionMap - the locales and localized descriptions of this group

setDescriptionMap

public void setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                              java.util.Locale defaultLocale)

Sets the localized descriptions of this group from the map of locales and localized descriptions, and sets the default locale.

Specified by:

setDescriptionMap in interface GroupModel

Parameters:

descriptionMap - the locales and localized descriptions of this group

defaultLocale - the default locale

setFriendlyURL

public void setFriendlyURL(java.lang.String friendlyURL)

Sets the friendly url of this group.

Specified by:

setFriendlyURL in interface GroupModel

Parameters:

friendlyURL - the friendly url of this group

setGroupId

public void setGroupId(long groupId)

Sets the group ID of this group.

Specified by:

setGroupId in interface GroupModel

Parameters:

groupId - the group ID of this group

setGroupKey

public void setGroupKey(java.lang.String groupKey)

Sets the group key of this group.

Specified by:

setGroupKey in interface GroupModel

Parameters:

groupKey - the group key of this group

setInheritContent

public void setInheritContent(boolean inheritContent)

Sets whether this group is inherit content.

Specified by:

setInheritContent in interface GroupModel

Parameters:

inheritContent - the inherit content of this group

setLiveGroupId

public void setLiveGroupId(long liveGroupId)

Sets the live group ID of this group.

Specified by:

setLiveGroupId in interface GroupModel

Parameters:

liveGroupId - the live group ID of this group

setManualMembership

public void setManualMembership(boolean manualMembership)

Sets whether this group is manual membership.

Specified by:

setManualMembership in interface GroupModel

Parameters:

manualMembership - the manual membership of this group

setMembershipRestriction

public void setMembershipRestriction(int membershipRestriction)

Sets the membership restriction of this group.

Specified by:

setMembershipRestriction in interface GroupModel

Parameters:

membershipRestriction - the membership restriction of this group

setMvccVersion

public void setMvccVersion(long mvccVersion)

Sets the mvcc version of this group.

Specified by:

setMvccVersion in interface GroupModel

Specified by:

setMvccVersion in interface MVCCModel

Parameters:

mvccVersion - the mvcc version of this group

setName

public void setName(java.lang.String name)

Sets the name of this group.

Specified by:

setName in interface GroupModel

Parameters:

name - the name of this group

setName

public void setName(java.lang.String name,
                    java.util.Locale locale)

Sets the localized name of this group in the language.

Specified by:

setName in interface GroupModel

Parameters:

name - the localized name of this group

locale - the locale of the language

setName

public void setName(java.lang.String name,
                    java.util.Locale locale,
                    java.util.Locale defaultLocale)

Sets the localized name of this group in the language, and sets the default locale.

Specified by:

setName in interface GroupModel

Parameters:

name - the localized name of this group

locale - the locale of the language

defaultLocale - the default locale

setNameCurrentLanguageId

public void setNameCurrentLanguageId(java.lang.String languageId)

Specified by:

setNameCurrentLanguageId in interface GroupModel

setNameMap

public void setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap)

Sets the localized names of this group from the map of locales and localized names.

Specified by:

setNameMap in interface GroupModel

Parameters:

nameMap - the locales and localized names of this group

setNameMap

public void setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap,
                       java.util.Locale defaultLocale)

Sets the localized names of this group from the map of locales and localized names, and sets the default locale.

Specified by:

setNameMap in interface GroupModel

Parameters:

nameMap - the locales and localized names of this group

defaultLocale - the default locale

setParentGroupId

public void setParentGroupId(long parentGroupId)

Sets the parent group ID of this group.

Specified by:

setParentGroupId in interface GroupModel

Parameters:

parentGroupId - the parent group ID of this group

setPrimaryKey

public void setPrimaryKey(long primaryKey)

Sets the primary key of this group.

Specified by:

setPrimaryKey in interface CTModel<Group>

Specified by:

setPrimaryKey in interface GroupModel

Parameters:

primaryKey - the primary key of this group

setRemoteStagingGroupCount

public void setRemoteStagingGroupCount(int remoteStagingGroupCount)

Sets the remote staging group count of this group.

Specified by:

setRemoteStagingGroupCount in interface GroupModel

Parameters:

remoteStagingGroupCount - the remote staging group count of this group

setSite

public void setSite(boolean site)

Sets whether this group is site.

Specified by:

setSite in interface GroupModel

Parameters:

site - the site of this group

setTreePath

public void setTreePath(java.lang.String treePath)

Sets the tree path of this group.

Specified by:

setTreePath in interface GroupModel

Parameters:

treePath - the tree path of this group

setType

public void setType(int type)

Sets the type of this group.

Specified by:

setType in interface GroupModel

Parameters:

type - the type of this group

setTypeSettings

public void setTypeSettings(java.lang.String typeSettings)

Sets the type settings of this group.

Specified by:

setTypeSettings in interface GroupModel

Parameters:

typeSettings - the type settings of this group

setTypeSettingsProperties

public void setTypeSettingsProperties(UnicodeProperties typeSettingsUnicodeProperties)

Specified by:

setTypeSettingsProperties in interface Group

setUuid

public void setUuid(java.lang.String uuid)

Sets the uuid of this group.

Specified by:

setUuid in interface GroupModel

Parameters:

uuid - the uuid of this group

updateTreePath

public void updateTreePath(java.lang.String treePath)

Specified by:

updateTreePath in interface TreeModel

getAttributeGetterFunctions

public java.util.Map<java.lang.String,java.util.function.Function<Group,java.lang.Object>> getAttributeGetterFunctions()

Specified by:

getAttributeGetterFunctions in interface BaseModel<Group>

getAttributeSetterBiConsumers

public java.util.Map<java.lang.String,java.util.function.BiConsumer<Group,java.lang.Object>> getAttributeSetterBiConsumers()

Specified by:

getAttributeSetterBiConsumers in interface BaseModel<Group>

wrap

protected GroupWrapper wrap(Group group)

Specified by:

wrap in class BaseModelWrapper<Group>