com.liferay.portal.model
Interface Group

All Superinterfaces:

AttachedModel, BaseModel<Group>, ClassedModel, java.lang.Cloneable, java.lang.Comparable<Group>, GroupModel, PersistedModel, java.io.Serializable, TreeModel, TypedModel

All Known Implementing Classes:

GroupWrapper

@ProviderType
public interface Group
extends GroupModel, PersistedModel, TreeModel

The extended model interface for the Group service. Represents a row in the "Group_" database table, with each column mapped to a property of this class.

Author:

Brian Wing Shun Chan

See Also:

GroupModel, GroupImpl, GroupModelImpl

Generated:

Method Summary

void	clearStagingGroup()
java.util.List<Group>	getAncestors()
java.util.List<Group>	getChildren(boolean site)
java.util.List<Group>	getChildrenWithLayouts(boolean site, int start, int end)
int	getChildrenWithLayoutsCount(boolean site)
long	getDefaultPrivatePlid()
long	getDefaultPublicPlid()
java.lang.String	getDescriptiveName()
java.lang.String	getDescriptiveName(java.util.Locale locale)
java.lang.String	getIconURL(ThemeDisplay themeDisplay)
java.lang.String	getLayoutRootNodeName(boolean privateLayout, java.util.Locale locale)
Group	getLiveGroup()
java.lang.String	getLiveParentTypeSettingsProperty(java.lang.String key)
long	getOrganizationId()
Group	getParentGroup()
UnicodeProperties	getParentLiveGroupTypeSettingsProperties()
java.lang.String	getPathFriendlyURL(boolean privateLayout, ThemeDisplay themeDisplay)
LayoutSet	getPrivateLayoutSet()
int	getPrivateLayoutsPageCount()
LayoutSet	getPublicLayoutSet()
int	getPublicLayoutsPageCount()
java.lang.String	getScopeDescriptiveName(ThemeDisplay themeDisplay)
java.lang.String	getScopeLabel(ThemeDisplay themeDisplay)
Group	getStagingGroup()
java.lang.String	getTypeLabel()
UnicodeProperties	getTypeSettingsProperties()
java.lang.String	getTypeSettingsProperty(java.lang.String key)
boolean	hasAncestor(long groupId)
boolean	hasLocalOrRemoteStagingGroup()
boolean	hasPrivateLayouts()
boolean	hasPublicLayouts()
boolean	hasStagingGroup()
boolean	isChild(long groupId)
boolean	isCommunity() Deprecated. As of 6.1.0, renamed to isRegularSite()
boolean	isCompany()
boolean	isCompanyStagingGroup()
boolean	isControlPanel()
boolean	isGuest()
boolean	isInStagingPortlet(java.lang.String portletId)
boolean	isLayout()
boolean	isLayoutPrototype()
boolean	isLayoutSetPrototype()
boolean	isLimitedToParentSiteMembers()
boolean	isOrganization()
boolean	isRegularSite()
boolean	isRoot()
boolean	isShowSite(PermissionChecker permissionChecker, boolean privateSite)
boolean	isStaged()
boolean	isStagedPortlet(java.lang.String portletId)
boolean	isStagedRemotely()
boolean	isStagingGroup()
boolean	isUser()
boolean	isUserGroup()
boolean	isUserPersonalSite()
void	setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)

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

clone, compareTo, getActive, getClassName, getClassNameId, getClassPK, getCompanyId, getCreatorUserId, getCreatorUserUuid, getDescription, getExpandoBridge, getFriendlyURL, getGroupId, getLiveGroupId, getManualMembership, getMembershipRestriction, getName, getParentGroupId, getPrimaryKey, getPrimaryKeyObj, getRemoteStagingGroupCount, getSite, getTreePath, getType, getTypeSettings, getUuid, hashCode, isActive, isCachedModel, isEscapedModel, isManualMembership, isNew, isSite, setActive, setCachedModel, setClassName, setClassNameId, setClassPK, setCompanyId, setCreatorUserId, setCreatorUserUuid, setDescription, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setFriendlyURL, setGroupId, setLiveGroupId, setManualMembership, setMembershipRestriction, setName, setNew, setParentGroupId, setPrimaryKey, setPrimaryKeyObj, setRemoteStagingGroupCount, setSite, setTreePath, setType, setTypeSettings, setUuid, 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

Methods inherited from interface com.liferay.portal.model.PersistedModel

persist

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

buildTreePath, getPrimaryKeyObj, getTreePath, updateTreePath

Method Detail

clearStagingGroup

void clearStagingGroup()

getAncestors

java.util.List<Group> getAncestors()
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getChildren

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

Throws:

SystemException

getChildrenWithLayouts

java.util.List<Group> getChildrenWithLayouts(boolean site,
                                             int start,
                                             int end)
                                             throws SystemException

Throws:

SystemException

getChildrenWithLayoutsCount

int getChildrenWithLayoutsCount(boolean site)
                                throws SystemException

Throws:

SystemException

getDefaultPrivatePlid

long getDefaultPrivatePlid()

getDefaultPublicPlid

long getDefaultPublicPlid()

getDescriptiveName

java.lang.String getDescriptiveName()
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

getDescriptiveName

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

Throws:

PortalException

SystemException

getIconURL

java.lang.String getIconURL(ThemeDisplay themeDisplay)

getLayoutRootNodeName

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

getLiveGroup

Group getLiveGroup()

getLiveParentTypeSettingsProperty

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

getOrganizationId

long getOrganizationId()

getParentGroup

Group getParentGroup()
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

getParentLiveGroupTypeSettingsProperties

UnicodeProperties getParentLiveGroupTypeSettingsProperties()

getPathFriendlyURL

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

getPrivateLayoutSet

LayoutSet getPrivateLayoutSet()

getPrivateLayoutsPageCount

int getPrivateLayoutsPageCount()

getPublicLayoutSet

LayoutSet getPublicLayoutSet()

getPublicLayoutsPageCount

int getPublicLayoutsPageCount()

getScopeDescriptiveName

java.lang.String getScopeDescriptiveName(ThemeDisplay themeDisplay)
                                         throws PortalException,
                                                SystemException

Throws:

PortalException

SystemException

getScopeLabel

java.lang.String getScopeLabel(ThemeDisplay themeDisplay)

getStagingGroup

Group getStagingGroup()

getTypeLabel

java.lang.String getTypeLabel()

getTypeSettingsProperties

UnicodeProperties getTypeSettingsProperties()

getTypeSettingsProperty

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

hasAncestor

boolean hasAncestor(long groupId)

hasLocalOrRemoteStagingGroup

boolean hasLocalOrRemoteStagingGroup()

hasPrivateLayouts

boolean hasPrivateLayouts()

hasPublicLayouts

boolean hasPublicLayouts()

hasStagingGroup

boolean hasStagingGroup()

isChild

boolean isChild(long groupId)

isCommunity

boolean isCommunity()

Deprecated. As of 6.1.0, renamed to isRegularSite()

isCompany

boolean isCompany()

isCompanyStagingGroup

boolean isCompanyStagingGroup()

isControlPanel

boolean isControlPanel()

isGuest

boolean isGuest()

isInStagingPortlet

boolean isInStagingPortlet(java.lang.String portletId)

isLayout

boolean isLayout()

isLayoutPrototype

boolean isLayoutPrototype()

isLayoutSetPrototype

boolean isLayoutSetPrototype()

isLimitedToParentSiteMembers

boolean isLimitedToParentSiteMembers()

isOrganization

boolean isOrganization()

isRegularSite

boolean isRegularSite()

isRoot

boolean isRoot()

isShowSite

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

Throws:

PortalException

SystemException

isStaged

boolean isStaged()

isStagedPortlet

boolean isStagedPortlet(java.lang.String portletId)

isStagedRemotely

boolean isStagedRemotely()

isStagingGroup

boolean isStagingGroup()

isUser

boolean isUser()

isUserGroup

boolean isUserGroup()

isUserPersonalSite

boolean isUserPersonalSite()

setTypeSettingsProperties

void setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)