Liferay 7.0-ce-b4

com.liferay.portal.model
Interface Group

All Superinterfaces:
AttachedModel, BaseModel<Group>, ClassedModel, Cloneable, Comparable<Group>, GroupModel, LocalizedModel, MVCCModel, PersistedModel, Serializable, ShardedModel, 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.

See Also:
GroupModel, GroupImpl, GroupModelImpl

Field Summary
static Accessor<Group,Long> GROUP_ID_ACCESSOR
           
 
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<Group> obc)
           
 int getChildrenWithLayoutsCount(boolean site)
           
 long getDefaultPrivatePlid()
           
 long getDefaultPublicPlid()
           
 List<Group> getDescendants(boolean site)
           
 String getDescriptiveName()
           
 String getDescriptiveName(Locale locale)
           
 String getDisplayURL(ThemeDisplay themeDisplay)
           
 String getDisplayURL(ThemeDisplay themeDisplay, boolean privateLayout)
           
 String getIconCssClass()
           
 String getIconURL(ThemeDisplay themeDisplay)
           
 String getLayoutRootNodeName(boolean privateLayout, Locale locale)
           
 Group getLiveGroup()
           
 String getLiveParentTypeSettingsProperty(String key)
           
 String getLogoURL(ThemeDisplay themeDisplay, boolean useDefault)
           
 long getOrganizationId()
           
 Group getParentGroup()
           
 UnicodeProperties getParentLiveGroupTypeSettingsProperties()
           
 String getPathFriendlyURL(boolean privateLayout, ThemeDisplay themeDisplay)
           
 LayoutSet getPrivateLayoutSet()
           
 int getPrivateLayoutsPageCount()
           
 LayoutSet getPublicLayoutSet()
           
 int getPublicLayoutsPageCount()
           
 long getRemoteLiveGroupId()
           
 String getScopeDescriptiveName(ThemeDisplay themeDisplay)
           
 String getScopeLabel(ThemeDisplay themeDisplay)
           
 Group getStagingGroup()
           
 String getTypeLabel()
           
 UnicodeProperties getTypeSettingsProperties()
           
 String getTypeSettingsProperty(String key)
           
 String getUnambiguousName(String name, Locale locale)
           
 boolean hasAncestor(long groupId)
           
 boolean hasLocalOrRemoteStagingGroup()
           
 boolean hasPrivateLayouts()
           
 boolean hasPublicLayouts()
           
 boolean hasRemoteStagingGroup()
           
 boolean hasStagingGroup()
           
 boolean isChild(long groupId)
          Deprecated. As of 7.0.0, replaced by hasAncestor(long)
 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, getAvailableLanguageIds, getClassName, getClassNameId, getClassPK, getCompanyId, getCreatorUserId, getCreatorUserUuid, getDefaultLanguageId, getDescription, getDescription, getDescription, getDescription, getDescription, getDescriptionCurrentLanguageId, getDescriptionCurrentValue, getDescriptionMap, getExpandoBridge, getFriendlyURL, getGroupId, getGroupKey, getInheritContent, getLiveGroupId, getManualMembership, getMembershipRestriction, getMvccVersion, getName, getName, getName, getName, getName, getNameCurrentLanguageId, getNameCurrentValue, getNameMap, getParentGroupId, getPrimaryKey, getPrimaryKeyObj, getRemoteStagingGroupCount, getSite, getTreePath, getType, getTypeSettings, getUuid, hashCode, isActive, isCachedModel, isEscapedModel, isInheritContent, isManualMembership, isNew, isSite, prepareLocalizedFieldsForImport, prepareLocalizedFieldsForImport, setActive, setCachedModel, setClassName, setClassNameId, setClassPK, setCompanyId, setCreatorUserId, setCreatorUserUuid, setDescription, setDescription, setDescription, setDescriptionCurrentLanguageId, setDescriptionMap, setDescriptionMap, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setFriendlyURL, setGroupId, setGroupKey, setInheritContent, setLiveGroupId, setManualMembership, setMembershipRestriction, setMvccVersion, setName, setName, setName, setNameCurrentLanguageId, setNameMap, setNameMap, 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, isEntityCacheEnabled, isFinderCacheEnabled, 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
 

Field Detail

GROUP_ID_ACCESSOR

static final Accessor<Group,Long> GROUP_ID_ACCESSOR
Method Detail

clearStagingGroup

void clearStagingGroup()

getAncestors

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

getChildren

List<Group> getChildren(boolean site)

getChildrenWithLayouts

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


getChildrenWithLayouts

List<Group> getChildrenWithLayouts(boolean site,
                                   int start,
                                   int end,
                                   OrderByComparator<Group> obc)

getChildrenWithLayoutsCount

int getChildrenWithLayoutsCount(boolean site)

getDefaultPrivatePlid

long getDefaultPrivatePlid()

getDefaultPublicPlid

long getDefaultPublicPlid()

getDescendants

List<Group> getDescendants(boolean site)

getDescriptiveName

String getDescriptiveName()
                          throws PortalException
Throws:
PortalException

getDescriptiveName

String getDescriptiveName(Locale locale)
                          throws PortalException
Throws:
PortalException

getDisplayURL

String getDisplayURL(ThemeDisplay themeDisplay)

getDisplayURL

String getDisplayURL(ThemeDisplay themeDisplay,
                     boolean privateLayout)

getIconCssClass

String getIconCssClass()

getIconURL

String getIconURL(ThemeDisplay themeDisplay)

getLayoutRootNodeName

String getLayoutRootNodeName(boolean privateLayout,
                             Locale locale)

getLiveGroup

Group getLiveGroup()

getLiveParentTypeSettingsProperty

String getLiveParentTypeSettingsProperty(String key)

getLogoURL

String getLogoURL(ThemeDisplay themeDisplay,
                  boolean useDefault)

getOrganizationId

long getOrganizationId()

getParentGroup

Group getParentGroup()
                     throws PortalException
Throws:
PortalException

getParentLiveGroupTypeSettingsProperties

UnicodeProperties getParentLiveGroupTypeSettingsProperties()

getPathFriendlyURL

String getPathFriendlyURL(boolean privateLayout,
                          ThemeDisplay themeDisplay)

getPrivateLayoutSet

LayoutSet getPrivateLayoutSet()

getPrivateLayoutsPageCount

int getPrivateLayoutsPageCount()

getPublicLayoutSet

LayoutSet getPublicLayoutSet()

getPublicLayoutsPageCount

int getPublicLayoutsPageCount()

getRemoteLiveGroupId

long getRemoteLiveGroupId()

getScopeDescriptiveName

String getScopeDescriptiveName(ThemeDisplay themeDisplay)
                               throws PortalException
Throws:
PortalException

getScopeLabel

String getScopeLabel(ThemeDisplay themeDisplay)

getStagingGroup

Group getStagingGroup()

getTypeLabel

String getTypeLabel()

getTypeSettingsProperties

UnicodeProperties getTypeSettingsProperties()

getTypeSettingsProperty

String getTypeSettingsProperty(String key)

getUnambiguousName

String getUnambiguousName(String name,
                          Locale locale)

hasAncestor

boolean hasAncestor(long groupId)

hasLocalOrRemoteStagingGroup

boolean hasLocalOrRemoteStagingGroup()

hasPrivateLayouts

boolean hasPrivateLayouts()

hasPublicLayouts

boolean hasPublicLayouts()

hasRemoteStagingGroup

boolean hasRemoteStagingGroup()

hasStagingGroup

boolean hasStagingGroup()

isChild

@Deprecated
boolean isChild(long groupId)
Deprecated. As of 7.0.0, replaced by hasAncestor(long)


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
Throws:
PortalException

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 7.0-ce-b4