@JSON(strict=true) public class GroupImpl extends GroupBaseImpl
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.
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| Constructor and Description |
|---|
GroupImpl() |
| Modifier and Type | Method and Description |
|---|---|
void |
clearStagingGroup() |
java.util.List<com.liferay.portal.kernel.model.Group> |
getAncestors() |
java.util.List<com.liferay.portal.kernel.model.Group> |
getChildren(boolean site) |
java.util.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> orderByComparator) |
int |
getChildrenWithLayoutsCount(boolean site) |
protected long |
getDefaultPlid(boolean privateLayout) |
long |
getDefaultPrivatePlid() |
long |
getDefaultPublicPlid() |
java.util.List<com.liferay.portal.kernel.model.Group> |
getDescendants(boolean site) |
java.lang.String |
getDescriptiveName() |
java.lang.String |
getDescriptiveName(java.util.Locale locale) |
java.util.Map<java.util.Locale,java.lang.String> |
getDescriptiveNameMap() |
java.lang.String |
getDisplayURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) |
java.lang.String |
getDisplayURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay,
boolean privateLayout) |
java.lang.String |
getDisplayURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay,
boolean privateLayout,
boolean controlPanel) |
java.lang.String |
getIconCssClass() |
java.lang.String |
getIconURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) |
java.lang.String |
getLayoutRootNodeName(boolean privateLayout,
java.util.Locale locale) |
com.liferay.portal.kernel.model.Group |
getLiveGroup() |
java.lang.String |
getLiveParentTypeSettingsProperty(java.lang.String key) |
java.lang.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() |
java.lang.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() |
java.lang.String |
getScopeDescriptiveName(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) |
java.lang.String |
getScopeLabel(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) |
java.lang.String |
getScopeSimpleName(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) |
com.liferay.portal.kernel.model.Group |
getStagingGroup() |
java.lang.String |
getTypeLabel() |
java.lang.String |
getTypeSettings() |
com.liferay.portal.kernel.util.UnicodeProperties |
getTypeSettingsProperties() |
java.lang.String |
getTypeSettingsProperty(java.lang.String key) |
java.lang.String |
getUnambiguousName(java.lang.String name,
java.util.Locale locale) |
boolean |
hasAncestor(long groupId) |
boolean |
hasLocalOrRemoteStagingGroup() |
boolean |
hasPrivateLayouts() |
boolean |
hasPublicLayouts() |
boolean |
hasRemoteStagingGroup() |
boolean |
hasStagingGroup() |
boolean |
isCompany() |
boolean |
isCompanyStagingGroup() |
boolean |
isControlPanel() |
boolean |
isDepot() |
boolean |
isGuest() |
boolean |
isInStagingPortlet(java.lang.String portletId) |
boolean |
isLayout() |
boolean |
isLayoutPrototype() |
boolean |
isLayoutSetPrototype() |
boolean |
isLimitedToParentSiteMembers() |
boolean |
isOrganization() |
boolean |
isPrivateLayoutsEnabled() |
boolean |
isRegularSite() |
boolean |
isRoot() |
boolean |
isShowSite(com.liferay.portal.kernel.security.permission.PermissionChecker permissionChecker,
boolean privateSite) |
boolean |
isStaged() |
boolean |
isStagedPortlet(java.lang.String portletId) |
boolean |
isStagedRemotely() |
boolean |
isStagingGroup() |
boolean |
isUser() |
boolean |
isUserGroup() |
boolean |
isUserPersonalSite() |
void |
setTypeSettings(java.lang.String typeSettings) |
void |
setTypeSettingsProperties(com.liferay.portal.kernel.util.UnicodeProperties typeSettingsUnicodeProperties) |
buildTreePath, persist, updateTreePathclone, cloneWithOriginalValues, compareTo, equals, getActive, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getAvailableLanguageIds, getClassName, getClassNameId, getClassPK, getColumnBitmask, getColumnBitmask, getColumnOriginalValue, getColumnValue, getCompanyId, getCreatorUserId, getCreatorUserUuid, getCtCollectionId, getDefaultLanguageId, getDescription, getDescription, getDescription, getDescription, getDescription, getDescriptionCurrentLanguageId, getDescriptionCurrentValue, getDescriptionMap, getExpandoBridge, getFriendlyURL, getGroupId, getGroupKey, getInheritContent, getLiveGroupId, getManualMembership, getMembershipRestriction, getModelAttributes, getModelClass, getModelClassName, getModifiedDate, 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, hasSetModifiedDate, isActive, isEntityCacheEnabled, isFinderCacheEnabled, isInheritContent, isManualMembership, isSite, prepareLocalizedFieldsForImport, prepareLocalizedFieldsForImport, resetOriginalValues, setActive, setClassName, setClassNameId, setClassPK, setCompanyId, setCreatorUserId, setCreatorUserUuid, setCtCollectionId, setDescription, setDescription, setDescription, setDescriptionCurrentLanguageId, setDescriptionMap, setDescriptionMap, setExpandoBridgeAttributes, setFriendlyURL, setGroupId, setGroupKey, setInheritContent, setLiveGroupId, setManualMembership, setMembershipRestriction, setModelAttributes, setModifiedDate, setMvccVersion, setName, setName, setName, setNameCurrentLanguageId, setNameMap, setNameMap, setParentGroupId, setPrimaryKey, setPrimaryKeyObj, setRemoteStagingGroupCount, setSite, setTreePath, setType, setUuid, toCacheModel, toEscapedModel, toStringgetLocale, isCachedModel, isEscapedModel, isNew, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setNew, toUnescapedModelfinalize, getClass, notify, notifyAll, wait, wait, waitcloneWithOriginalValues, getActive, getAvailableLanguageIds, getClassName, getClassNameId, getClassPK, getCompanyId, getCreatorUserId, getCreatorUserUuid, getCtCollectionId, getDefaultLanguageId, getDescription, getDescription, getDescription, getDescription, getDescription, getDescriptionCurrentLanguageId, getDescriptionCurrentValue, getDescriptionMap, getFriendlyURL, getGroupId, getGroupKey, getInheritContent, getLiveGroupId, getManualMembership, getMembershipRestriction, getModifiedDate, getMvccVersion, getName, getName, getName, getName, getName, getNameCurrentLanguageId, getNameCurrentValue, getNameMap, getParentGroupId, getPrimaryKey, getRemoteStagingGroupCount, getSite, getTreePath, getType, getUuid, isActive, isInheritContent, isManualMembership, isSite, prepareLocalizedFieldsForImport, prepareLocalizedFieldsForImport, setActive, setClassName, setClassNameId, setClassPK, setCompanyId, setCreatorUserId, setCreatorUserUuid, setCtCollectionId, setDescription, setDescription, setDescription, setDescriptionCurrentLanguageId, setDescriptionMap, setDescriptionMap, setFriendlyURL, setGroupId, setGroupKey, setInheritContent, setLiveGroupId, setManualMembership, setMembershipRestriction, setModifiedDate, setMvccVersion, setName, setName, setName, setNameCurrentLanguageId, setNameMap, setNameMap, setParentGroupId, setPrimaryKey, setRemoteStagingGroupCount, setSite, setTreePath, setType, setUuid, toXmlStringclone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModelpublic void clearStagingGroup()
public java.util.List<com.liferay.portal.kernel.model.Group> getAncestors()
public java.util.List<com.liferay.portal.kernel.model.Group> getChildren(boolean site)
public java.util.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> orderByComparator)
public int getChildrenWithLayoutsCount(boolean site)
public long getDefaultPrivatePlid()
public long getDefaultPublicPlid()
public java.util.List<com.liferay.portal.kernel.model.Group> getDescendants(boolean site)
@JSON
public java.lang.String getDescriptiveName()
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalExceptionpublic java.lang.String getDescriptiveName(java.util.Locale locale)
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalExceptionpublic java.util.Map<java.util.Locale,java.lang.String> getDescriptiveNameMap()
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalExceptionpublic java.lang.String getDisplayURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
public java.lang.String getDisplayURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay,
boolean privateLayout)
public java.lang.String getDisplayURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay,
boolean privateLayout,
boolean controlPanel)
public java.lang.String getIconCssClass()
public java.lang.String getIconURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
public java.lang.String getLayoutRootNodeName(boolean privateLayout,
java.util.Locale locale)
public com.liferay.portal.kernel.model.Group getLiveGroup()
public java.lang.String getLiveParentTypeSettingsProperty(java.lang.String key)
public java.lang.String getLogoURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay,
boolean useDefault)
public long getOrganizationId()
public com.liferay.portal.kernel.model.Group getParentGroup()
public com.liferay.portal.kernel.util.UnicodeProperties getParentLiveGroupTypeSettingsProperties()
public java.lang.String getPathFriendlyURL(boolean privateLayout,
com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
public com.liferay.portal.kernel.model.LayoutSet getPrivateLayoutSet()
public int getPrivateLayoutsPageCount()
public com.liferay.portal.kernel.model.LayoutSet getPublicLayoutSet()
public int getPublicLayoutsPageCount()
public long getRemoteLiveGroupId()
public java.lang.String getScopeDescriptiveName(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalExceptionpublic java.lang.String getScopeLabel(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
public java.lang.String getScopeSimpleName(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
public com.liferay.portal.kernel.model.Group getStagingGroup()
public java.lang.String getTypeLabel()
public java.lang.String getTypeSettings()
getTypeSettings in interface com.liferay.portal.kernel.model.GroupModelgetTypeSettings in class GroupModelImplpublic com.liferay.portal.kernel.util.UnicodeProperties getTypeSettingsProperties()
public java.lang.String getTypeSettingsProperty(java.lang.String key)
public java.lang.String getUnambiguousName(java.lang.String name,
java.util.Locale locale)
public boolean hasAncestor(long groupId)
public boolean hasLocalOrRemoteStagingGroup()
public boolean hasPrivateLayouts()
public boolean hasPublicLayouts()
public boolean hasRemoteStagingGroup()
public boolean hasStagingGroup()
public boolean isCompany()
public boolean isCompanyStagingGroup()
public boolean isControlPanel()
public boolean isDepot()
public boolean isGuest()
public boolean isInStagingPortlet(java.lang.String portletId)
public boolean isLayout()
public boolean isLayoutPrototype()
public boolean isLayoutSetPrototype()
public boolean isLimitedToParentSiteMembers()
public boolean isOrganization()
public boolean isPrivateLayoutsEnabled()
public boolean isRegularSite()
public boolean isRoot()
public boolean isShowSite(com.liferay.portal.kernel.security.permission.PermissionChecker permissionChecker,
boolean privateSite)
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalExceptionpublic boolean isStaged()
public boolean isStagedPortlet(java.lang.String portletId)
public boolean isStagedRemotely()
public boolean isStagingGroup()
public boolean isUser()
public boolean isUserGroup()
public boolean isUserPersonalSite()
public void setTypeSettings(java.lang.String typeSettings)
setTypeSettings in interface com.liferay.portal.kernel.model.GroupModelsetTypeSettings in class GroupModelImplpublic void setTypeSettingsProperties(com.liferay.portal.kernel.util.UnicodeProperties typeSettingsUnicodeProperties)
protected long getDefaultPlid(boolean privateLayout)