com.liferay.portal.model
Interface Group

All Superinterfaces:

AttachedModel, BaseModel<Group>, ClassedModel, Cloneable, Comparable<Group>, GroupModel, PersistedModel, Serializable, TreeModel, TypedModel

All Known Implementing Classes:

GroupBaseImpl, GroupImpl, 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.

See Also:

GroupModel, GroupImpl, GroupModelImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary

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

List<Group> getAncestors()
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

getChildren

List<Group> getChildren(boolean site)
                        throws SystemException

Throws:

SystemException

getChildrenWithLayouts

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

String getDescriptiveName()
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

getDescriptiveName

String getDescriptiveName(Locale locale)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

getIconURL

String getIconURL(ThemeDisplay themeDisplay)

getLayoutRootNodeName

String getLayoutRootNodeName(boolean privateLayout,
                             Locale locale)

getLiveGroup

Group getLiveGroup()

getLiveParentTypeSettingsProperty

String getLiveParentTypeSettingsProperty(String key)

getOrganizationId

long getOrganizationId()

getParentGroup

Group getParentGroup()
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

getParentLiveGroupTypeSettingsProperties

UnicodeProperties getParentLiveGroupTypeSettingsProperties()

getPathFriendlyURL

String getPathFriendlyURL(boolean privateLayout,
                          ThemeDisplay themeDisplay)

getPrivateLayoutSet

LayoutSet getPrivateLayoutSet()

getPrivateLayoutsPageCount

int getPrivateLayoutsPageCount()

getPublicLayoutSet

LayoutSet getPublicLayoutSet()

getPublicLayoutsPageCount

int getPublicLayoutsPageCount()

getScopeDescriptiveName

String getScopeDescriptiveName(ThemeDisplay themeDisplay)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

getScopeLabel

String getScopeLabel(ThemeDisplay themeDisplay)

getStagingGroup

Group getStagingGroup()

getTypeLabel

String getTypeLabel()

getTypeSettingsProperties

UnicodeProperties getTypeSettingsProperties()

getTypeSettingsProperty

String getTypeSettingsProperty(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(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(String portletId)

isStagedRemotely

boolean isStagedRemotely()

isStagingGroup

boolean isStagingGroup()

isUser

boolean isUser()

isUserGroup

boolean isUserGroup()

isUserPersonalSite

boolean isUserPersonalSite()

setTypeSettingsProperties

void setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)