Liferay 6.2-ce-ga5

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
 void clearStagingGroup()
           
 List<Group> getAncestors()
           
 List<Group> getChildren(boolean site)
           
 List<Group> getChildrenWithLayouts(boolean site, int start, int end)
          Deprecated. As of 7.0.0, replaced by #getChildrenWithLayouts(boolean, int, int, OrderByComparator
 List<Group> getChildrenWithLayouts(boolean site, int start, int end, OrderByComparator obc)
           
 int getChildrenWithLayoutsCount(boolean site)
           
 long getDefaultPrivatePlid()
           
 long getDefaultPublicPlid()
           
 String getDescriptiveName()
           
 String getDescriptiveName(Locale locale)
           
 String getIconURL(ThemeDisplay themeDisplay)
           
 String getLayoutRootNodeName(boolean privateLayout, Locale locale)
           
 Group getLiveGroup()
           
 String getLiveParentTypeSettingsProperty(String key)
           
 long getOrganizationId()
           
 Group getParentGroup()
           
 UnicodeProperties getParentLiveGroupTypeSettingsProperties()
           
 String getPathFriendlyURL(boolean privateLayout, ThemeDisplay themeDisplay)
           
 LayoutSet getPrivateLayoutSet()
           
 int getPrivateLayoutsPageCount()
           
 LayoutSet getPublicLayoutSet()
           
 int getPublicLayoutsPageCount()
           
 String getScopeDescriptiveName(ThemeDisplay themeDisplay)
           
 String getScopeLabel(ThemeDisplay themeDisplay)
           
 Group getStagingGroup()
           
 String getTypeLabel()
           
 UnicodeProperties getTypeSettingsProperties()
           
 String getTypeSettingsProperty(String key)
           
 boolean hasAncestor(long groupId)
           
 boolean hasLocalOrRemoteStagingGroup()
           
 boolean hasPrivateLayouts()
           
 boolean hasPublicLayouts()
           
 boolean hasStagingGroup()
           
 boolean isChild(long groupId)
          Deprecated. As of 7.0.0, replaced by hasAncestor(long)
 boolean isCommunity()
          Deprecated. As of 6.1.0, renamed to isRegularSite()
 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(PermissionChecker permissionChecker, boolean privateSite)
           
 boolean isStaged()
           
 boolean isStagedPortlet(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

List<Group> getAncestors()
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

getChildren

List<Group> getChildren(boolean site)
                        throws SystemException
Throws:
SystemException

getChildrenWithLayouts

@Deprecated
List<Group> getChildrenWithLayouts(boolean site,
                                              int start,
                                              int end)
                                   throws SystemException
Deprecated. As of 7.0.0, replaced by #getChildrenWithLayouts(boolean, int, int, OrderByComparator

Throws:
SystemException

getChildrenWithLayouts

List<Group> getChildrenWithLayouts(boolean site,
                                   int start,
                                   int end,
                                   OrderByComparator obc)
                                   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)
Deprecated. As of 7.0.0, replaced by hasAncestor(long)


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)

Liferay 6.2-ce-ga5