Liferay 6.1.2-ce-ga3

com.liferay.portal.model.impl
Class GroupImpl

java.lang.Object
  extended by com.liferay.portal.model.impl.BaseModelImpl<Group>
      extended by com.liferay.portal.model.impl.GroupModelImpl
          extended by com.liferay.portal.model.impl.GroupBaseImpl
              extended by com.liferay.portal.model.impl.GroupImpl
All Implemented Interfaces:
AttachedModel, BaseModel<Group>, ClassedModel, Group, GroupModel, PersistedModel, Serializable, Cloneable, Comparable<Group>

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.

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_PERMISSIONS, FINDER_CACHE_ENABLED_GROUPS_ROLES, FINDER_CACHE_ENABLED_GROUPS_USERGROUPS, FINDER_CACHE_ENABLED_USERS_GROUPS, FRIENDLYURL_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_PERMISSIONS_COLUMNS, MAPPING_TABLE_GROUPS_PERMISSIONS_NAME, MAPPING_TABLE_GROUPS_PERMISSIONS_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, SESSION_FACTORY, TABLE_COLUMNS, TABLE_NAME, TABLE_SQL_CREATE, TABLE_SQL_DROP, TX_MANAGER, TYPE_COLUMN_BITMASK
 
Constructor Summary
GroupImpl()
           
 
Method Summary
protected  long getDefaultPlid(boolean privateLayout)
           
 long getDefaultPrivatePlid()
           
 long getDefaultPublicPlid()
           
 String getDescriptiveName()
           
 String getDescriptiveName(Locale locale)
           
 Group getLiveGroup()
           
 long getOrganizationId()
           
 Group getParentGroup()
           
 String getPathFriendlyURL(boolean privateLayout, ThemeDisplay themeDisplay)
           
 LayoutSet getPrivateLayoutSet()
           
 int getPrivateLayoutsPageCount()
           
 LayoutSet getPublicLayoutSet()
           
 int getPublicLayoutsPageCount()
           
 Group getStagingGroup()
           
 String getTypeLabel()
           
 String getTypeSettings()
          Returns the type settings of this group.
 UnicodeProperties getTypeSettingsProperties()
           
 String getTypeSettingsProperty(String key)
           
protected  boolean hasClassName(Class<?> clazz)
           
 boolean hasPrivateLayouts()
           
 boolean hasPublicLayouts()
           
 boolean hasStagingGroup()
           
 boolean isCommunity()
          Deprecated. As of 6.1.0, renamed to isRegularSite()
 boolean isCompany()
           
 boolean isControlPanel()
           
 boolean isGuest()
           
 boolean isInStagingPortlet(String portletId)
           
 boolean isLayout()
           
 boolean isLayoutPrototype()
           
 boolean isLayoutSetPrototype()
           
 boolean isOrganization()
           
 boolean isRegularSite()
           
 boolean isShowSite(PermissionChecker permissionChecker, boolean privateSite)
           
 boolean isStaged()
           
 boolean isStagedPortlet(String portletId)
           
 boolean isStagedRemotely()
           
 boolean isStagingGroup()
           
 boolean isUser()
           
 boolean isUserGroup()
           
 boolean isUserPersonalSite()
           
 void setTypeSettings(String typeSettings)
          Sets the type settings of this group.
 void setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)
           
 
Methods inherited from class com.liferay.portal.model.impl.GroupBaseImpl
persist
 
Methods inherited from class com.liferay.portal.model.impl.GroupModelImpl
clone, compareTo, equals, getActive, getClassName, getClassNameId, getClassPK, getColumnBitmask, getCompanyId, getCreatorUserId, getCreatorUserUuid, getDescription, getExpandoBridge, getFriendlyURL, getGroupId, getLiveGroupId, getModelAttributes, getModelClass, getModelClassName, getName, getOriginalActive, getOriginalClassNameId, getOriginalClassPK, getOriginalCompanyId, getOriginalFriendlyURL, getOriginalLiveGroupId, getOriginalName, getOriginalType, getParentGroupId, getPrimaryKey, getPrimaryKeyObj, getSite, getType, hashCode, isActive, isSite, resetOriginalValues, setActive, setClassName, setClassNameId, setClassPK, setCompanyId, setCreatorUserId, setCreatorUserUuid, setDescription, setExpandoBridgeAttributes, setFriendlyURL, setGroupId, setLiveGroupId, setModelAttributes, setName, setParentGroupId, setPrimaryKey, setPrimaryKeyObj, setSite, setType, toCacheModel, toEscapedModel, toModel, toModels, toString, toUnescapedModel, toXmlString
 
Methods inherited from class com.liferay.portal.model.impl.BaseModelImpl
getLocale, isCachedModel, isEscapedModel, isNew, setCachedModel, setNew
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.liferay.portal.model.GroupModel
clone, compareTo, getActive, getClassName, getClassNameId, getClassPK, getCompanyId, getCreatorUserId, getCreatorUserUuid, getDescription, getExpandoBridge, getFriendlyURL, getGroupId, getLiveGroupId, getName, getParentGroupId, getPrimaryKey, getPrimaryKeyObj, getSite, getType, hashCode, isActive, isCachedModel, isEscapedModel, isNew, isSite, setActive, setCachedModel, setClassName, setClassNameId, setClassPK, setCompanyId, setCreatorUserId, setCreatorUserUuid, setDescription, setExpandoBridgeAttributes, setFriendlyURL, setGroupId, setLiveGroupId, setName, setNew, setParentGroupId, setPrimaryKey, setPrimaryKeyObj, setSite, setType, toCacheModel, toEscapedModel, toString, toUnescapedModel, toXmlString
 
Methods inherited from interface com.liferay.portal.model.BaseModel
getModelAttributes, resetOriginalValues, setModelAttributes
 
Methods inherited from interface com.liferay.portal.model.ClassedModel
getModelClass, getModelClassName
 

Constructor Detail

GroupImpl

public GroupImpl()
Method Detail

getDefaultPrivatePlid

public long getDefaultPrivatePlid()

getDefaultPublicPlid

public long getDefaultPublicPlid()

getDescriptiveName

public String getDescriptiveName()
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getDescriptiveName

public String getDescriptiveName(Locale locale)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getLiveGroup

public Group getLiveGroup()

getOrganizationId

public long getOrganizationId()

getParentGroup

public Group getParentGroup()
                     throws PortalException,
                            SystemException
Throws:
PortalException
SystemException

getPathFriendlyURL

public String getPathFriendlyURL(boolean privateLayout,
                                 ThemeDisplay themeDisplay)

getPrivateLayoutSet

public LayoutSet getPrivateLayoutSet()

getPrivateLayoutsPageCount

public int getPrivateLayoutsPageCount()

getPublicLayoutSet

public LayoutSet getPublicLayoutSet()

getPublicLayoutsPageCount

public int getPublicLayoutsPageCount()

getStagingGroup

public Group getStagingGroup()

getTypeLabel

public String getTypeLabel()

getTypeSettings

public String getTypeSettings()
Description copied from interface: GroupModel
Returns the type settings of this group.

Specified by:
getTypeSettings in interface Group
Specified by:
getTypeSettings in interface GroupModel
Overrides:
getTypeSettings in class GroupModelImpl
Returns:
the type settings of this group

getTypeSettingsProperties

public UnicodeProperties getTypeSettingsProperties()

getTypeSettingsProperty

public String getTypeSettingsProperty(String key)

hasPrivateLayouts

public boolean hasPrivateLayouts()

hasPublicLayouts

public boolean hasPublicLayouts()

hasStagingGroup

public boolean hasStagingGroup()

isCommunity

public boolean isCommunity()
Deprecated. As of 6.1.0, renamed to isRegularSite()


isCompany

public boolean isCompany()

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()

isOrganization

public boolean isOrganization()

isRegularSite

public boolean isRegularSite()

isShowSite

public boolean isShowSite(PermissionChecker permissionChecker,
                          boolean privateSite)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

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)
Description copied from interface: GroupModel
Sets the type settings of this group.

Specified by:
setTypeSettings in interface Group
Specified by:
setTypeSettings in interface GroupModel
Overrides:
setTypeSettings in class GroupModelImpl
Parameters:
typeSettings - the type settings of this group

setTypeSettingsProperties

public void setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)

getDefaultPlid

protected long getDefaultPlid(boolean privateLayout)

hasClassName

protected boolean hasClassName(Class<?> clazz)

Liferay 6.1.2-ce-ga3