Liferay 6.2.0-ce-m4

com.liferay.portal.model
Interface Group

All Superinterfaces:
AttachedModel, BaseModel<Group>, ClassedModel, Cloneable, Comparable<Group>, GroupModel, PersistedModel, Serializable
All Known Implementing Classes:
GroupBaseImpl, GroupImpl, GroupWrapper

public interface Group
extends GroupModel, PersistedModel

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
 String buildTreePath()
           
 List<Group> getAncestors()
           
 List<Group> getChildren(boolean site)
           
 List<Group> getChildrenWithLayouts(boolean site, int start, int end)
           
 int getChildrenWithLayoutsCount(boolean site)
           
 long getDefaultPrivatePlid()
           
 long getDefaultPublicPlid()
           
 String getDescriptiveName()
           
 String getDescriptiveName(Locale locale)
           
 String getIconURL(ThemeDisplay themeDisplay)
           
 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()
           
 Group getStagingGroup()
           
 String getTypeLabel()
           
 String getTypeSettings()
          Returns the type settings of this group.
 UnicodeProperties getTypeSettingsProperties()
           
 String getTypeSettingsProperty(String key)
           
 boolean hasAncestor(long groupId)
           
 boolean hasPrivateLayouts()
           
 boolean hasPublicLayouts()
           
 boolean hasStagingGroup()
           
 boolean isCommunity()
          Deprecated. As of 6.1, renamed to isRegularSite()
 boolean isCompany()
           
 boolean isControlPanel()
           
 boolean isGuest()
           
 boolean isInStagingPortlet(String portletId)
           
 boolean isLayout()
           
 boolean isLayoutPrototype()
           
 boolean isLayoutSetPrototype()
           
 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 setTypeSettings(String typeSettings)
          Sets the type settings of this group.
 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, getName, getParentGroupId, getPrimaryKey, getPrimaryKeyObj, getSite, getTreePath, 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, setTreePath, 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
 
Methods inherited from interface com.liferay.portal.model.PersistedModel
persist
 

Method Detail

buildTreePath

String buildTreePath()
                     throws PortalException,
                            SystemException
Throws:
PortalException
SystemException

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)

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

getStagingGroup

Group getStagingGroup()

getTypeLabel

String getTypeLabel()

getTypeSettings

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

Specified by:
getTypeSettings in interface GroupModel
Returns:
the type settings of this group

getTypeSettingsProperties

UnicodeProperties getTypeSettingsProperties()

getTypeSettingsProperty

String getTypeSettingsProperty(String key)

hasAncestor

boolean hasAncestor(long groupId)

hasPrivateLayouts

boolean hasPrivateLayouts()

hasPublicLayouts

boolean hasPublicLayouts()

hasStagingGroup

boolean hasStagingGroup()

isCommunity

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


isCompany

boolean isCompany()

isControlPanel

boolean isControlPanel()

isGuest

boolean isGuest()

isInStagingPortlet

boolean isInStagingPortlet(String portletId)

isLayout

boolean isLayout()

isLayoutPrototype

boolean isLayoutPrototype()

isLayoutSetPrototype

boolean isLayoutSetPrototype()

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

setTypeSettings

void setTypeSettings(String typeSettings)
Description copied from interface: GroupModel
Sets the type settings of this group.

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

setTypeSettingsProperties

void setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)

Liferay 6.2.0-ce-m4