com.liferay.portal.model.impl

Class GroupImpl

Object

com.liferay.portal.kernel.model.impl.BaseModelImpl<com.liferay.portal.kernel.model.Group>

com.liferay.portal.model.impl.GroupModelImpl

com.liferay.portal.model.impl.GroupBaseImpl

com.liferay.portal.model.impl.GroupImpl

All Implemented Interfaces:

com.liferay.portal.kernel.model.AttachedModel, com.liferay.portal.kernel.model.BaseModel<com.liferay.portal.kernel.model.Group>, com.liferay.portal.kernel.model.ClassedModel, com.liferay.portal.kernel.model.Group, com.liferay.portal.kernel.model.GroupModel, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.PersistedModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.TreeModel, com.liferay.portal.kernel.model.TypedModel, Serializable, Cloneable, Comparable<com.liferay.portal.kernel.model.Group>

Direct Known Subclasses:

StagedGroupImpl

@JSON(strict=true)
public class GroupImpl
extends GroupBaseImpl

Represents either a site or a generic resource container.

Groups are most used in Liferay as a resource container for permissioning and content scoping purposes. For instance, an site is group, meaning that it can contain layouts, web content, wiki entries, etc. However, a single layout can also be a group containing its own unique set of resources. An example of this would be a site that has several distinct wikis on different layouts. Each of these layouts would have its own group, and all of the nodes in the wiki for a certain layout would be associated with that layout's group. This allows users to be given different permissions on each of the wikis, even though they are all within the same site. In addition to sites and layouts, users and organizations are also groups.

Groups also have a second, partially conflicting purpose in Liferay. For legacy reasons, groups are also the model used to represent sites (known as communities before Liferay v6.1). Confusion may arise from the fact that a site group is both the resource container and the site itself, whereas a layout or organization would have both a primary model and an associated group.

Author:

Brian Wing Shun Chan

See Also:

Serialized Form

Field Summary

Fields inherited from class com.liferay.portal.model.impl.GroupModelImpl

ACTIVE_COLUMN_BITMASK, CLASSNAMEID_COLUMN_BITMASK, CLASSPK_COLUMN_BITMASK, COLUMN_BITMASK_ENABLED, COMPANYID_COLUMN_BITMASK, DATA_SOURCE, ENTITY_CACHE_ENABLED, FINDER_CACHE_ENABLED, FINDER_CACHE_ENABLED_GROUPS_ORGS, FINDER_CACHE_ENABLED_GROUPS_ROLES, FINDER_CACHE_ENABLED_GROUPS_USERGROUPS, FINDER_CACHE_ENABLED_USERS_GROUPS, FRIENDLYURL_COLUMN_BITMASK, GROUPID_COLUMN_BITMASK, GROUPKEY_COLUMN_BITMASK, INHERITCONTENT_COLUMN_BITMASK, LIVEGROUPID_COLUMN_BITMASK, LOCK_EXPIRATION_TIME, MAPPING_TABLE_GROUPS_ORGS_COLUMNS, MAPPING_TABLE_GROUPS_ORGS_NAME, MAPPING_TABLE_GROUPS_ORGS_SQL_CREATE, MAPPING_TABLE_GROUPS_ROLES_COLUMNS, MAPPING_TABLE_GROUPS_ROLES_NAME, MAPPING_TABLE_GROUPS_ROLES_SQL_CREATE, MAPPING_TABLE_GROUPS_USERGROUPS_COLUMNS, MAPPING_TABLE_GROUPS_USERGROUPS_NAME, MAPPING_TABLE_GROUPS_USERGROUPS_SQL_CREATE, MAPPING_TABLE_USERS_GROUPS_COLUMNS, MAPPING_TABLE_USERS_GROUPS_NAME, MAPPING_TABLE_USERS_GROUPS_SQL_CREATE, NAME_COLUMN_BITMASK, ORDER_BY_JPQL, ORDER_BY_SQL, PARENTGROUPID_COLUMN_BITMASK, SESSION_FACTORY, SITE_COLUMN_BITMASK, TABLE_COLUMNS, TABLE_COLUMNS_MAP, TABLE_NAME, TABLE_SQL_CREATE, TABLE_SQL_DROP, TREEPATH_COLUMN_BITMASK, TX_MANAGER, TYPE_COLUMN_BITMASK, UUID_COLUMN_BITMASK

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

GROUP_ID_ACCESSOR

Constructor Summary

Constructors

Constructor and Description
GroupImpl()

Method Summary

Modifier and Type	Method and Description
void	clearStagingGroup()
List<com.liferay.portal.kernel.model.Group>	getAncestors()
List<com.liferay.portal.kernel.model.Group>	getChildren(boolean site)
List<com.liferay.portal.kernel.model.Group>	getChildrenWithLayouts(boolean site, int start, int end) Deprecated. As of Wilberforce (7.0.x), replaced by getChildrenWithLayouts(boolean, int, int, OrderByComparator)
List<com.liferay.portal.kernel.model.Group>	getChildrenWithLayouts(boolean site, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Group> obc)
int	getChildrenWithLayoutsCount(boolean site)
protected long	getDefaultPlid(boolean privateLayout)
long	getDefaultPrivatePlid()
long	getDefaultPublicPlid()
List<com.liferay.portal.kernel.model.Group>	getDescendants(boolean site)
String	getDescriptiveName()
String	getDescriptiveName(Locale locale)
String	getDisplayURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
String	getDisplayURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay, boolean privateLayout)
String	getIconCssClass()
String	getIconURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
String	getLayoutRootNodeName(boolean privateLayout, Locale locale)
com.liferay.portal.kernel.model.Group	getLiveGroup()
String	getLiveParentTypeSettingsProperty(String key)
String	getLogoURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay, boolean useDefault)
long	getOrganizationId()
com.liferay.portal.kernel.model.Group	getParentGroup()
com.liferay.portal.kernel.util.UnicodeProperties	getParentLiveGroupTypeSettingsProperties()
String	getPathFriendlyURL(boolean privateLayout, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
com.liferay.portal.kernel.model.LayoutSet	getPrivateLayoutSet()
int	getPrivateLayoutsPageCount()
com.liferay.portal.kernel.model.LayoutSet	getPublicLayoutSet()
int	getPublicLayoutsPageCount()
long	getRemoteLiveGroupId()
String	getScopeDescriptiveName(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
String	getScopeLabel(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
com.liferay.portal.kernel.model.Group	getStagingGroup()
String	getTypeLabel()
String	getTypeSettings()
com.liferay.portal.kernel.util.UnicodeProperties	getTypeSettingsProperties()
String	getTypeSettingsProperty(String key)
String	getUnambiguousName(String name, Locale locale)
boolean	hasAncestor(long groupId)
boolean	hasLocalOrRemoteStagingGroup()
boolean	hasPrivateLayouts()
boolean	hasPublicLayouts()
boolean	hasRemoteStagingGroup()
boolean	hasStagingGroup()
boolean	isChild(long groupId) Deprecated. As of Wilberforce (7.0.x), replaced by hasAncestor(long)
boolean	isCompany()
boolean	isCompanyStagingGroup()
boolean	isControlPanel()
boolean	isGuest()
boolean	isInStagingPortlet(String portletId)
boolean	isLayout()
boolean	isLayoutPrototype()
boolean	isLayoutSetPrototype()
boolean	isLimitedToParentSiteMembers()
boolean	isOrganization()
boolean	isRegularSite()
boolean	isRoot()
boolean	isShowSite(com.liferay.portal.kernel.security.permission.PermissionChecker permissionChecker, boolean privateSite)
boolean	isStaged()
boolean	isStagedPortlet(String portletId)
boolean	isStagedRemotely()
boolean	isStagingGroup()
boolean	isUser()
boolean	isUserGroup()
boolean	isUserPersonalSite()
void	setTypeSettings(String typeSettings)
void	setTypeSettingsProperties(com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties)

Methods inherited from class com.liferay.portal.model.impl.GroupBaseImpl

buildTreePath, persist, updateTreePath

Methods inherited from class com.liferay.portal.model.impl.GroupModelImpl

clone, compareTo, equals, getActive, getAvailableLanguageIds, getClassName, getClassNameId, getClassPK, getColumnBitmask, getCompanyId, getCreatorUserId, getCreatorUserUuid, getDefaultLanguageId, getDescription, getDescription, getDescription, getDescription, getDescription, getDescriptionCurrentLanguageId, getDescriptionCurrentValue, getDescriptionMap, getExpandoBridge, getFriendlyURL, getGroupId, getGroupKey, getInheritContent, getLiveGroupId, getManualMembership, getMembershipRestriction, getModelAttributes, getModelClass, getModelClassName, getMvccVersion, getName, getName, getName, getName, getName, getNameCurrentLanguageId, getNameCurrentValue, getNameMap, getOriginalActive, getOriginalClassNameId, getOriginalClassPK, getOriginalCompanyId, getOriginalFriendlyURL, getOriginalGroupId, getOriginalGroupKey, getOriginalInheritContent, getOriginalLiveGroupId, getOriginalName, getOriginalParentGroupId, getOriginalSite, getOriginalTreePath, getOriginalType, getOriginalUuid, getParentGroupId, getPrimaryKey, getPrimaryKeyObj, getRemoteStagingGroupCount, getSite, getTreePath, getType, getUuid, hashCode, isActive, isEntityCacheEnabled, isFinderCacheEnabled, isInheritContent, isManualMembership, isSite, prepareLocalizedFieldsForImport, prepareLocalizedFieldsForImport, resetOriginalValues, setActive, setClassName, setClassNameId, setClassPK, setCompanyId, setCreatorUserId, setCreatorUserUuid, setDescription, setDescription, setDescription, setDescriptionCurrentLanguageId, setDescriptionMap, setDescriptionMap, setExpandoBridgeAttributes, setFriendlyURL, setGroupId, setGroupKey, setInheritContent, setLiveGroupId, setManualMembership, setMembershipRestriction, setModelAttributes, setMvccVersion, setName, setName, setName, setNameCurrentLanguageId, setNameMap, setNameMap, setParentGroupId, setPrimaryKey, setPrimaryKeyObj, setRemoteStagingGroupCount, setSite, setTreePath, setType, setUuid, toCacheModel, toEscapedModel, toModel, toModels, toString, toXmlString

Methods inherited from class com.liferay.portal.kernel.model.impl.BaseModelImpl

getLocale, isCachedModel, isEscapedModel, isNew, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, toUnescapedModel

Methods inherited from class Object

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

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

clone, compareTo, getActive, getAvailableLanguageIds, getClassName, getClassNameId, getClassPK, getCompanyId, getCreatorUserId, getCreatorUserUuid, getDefaultLanguageId, getDescription, getDescription, getDescription, getDescription, getDescription, getDescriptionCurrentLanguageId, getDescriptionCurrentValue, getDescriptionMap, getExpandoBridge, getFriendlyURL, getGroupId, getGroupKey, getInheritContent, getLiveGroupId, getManualMembership, getMembershipRestriction, getMvccVersion, getName, getName, getName, getName, getName, getNameCurrentLanguageId, getNameCurrentValue, getNameMap, getParentGroupId, getPrimaryKey, getPrimaryKeyObj, getRemoteStagingGroupCount, getSite, getTreePath, getType, getUuid, hashCode, isActive, isCachedModel, isEscapedModel, isInheritContent, isManualMembership, isNew, isSite, prepareLocalizedFieldsForImport, prepareLocalizedFieldsForImport, setActive, setCachedModel, setClassName, setClassNameId, setClassPK, setCompanyId, setCreatorUserId, setCreatorUserUuid, setDescription, setDescription, setDescription, setDescriptionCurrentLanguageId, setDescriptionMap, setDescriptionMap, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setFriendlyURL, setGroupId, setGroupKey, setInheritContent, setLiveGroupId, setManualMembership, setMembershipRestriction, setMvccVersion, setName, setName, setName, setNameCurrentLanguageId, setNameMap, setNameMap, setNew, setParentGroupId, setPrimaryKey, setPrimaryKeyObj, setRemoteStagingGroupCount, setSite, setTreePath, setType, setUuid, toCacheModel, toEscapedModel, toString, toUnescapedModel, toXmlString

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

getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributes

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

getModelClass, getModelClassName

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

getPrimaryKeyObj, getTreePath

Constructor Detail

GroupImpl

public GroupImpl()

Method Detail

clearStagingGroup

public void clearStagingGroup()

getAncestors

public List<com.liferay.portal.kernel.model.Group> getAncestors()
                                                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getChildren

public List<com.liferay.portal.kernel.model.Group> getChildren(boolean site)

getChildrenWithLayouts

@Deprecated
public List<com.liferay.portal.kernel.model.Group> getChildrenWithLayouts(boolean site,
                                                                                      int start,
                                                                                      int end)

Deprecated. As of Wilberforce (7.0.x), replaced by getChildrenWithLayouts(boolean, int, int, OrderByComparator)

getChildrenWithLayouts

public List<com.liferay.portal.kernel.model.Group> getChildrenWithLayouts(boolean site,
                                                                          int start,
                                                                          int end,
                                                                          com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Group> obc)

getChildrenWithLayoutsCount

public int getChildrenWithLayoutsCount(boolean site)

getDefaultPrivatePlid

public long getDefaultPrivatePlid()

getDefaultPublicPlid

public long getDefaultPublicPlid()

getDescendants

public List<com.liferay.portal.kernel.model.Group> getDescendants(boolean site)

getDescriptiveName

@JSON
public String getDescriptiveName()
                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getDescriptiveName

public String getDescriptiveName(Locale locale)
                          throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getDisplayURL

public String getDisplayURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)

getDisplayURL

public String getDisplayURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay,
                            boolean privateLayout)

getIconCssClass

public String getIconCssClass()

getIconURL

public String getIconURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)

getLayoutRootNodeName

public String getLayoutRootNodeName(boolean privateLayout,
                                    Locale locale)

getLiveGroup

public com.liferay.portal.kernel.model.Group getLiveGroup()

getLiveParentTypeSettingsProperty

public String getLiveParentTypeSettingsProperty(String key)

getLogoURL

public String getLogoURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay,
                         boolean useDefault)

getOrganizationId

public long getOrganizationId()

getParentGroup

public com.liferay.portal.kernel.model.Group getParentGroup()
                                                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getParentLiveGroupTypeSettingsProperties

public com.liferay.portal.kernel.util.UnicodeProperties getParentLiveGroupTypeSettingsProperties()

getPathFriendlyURL

public String getPathFriendlyURL(boolean privateLayout,
                                 com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)

getPrivateLayoutSet

public com.liferay.portal.kernel.model.LayoutSet getPrivateLayoutSet()

getPrivateLayoutsPageCount

public int getPrivateLayoutsPageCount()

getPublicLayoutSet

public com.liferay.portal.kernel.model.LayoutSet getPublicLayoutSet()

getPublicLayoutsPageCount

public int getPublicLayoutsPageCount()

getRemoteLiveGroupId

public long getRemoteLiveGroupId()

getScopeDescriptiveName

public String getScopeDescriptiveName(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
                               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getScopeLabel

public String getScopeLabel(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)

getStagingGroup

public com.liferay.portal.kernel.model.Group getStagingGroup()

getTypeLabel

public String getTypeLabel()

getTypeSettings

public String getTypeSettings()

Specified by:

getTypeSettings in interface com.liferay.portal.kernel.model.GroupModel

Overrides:

getTypeSettings in class GroupModelImpl

getTypeSettingsProperties

public com.liferay.portal.kernel.util.UnicodeProperties getTypeSettingsProperties()

getTypeSettingsProperty

public String getTypeSettingsProperty(String key)

getUnambiguousName

public String getUnambiguousName(String name,
                                 Locale locale)

hasAncestor

public boolean hasAncestor(long groupId)

hasLocalOrRemoteStagingGroup

public boolean hasLocalOrRemoteStagingGroup()

hasPrivateLayouts

public boolean hasPrivateLayouts()

hasPublicLayouts

public boolean hasPublicLayouts()

hasRemoteStagingGroup

public boolean hasRemoteStagingGroup()

hasStagingGroup

public boolean hasStagingGroup()

isChild

@Deprecated
public boolean isChild(long groupId)

Deprecated. As of Wilberforce (7.0.x), replaced by hasAncestor(long)

isCompany

public boolean isCompany()

isCompanyStagingGroup

public boolean isCompanyStagingGroup()

isControlPanel

public boolean isControlPanel()

isGuest

public boolean isGuest()

isInStagingPortlet

public boolean isInStagingPortlet(String portletId)

isLayout

public boolean isLayout()

isLayoutPrototype

public boolean isLayoutPrototype()

isLayoutSetPrototype

public boolean isLayoutSetPrototype()

isLimitedToParentSiteMembers

public boolean isLimitedToParentSiteMembers()

isOrganization

public boolean isOrganization()

isRegularSite

public boolean isRegularSite()

isRoot

public boolean isRoot()

isShowSite

public boolean isShowSite(com.liferay.portal.kernel.security.permission.PermissionChecker permissionChecker,
                          boolean privateSite)
                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

isStaged

public boolean isStaged()

isStagedPortlet

public boolean isStagedPortlet(String portletId)

isStagedRemotely

public boolean isStagedRemotely()

isStagingGroup

public boolean isStagingGroup()

isUser

public boolean isUser()

isUserGroup

public boolean isUserGroup()

isUserPersonalSite

public boolean isUserPersonalSite()

setTypeSettings

public void setTypeSettings(String typeSettings)

Specified by:

setTypeSettings in interface com.liferay.portal.kernel.model.GroupModel

Overrides:

setTypeSettings in class GroupModelImpl

setTypeSettingsProperties

public void setTypeSettingsProperties(com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties)

getDefaultPlid

protected long getDefaultPlid(boolean privateLayout)