Liferay 7.0-ce-b4

com.liferay.portal.model
Class GroupWrapper

java.lang.Object
  extended by com.liferay.portal.model.GroupWrapper
All Implemented Interfaces:
AttachedModel, BaseModel<Group>, ClassedModel, Group, GroupModel, LocalizedModel, ModelWrapper<Group>, MVCCModel, PersistedModel, ShardedModel, TreeModel, TypedModel, Serializable, Cloneable, Comparable<Group>

@ProviderType
public class GroupWrapper
extends Object
implements Group, ModelWrapper<Group>

This class is a wrapper for Group.

See Also:
Group, Serialized Form

Field Summary
 
Fields inherited from interface com.liferay.portal.model.Group
GROUP_ID_ACCESSOR
 
Constructor Summary
GroupWrapper(Group group)
           
 
Method Summary
 String buildTreePath()
           
 void clearStagingGroup()
           
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(Group group)
           
 boolean equals(Object obj)
           
 boolean getActive()
          Returns the active of this group.
 List<Group> getAncestors()
           
 String[] getAvailableLanguageIds()
           
 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)
           
 String getClassName()
          Returns the fully qualified class name of this group.
 long getClassNameId()
          Returns the class name ID of this group.
 long getClassPK()
          Returns the class p k of this group.
 long getCompanyId()
          Returns the company ID of this group.
 long getCreatorUserId()
          Returns the creator user ID of this group.
 String getCreatorUserUuid()
          Returns the creator user uuid of this group.
 String getDefaultLanguageId()
           
 long getDefaultPrivatePlid()
           
 long getDefaultPublicPlid()
           
 List<Group> getDescendants(boolean site)
           
 String getDescription()
          Returns the description of this group.
 String getDescription(Locale locale)
          Returns the localized description of this group in the language.
 String getDescription(Locale locale, boolean useDefault)
          Returns the localized description of this group in the language, optionally using the default language if no localization exists for the requested language.
 String getDescription(String languageId)
          Returns the localized description of this group in the language.
 String getDescription(String languageId, boolean useDefault)
          Returns the localized description of this group in the language, optionally using the default language if no localization exists for the requested language.
 String getDescriptionCurrentLanguageId()
           
 String getDescriptionCurrentValue()
           
 Map<Locale,String> getDescriptionMap()
          Returns a map of the locales and localized descriptions of this group.
 String getDescriptiveName()
           
 String getDescriptiveName(Locale locale)
           
 String getDisplayURL(ThemeDisplay themeDisplay)
           
 String getDisplayURL(ThemeDisplay themeDisplay, boolean privateLayout)
           
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 String getFriendlyURL()
          Returns the friendly u r l of this group.
 long getGroupId()
          Returns the group ID of this group.
 String getGroupKey()
          Returns the group key of this group.
 String getIconCssClass()
           
 String getIconURL(ThemeDisplay themeDisplay)
           
 boolean getInheritContent()
          Returns the inherit content of this group.
 String getLayoutRootNodeName(boolean privateLayout, Locale locale)
           
 Group getLiveGroup()
           
 long getLiveGroupId()
          Returns the live group ID of this group.
 String getLiveParentTypeSettingsProperty(String key)
           
 String getLogoURL(ThemeDisplay themeDisplay, boolean useDefault)
           
 boolean getManualMembership()
          Returns the manual membership of this group.
 int getMembershipRestriction()
          Returns the membership restriction of this group.
 Map<String,Object> getModelAttributes()
           
 Class<?> getModelClass()
           
 String getModelClassName()
           
 long getMvccVersion()
          Returns the mvcc version of this group.
 String getName()
          Returns the name of this group.
 String getName(Locale locale)
          Returns the localized name of this group in the language.
 String getName(Locale locale, boolean useDefault)
          Returns the localized name of this group in the language, optionally using the default language if no localization exists for the requested language.
 String getName(String languageId)
          Returns the localized name of this group in the language.
 String getName(String languageId, boolean useDefault)
          Returns the localized name of this group in the language, optionally using the default language if no localization exists for the requested language.
 String getNameCurrentLanguageId()
           
 String getNameCurrentValue()
           
 Map<Locale,String> getNameMap()
          Returns a map of the locales and localized names of this group.
 long getOrganizationId()
           
 Group getParentGroup()
           
 long getParentGroupId()
          Returns the parent group ID of this group.
 UnicodeProperties getParentLiveGroupTypeSettingsProperties()
           
 String getPathFriendlyURL(boolean privateLayout, ThemeDisplay themeDisplay)
           
 long getPrimaryKey()
          Returns the primary key of this group.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 LayoutSet getPrivateLayoutSet()
           
 int getPrivateLayoutsPageCount()
           
 LayoutSet getPublicLayoutSet()
           
 int getPublicLayoutsPageCount()
           
 long getRemoteLiveGroupId()
           
 int getRemoteStagingGroupCount()
          Returns the remote staging group count of this group.
 String getScopeDescriptiveName(ThemeDisplay themeDisplay)
           
 String getScopeLabel(ThemeDisplay themeDisplay)
           
 boolean getSite()
          Returns the site of this group.
 Group getStagingGroup()
           
 String getTreePath()
          Returns the tree path of this group.
 int getType()
          Returns the type of this group.
 String getTypeLabel()
           
 String getTypeSettings()
          Returns the type settings of this group.
 UnicodeProperties getTypeSettingsProperties()
           
 String getTypeSettingsProperty(String key)
           
 String getUnambiguousName(String name, Locale locale)
           
 String getUuid()
          Returns the uuid of this group.
 Group getWrappedModel()
           
 boolean hasAncestor(long groupId)
           
 int hashCode()
           
 boolean hasLocalOrRemoteStagingGroup()
           
 boolean hasPrivateLayouts()
           
 boolean hasPublicLayouts()
           
 boolean hasRemoteStagingGroup()
           
 boolean hasStagingGroup()
           
 boolean isActive()
          Returns true if this group is active.
 boolean isCachedModel()
          Returns true if this model instance was retrieved from the entity cache.
 boolean isChild(long groupId)
          Deprecated. As of 7.0.0, replaced by hasAncestor(long)
 boolean isCompany()
           
 boolean isCompanyStagingGroup()
           
 boolean isControlPanel()
           
 boolean isEntityCacheEnabled()
          Returns true if this model's entity cache is enabled.
 boolean isEscapedModel()
          Returns true if this model instance is escaped.
 boolean isFinderCacheEnabled()
          Returns true if this model's finder cache is enabled.
 boolean isGuest()
           
 boolean isInheritContent()
          Returns true if this group is inherit content.
 boolean isInStagingPortlet(String portletId)
           
 boolean isLayout()
           
 boolean isLayoutPrototype()
           
 boolean isLayoutSetPrototype()
           
 boolean isLimitedToParentSiteMembers()
           
 boolean isManualMembership()
          Returns true if this group is manual membership.
 boolean isNew()
          Returns true if this model instance does not yet exist in the database.
 boolean isOrganization()
           
 boolean isRegularSite()
           
 boolean isRoot()
           
 boolean isShowSite(PermissionChecker permissionChecker, boolean privateSite)
           
 boolean isSite()
          Returns true if this group is site.
 boolean isStaged()
           
 boolean isStagedPortlet(String portletId)
           
 boolean isStagedRemotely()
           
 boolean isStagingGroup()
           
 boolean isUser()
           
 boolean isUserGroup()
           
 boolean isUserPersonalSite()
           
 void persist()
          Updates this model instance in the database or adds it if it does not yet exist.
 void prepareLocalizedFieldsForImport()
           
 void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
           
 void resetOriginalValues()
          Reset all original fields to current values.
 void setActive(boolean active)
          Sets whether this group is active.
 void setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 void setClassName(String className)
           
 void setClassNameId(long classNameId)
          Sets the class name ID of this group.
 void setClassPK(long classPK)
          Sets the class p k of this group.
 void setCompanyId(long companyId)
          Sets the company ID of this group.
 void setCreatorUserId(long creatorUserId)
          Sets the creator user ID of this group.
 void setCreatorUserUuid(String creatorUserUuid)
          Sets the creator user uuid of this group.
 void setDescription(String description)
          Sets the description of this group.
 void setDescription(String description, Locale locale)
          Sets the localized description of this group in the language.
 void setDescription(String description, Locale locale, Locale defaultLocale)
          Sets the localized description of this group in the language, and sets the default locale.
 void setDescriptionCurrentLanguageId(String languageId)
           
 void setDescriptionMap(Map<Locale,String> descriptionMap)
          Sets the localized descriptions of this group from the map of locales and localized descriptions.
 void setDescriptionMap(Map<Locale,String> descriptionMap, Locale defaultLocale)
          Sets the localized descriptions of this group from the map of locales and localized descriptions, and sets the default locale.
 void setExpandoBridgeAttributes(BaseModel<?> baseModel)
           
 void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
           
 void setExpandoBridgeAttributes(ServiceContext serviceContext)
          Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
 void setFriendlyURL(String friendlyURL)
          Sets the friendly u r l of this group.
 void setGroupId(long groupId)
          Sets the group ID of this group.
 void setGroupKey(String groupKey)
          Sets the group key of this group.
 void setInheritContent(boolean inheritContent)
          Sets whether this group is inherit content.
 void setLiveGroupId(long liveGroupId)
          Sets the live group ID of this group.
 void setManualMembership(boolean manualMembership)
          Sets whether this group is manual membership.
 void setMembershipRestriction(int membershipRestriction)
          Sets the membership restriction of this group.
 void setModelAttributes(Map<String,Object> attributes)
           
 void setMvccVersion(long mvccVersion)
          Sets the mvcc version of this group.
 void setName(String name)
          Sets the name of this group.
 void setName(String name, Locale locale)
          Sets the localized name of this group in the language.
 void setName(String name, Locale locale, Locale defaultLocale)
          Sets the localized name of this group in the language, and sets the default locale.
 void setNameCurrentLanguageId(String languageId)
           
 void setNameMap(Map<Locale,String> nameMap)
          Sets the localized names of this group from the map of locales and localized names.
 void setNameMap(Map<Locale,String> nameMap, Locale defaultLocale)
          Sets the localized names of this group from the map of locales and localized names, and sets the default locale.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setParentGroupId(long parentGroupId)
          Sets the parent group ID of this group.
 void setPrimaryKey(long primaryKey)
          Sets the primary key of this group.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setRemoteStagingGroupCount(int remoteStagingGroupCount)
          Sets the remote staging group count of this group.
 void setSite(boolean site)
          Sets whether this group is site.
 void setTreePath(String treePath)
          Sets the tree path of this group.
 void setType(int type)
          Sets the type of this group.
 void setTypeSettings(String typeSettings)
          Sets the type settings of this group.
 void setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)
           
 void setUuid(String uuid)
          Sets the uuid of this group.
 CacheModel<Group> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 Group toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 Group toUnescapedModel()
           
 String toXmlString()
          Returns the XML representation of this model instance.
 void updateTreePath(String treePath)
           
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GroupWrapper

public GroupWrapper(Group group)
Method Detail

getModelClass

public Class<?> getModelClass()
Specified by:
getModelClass in interface ClassedModel

getModelClassName

public String getModelClassName()
Specified by:
getModelClassName in interface ClassedModel

getModelAttributes

public Map<String,Object> getModelAttributes()
Specified by:
getModelAttributes in interface BaseModel<Group>

setModelAttributes

public void setModelAttributes(Map<String,Object> attributes)
Specified by:
setModelAttributes in interface BaseModel<Group>

buildTreePath

public String buildTreePath()
                     throws PortalException
Specified by:
buildTreePath in interface TreeModel
Throws:
PortalException

clearStagingGroup

public void clearStagingGroup()
Specified by:
clearStagingGroup in interface Group

clone

public Object clone()
Description copied from interface: BaseModel
Creates a shallow clone of this model instance.

Specified by:
clone in interface BaseModel<Group>
Specified by:
clone in interface GroupModel
Overrides:
clone in class Object
Returns:
the shallow clone of this model instance

compareTo

public int compareTo(Group group)
Specified by:
compareTo in interface GroupModel
Specified by:
compareTo in interface Comparable<Group>

getActive

public boolean getActive()
Returns the active of this group.

Specified by:
getActive in interface GroupModel
Returns:
the active of this group

getAncestors

public List<Group> getAncestors()
                         throws PortalException
Specified by:
getAncestors in interface Group
Throws:
PortalException

getAvailableLanguageIds

public String[] getAvailableLanguageIds()
Specified by:
getAvailableLanguageIds in interface GroupModel
Specified by:
getAvailableLanguageIds in interface LocalizedModel

getChildren

public List<Group> getChildren(boolean site)
Specified by:
getChildren in interface Group

getChildrenWithLayouts

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

Specified by:
getChildrenWithLayouts in interface Group

getChildrenWithLayouts

public List<Group> getChildrenWithLayouts(boolean site,
                                          int start,
                                          int end,
                                          OrderByComparator<Group> obc)
Specified by:
getChildrenWithLayouts in interface Group

getChildrenWithLayoutsCount

public int getChildrenWithLayoutsCount(boolean site)
Specified by:
getChildrenWithLayoutsCount in interface Group

getClassName

public String getClassName()
Returns the fully qualified class name of this group.

Specified by:
getClassName in interface GroupModel
Specified by:
getClassName in interface TypedModel
Returns:
the fully qualified class name of this group

getClassNameId

public long getClassNameId()
Returns the class name ID of this group.

Specified by:
getClassNameId in interface GroupModel
Specified by:
getClassNameId in interface TypedModel
Returns:
the class name ID of this group

getClassPK

public long getClassPK()
Returns the class p k of this group.

Specified by:
getClassPK in interface AttachedModel
Specified by:
getClassPK in interface GroupModel
Returns:
the class p k of this group

getCompanyId

public long getCompanyId()
Returns the company ID of this group.

Specified by:
getCompanyId in interface GroupModel
Specified by:
getCompanyId in interface ShardedModel
Returns:
the company ID of this group

getCreatorUserId

public long getCreatorUserId()
Returns the creator user ID of this group.

Specified by:
getCreatorUserId in interface GroupModel
Returns:
the creator user ID of this group

getCreatorUserUuid

public String getCreatorUserUuid()
Returns the creator user uuid of this group.

Specified by:
getCreatorUserUuid in interface GroupModel
Returns:
the creator user uuid of this group

getDefaultLanguageId

public String getDefaultLanguageId()
Specified by:
getDefaultLanguageId in interface GroupModel
Specified by:
getDefaultLanguageId in interface LocalizedModel

getDefaultPrivatePlid

public long getDefaultPrivatePlid()
Specified by:
getDefaultPrivatePlid in interface Group

getDefaultPublicPlid

public long getDefaultPublicPlid()
Specified by:
getDefaultPublicPlid in interface Group

getDescendants

public List<Group> getDescendants(boolean site)
Specified by:
getDescendants in interface Group

getDescription

public String getDescription()
Returns the description of this group.

Specified by:
getDescription in interface GroupModel
Returns:
the description of this group

getDescription

public String getDescription(String languageId)
Returns the localized description of this group in the language. Uses the default language if no localization exists for the requested language.

Specified by:
getDescription in interface GroupModel
Parameters:
languageId - the ID of the language
Returns:
the localized description of this group

getDescription

public String getDescription(String languageId,
                             boolean useDefault)
Returns the localized description of this group in the language, optionally using the default language if no localization exists for the requested language.

Specified by:
getDescription in interface GroupModel
Parameters:
languageId - the ID of the language
useDefault - whether to use the default language if no localization exists for the requested language
Returns:
the localized description of this group

getDescription

public String getDescription(Locale locale)
Returns the localized description of this group in the language. Uses the default language if no localization exists for the requested language.

Specified by:
getDescription in interface GroupModel
Parameters:
locale - the locale of the language
Returns:
the localized description of this group

getDescription

public String getDescription(Locale locale,
                             boolean useDefault)
Returns the localized description of this group in the language, optionally using the default language if no localization exists for the requested language.

Specified by:
getDescription in interface GroupModel
Parameters:
locale - the local of the language
useDefault - whether to use the default language if no localization exists for the requested language
Returns:
the localized description of this group. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getDescriptionCurrentLanguageId

public String getDescriptionCurrentLanguageId()
Specified by:
getDescriptionCurrentLanguageId in interface GroupModel

getDescriptionCurrentValue

public String getDescriptionCurrentValue()
Specified by:
getDescriptionCurrentValue in interface GroupModel

getDescriptionMap

public Map<Locale,String> getDescriptionMap()
Returns a map of the locales and localized descriptions of this group.

Specified by:
getDescriptionMap in interface GroupModel
Returns:
the locales and localized descriptions of this group

getDescriptiveName

public String getDescriptiveName()
                          throws PortalException
Specified by:
getDescriptiveName in interface Group
Throws:
PortalException

getDescriptiveName

public String getDescriptiveName(Locale locale)
                          throws PortalException
Specified by:
getDescriptiveName in interface Group
Throws:
PortalException

getDisplayURL

public String getDisplayURL(ThemeDisplay themeDisplay)
Specified by:
getDisplayURL in interface Group

getDisplayURL

public String getDisplayURL(ThemeDisplay themeDisplay,
                            boolean privateLayout)
Specified by:
getDisplayURL in interface Group

getExpandoBridge

public ExpandoBridge getExpandoBridge()
Description copied from interface: BaseModel
Returns the expando bridge for this model instance.

Specified by:
getExpandoBridge in interface BaseModel<Group>
Specified by:
getExpandoBridge in interface ClassedModel
Specified by:
getExpandoBridge in interface GroupModel
Returns:
the expando bridge for this model instance

getFriendlyURL

public String getFriendlyURL()
Returns the friendly u r l of this group.

Specified by:
getFriendlyURL in interface GroupModel
Returns:
the friendly u r l of this group

getGroupId

public long getGroupId()
Returns the group ID of this group.

Specified by:
getGroupId in interface GroupModel
Returns:
the group ID of this group

getGroupKey

public String getGroupKey()
Returns the group key of this group.

Specified by:
getGroupKey in interface GroupModel
Returns:
the group key of this group

getIconCssClass

public String getIconCssClass()
Specified by:
getIconCssClass in interface Group

getIconURL

public String getIconURL(ThemeDisplay themeDisplay)
Specified by:
getIconURL in interface Group

getInheritContent

public boolean getInheritContent()
Returns the inherit content of this group.

Specified by:
getInheritContent in interface GroupModel
Returns:
the inherit content of this group

getLayoutRootNodeName

public String getLayoutRootNodeName(boolean privateLayout,
                                    Locale locale)
Specified by:
getLayoutRootNodeName in interface Group

getLiveGroup

public Group getLiveGroup()
Specified by:
getLiveGroup in interface Group

getLiveGroupId

public long getLiveGroupId()
Returns the live group ID of this group.

Specified by:
getLiveGroupId in interface GroupModel
Returns:
the live group ID of this group

getLiveParentTypeSettingsProperty

public String getLiveParentTypeSettingsProperty(String key)
Specified by:
getLiveParentTypeSettingsProperty in interface Group

getLogoURL

public String getLogoURL(ThemeDisplay themeDisplay,
                         boolean useDefault)
Specified by:
getLogoURL in interface Group

getManualMembership

public boolean getManualMembership()
Returns the manual membership of this group.

Specified by:
getManualMembership in interface GroupModel
Returns:
the manual membership of this group

getMembershipRestriction

public int getMembershipRestriction()
Returns the membership restriction of this group.

Specified by:
getMembershipRestriction in interface GroupModel
Returns:
the membership restriction of this group

getMvccVersion

public long getMvccVersion()
Returns the mvcc version of this group.

Specified by:
getMvccVersion in interface GroupModel
Specified by:
getMvccVersion in interface MVCCModel
Returns:
the mvcc version of this group

getName

public String getName()
Returns the name of this group.

Specified by:
getName in interface GroupModel
Returns:
the name of this group

getName

public String getName(String languageId)
Returns the localized name of this group in the language. Uses the default language if no localization exists for the requested language.

Specified by:
getName in interface GroupModel
Parameters:
languageId - the ID of the language
Returns:
the localized name of this group

getName

public String getName(String languageId,
                      boolean useDefault)
Returns the localized name of this group in the language, optionally using the default language if no localization exists for the requested language.

Specified by:
getName in interface GroupModel
Parameters:
languageId - the ID of the language
useDefault - whether to use the default language if no localization exists for the requested language
Returns:
the localized name of this group

getName

public String getName(Locale locale)
Returns the localized name of this group in the language. Uses the default language if no localization exists for the requested language.

Specified by:
getName in interface GroupModel
Parameters:
locale - the locale of the language
Returns:
the localized name of this group

getName

public String getName(Locale locale,
                      boolean useDefault)
Returns the localized name of this group in the language, optionally using the default language if no localization exists for the requested language.

Specified by:
getName in interface GroupModel
Parameters:
locale - the local of the language
useDefault - whether to use the default language if no localization exists for the requested language
Returns:
the localized name of this group. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getNameCurrentLanguageId

public String getNameCurrentLanguageId()
Specified by:
getNameCurrentLanguageId in interface GroupModel

getNameCurrentValue

public String getNameCurrentValue()
Specified by:
getNameCurrentValue in interface GroupModel

getNameMap

public Map<Locale,String> getNameMap()
Returns a map of the locales and localized names of this group.

Specified by:
getNameMap in interface GroupModel
Returns:
the locales and localized names of this group

getOrganizationId

public long getOrganizationId()
Specified by:
getOrganizationId in interface Group

getParentGroup

public Group getParentGroup()
                     throws PortalException
Specified by:
getParentGroup in interface Group
Throws:
PortalException

getParentGroupId

public long getParentGroupId()
Returns the parent group ID of this group.

Specified by:
getParentGroupId in interface GroupModel
Returns:
the parent group ID of this group

getParentLiveGroupTypeSettingsProperties

public UnicodeProperties getParentLiveGroupTypeSettingsProperties()
Specified by:
getParentLiveGroupTypeSettingsProperties in interface Group

getPathFriendlyURL

public String getPathFriendlyURL(boolean privateLayout,
                                 ThemeDisplay themeDisplay)
Specified by:
getPathFriendlyURL in interface Group

getPrimaryKey

public long getPrimaryKey()
Returns the primary key of this group.

Specified by:
getPrimaryKey in interface GroupModel
Returns:
the primary key of this group

getPrimaryKeyObj

public Serializable getPrimaryKeyObj()
Description copied from interface: BaseModel
Returns the primary key of this model instance.

Specified by:
getPrimaryKeyObj in interface BaseModel<Group>
Specified by:
getPrimaryKeyObj in interface ClassedModel
Specified by:
getPrimaryKeyObj in interface GroupModel
Specified by:
getPrimaryKeyObj in interface TreeModel
Returns:
the primary key of this model instance

getPrivateLayoutSet

public LayoutSet getPrivateLayoutSet()
Specified by:
getPrivateLayoutSet in interface Group

getPrivateLayoutsPageCount

public int getPrivateLayoutsPageCount()
Specified by:
getPrivateLayoutsPageCount in interface Group

getPublicLayoutSet

public LayoutSet getPublicLayoutSet()
Specified by:
getPublicLayoutSet in interface Group

getPublicLayoutsPageCount

public int getPublicLayoutsPageCount()
Specified by:
getPublicLayoutsPageCount in interface Group

getRemoteLiveGroupId

public long getRemoteLiveGroupId()
Specified by:
getRemoteLiveGroupId in interface Group

getRemoteStagingGroupCount

public int getRemoteStagingGroupCount()
Returns the remote staging group count of this group.

Specified by:
getRemoteStagingGroupCount in interface GroupModel
Returns:
the remote staging group count of this group

getScopeDescriptiveName

public String getScopeDescriptiveName(ThemeDisplay themeDisplay)
                               throws PortalException
Specified by:
getScopeDescriptiveName in interface Group
Throws:
PortalException

getScopeLabel

public String getScopeLabel(ThemeDisplay themeDisplay)
Specified by:
getScopeLabel in interface Group

getSite

public boolean getSite()
Returns the site of this group.

Specified by:
getSite in interface GroupModel
Returns:
the site of this group

getStagingGroup

public Group getStagingGroup()
Specified by:
getStagingGroup in interface Group

getTreePath

public String getTreePath()
Returns the tree path of this group.

Specified by:
getTreePath in interface GroupModel
Specified by:
getTreePath in interface TreeModel
Returns:
the tree path of this group

getType

public int getType()
Returns the type of this group.

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

getTypeLabel

public String getTypeLabel()
Specified by:
getTypeLabel in interface Group

getTypeSettings

public String getTypeSettings()
Returns the type settings of this group.

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

getTypeSettingsProperties

public UnicodeProperties getTypeSettingsProperties()
Specified by:
getTypeSettingsProperties in interface Group

getTypeSettingsProperty

public String getTypeSettingsProperty(String key)
Specified by:
getTypeSettingsProperty in interface Group

getUnambiguousName

public String getUnambiguousName(String name,
                                 Locale locale)
Specified by:
getUnambiguousName in interface Group

getUuid

public String getUuid()
Returns the uuid of this group.

Specified by:
getUuid in interface GroupModel
Returns:
the uuid of this group

hasAncestor

public boolean hasAncestor(long groupId)
Specified by:
hasAncestor in interface Group

hasLocalOrRemoteStagingGroup

public boolean hasLocalOrRemoteStagingGroup()
Specified by:
hasLocalOrRemoteStagingGroup in interface Group

hasPrivateLayouts

public boolean hasPrivateLayouts()
Specified by:
hasPrivateLayouts in interface Group

hasPublicLayouts

public boolean hasPublicLayouts()
Specified by:
hasPublicLayouts in interface Group

hasRemoteStagingGroup

public boolean hasRemoteStagingGroup()
Specified by:
hasRemoteStagingGroup in interface Group

hasStagingGroup

public boolean hasStagingGroup()
Specified by:
hasStagingGroup in interface Group

hashCode

public int hashCode()
Specified by:
hashCode in interface GroupModel
Overrides:
hashCode in class Object

isActive

public boolean isActive()
Returns true if this group is active.

Specified by:
isActive in interface GroupModel
Returns:
true if this group is active; false otherwise

isCachedModel

public boolean isCachedModel()
Description copied from interface: BaseModel
Returns true if this model instance was retrieved from the entity cache.

Specified by:
isCachedModel in interface BaseModel<Group>
Specified by:
isCachedModel in interface GroupModel
Returns:
true if this model instance was retrieved from the entity cache; false otherwise
See Also:
BaseModel.setCachedModel(boolean)

isChild

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

Specified by:
isChild in interface Group

isCompany

public boolean isCompany()
Specified by:
isCompany in interface Group

isCompanyStagingGroup

public boolean isCompanyStagingGroup()
Specified by:
isCompanyStagingGroup in interface Group

isControlPanel

public boolean isControlPanel()
Specified by:
isControlPanel in interface Group

isEscapedModel

public boolean isEscapedModel()
Description copied from interface: BaseModel
Returns true if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<Group>
Specified by:
isEscapedModel in interface GroupModel
Returns:
true if this model instance is escaped; false otherwise

isGuest

public boolean isGuest()
Specified by:
isGuest in interface Group

isInStagingPortlet

public boolean isInStagingPortlet(String portletId)
Specified by:
isInStagingPortlet in interface Group

isInheritContent

public boolean isInheritContent()
Returns true if this group is inherit content.

Specified by:
isInheritContent in interface GroupModel
Returns:
true if this group is inherit content; false otherwise

isLayout

public boolean isLayout()
Specified by:
isLayout in interface Group

isLayoutPrototype

public boolean isLayoutPrototype()
Specified by:
isLayoutPrototype in interface Group

isLayoutSetPrototype

public boolean isLayoutSetPrototype()
Specified by:
isLayoutSetPrototype in interface Group

isLimitedToParentSiteMembers

public boolean isLimitedToParentSiteMembers()
Specified by:
isLimitedToParentSiteMembers in interface Group

isManualMembership

public boolean isManualMembership()
Returns true if this group is manual membership.

Specified by:
isManualMembership in interface GroupModel
Returns:
true if this group is manual membership; false otherwise

isNew

public boolean isNew()
Description copied from interface: BaseModel
Returns true if this model instance does not yet exist in the database.

Specified by:
isNew in interface BaseModel<Group>
Specified by:
isNew in interface GroupModel
Returns:
true if this model instance does not yet exist in the database; false otherwise

isOrganization

public boolean isOrganization()
Specified by:
isOrganization in interface Group

isRegularSite

public boolean isRegularSite()
Specified by:
isRegularSite in interface Group

isRoot

public boolean isRoot()
Specified by:
isRoot in interface Group

isShowSite

public boolean isShowSite(PermissionChecker permissionChecker,
                          boolean privateSite)
                   throws PortalException
Specified by:
isShowSite in interface Group
Throws:
PortalException

isSite

public boolean isSite()
Returns true if this group is site.

Specified by:
isSite in interface GroupModel
Returns:
true if this group is site; false otherwise

isStaged

public boolean isStaged()
Specified by:
isStaged in interface Group

isStagedPortlet

public boolean isStagedPortlet(String portletId)
Specified by:
isStagedPortlet in interface Group

isStagedRemotely

public boolean isStagedRemotely()
Specified by:
isStagedRemotely in interface Group

isStagingGroup

public boolean isStagingGroup()
Specified by:
isStagingGroup in interface Group

isUser

public boolean isUser()
Specified by:
isUser in interface Group

isUserGroup

public boolean isUserGroup()
Specified by:
isUserGroup in interface Group

isUserPersonalSite

public boolean isUserPersonalSite()
Specified by:
isUserPersonalSite in interface Group

persist

public void persist()
Description copied from interface: PersistedModel
Updates this model instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Specified by:
persist in interface PersistedModel

prepareLocalizedFieldsForImport

public void prepareLocalizedFieldsForImport()
                                     throws LocaleException
Specified by:
prepareLocalizedFieldsForImport in interface GroupModel
Specified by:
prepareLocalizedFieldsForImport in interface LocalizedModel
Throws:
LocaleException

prepareLocalizedFieldsForImport

public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
                                     throws LocaleException
Specified by:
prepareLocalizedFieldsForImport in interface GroupModel
Specified by:
prepareLocalizedFieldsForImport in interface LocalizedModel
Throws:
LocaleException

setActive

public void setActive(boolean active)
Sets whether this group is active.

Specified by:
setActive in interface GroupModel
Parameters:
active - the active of this group

setCachedModel

public void setCachedModel(boolean cachedModel)
Description copied from interface: BaseModel
Sets whether this model instance was retrieved from the entity cache.

Specified by:
setCachedModel in interface BaseModel<Group>
Specified by:
setCachedModel in interface GroupModel
Parameters:
cachedModel - whether this model instance was retrieved from the entity cache
See Also:
EntityCache

setClassName

public void setClassName(String className)
Specified by:
setClassName in interface GroupModel

setClassNameId

public void setClassNameId(long classNameId)
Sets the class name ID of this group.

Specified by:
setClassNameId in interface GroupModel
Specified by:
setClassNameId in interface TypedModel
Parameters:
classNameId - the class name ID of this group

setClassPK

public void setClassPK(long classPK)
Sets the class p k of this group.

Specified by:
setClassPK in interface AttachedModel
Specified by:
setClassPK in interface GroupModel
Parameters:
classPK - the class p k of this group

setCompanyId

public void setCompanyId(long companyId)
Sets the company ID of this group.

Specified by:
setCompanyId in interface GroupModel
Specified by:
setCompanyId in interface ShardedModel
Parameters:
companyId - the company ID of this group

setCreatorUserId

public void setCreatorUserId(long creatorUserId)
Sets the creator user ID of this group.

Specified by:
setCreatorUserId in interface GroupModel
Parameters:
creatorUserId - the creator user ID of this group

setCreatorUserUuid

public void setCreatorUserUuid(String creatorUserUuid)
Sets the creator user uuid of this group.

Specified by:
setCreatorUserUuid in interface GroupModel
Parameters:
creatorUserUuid - the creator user uuid of this group

setDescription

public void setDescription(String description)
Sets the description of this group.

Specified by:
setDescription in interface GroupModel
Parameters:
description - the description of this group

setDescription

public void setDescription(String description,
                           Locale locale)
Sets the localized description of this group in the language.

Specified by:
setDescription in interface GroupModel
Parameters:
description - the localized description of this group
locale - the locale of the language

setDescription

public void setDescription(String description,
                           Locale locale,
                           Locale defaultLocale)
Sets the localized description of this group in the language, and sets the default locale.

Specified by:
setDescription in interface GroupModel
Parameters:
description - the localized description of this group
locale - the locale of the language
defaultLocale - the default locale

setDescriptionCurrentLanguageId

public void setDescriptionCurrentLanguageId(String languageId)
Specified by:
setDescriptionCurrentLanguageId in interface GroupModel

setDescriptionMap

public void setDescriptionMap(Map<Locale,String> descriptionMap)
Sets the localized descriptions of this group from the map of locales and localized descriptions.

Specified by:
setDescriptionMap in interface GroupModel
Parameters:
descriptionMap - the locales and localized descriptions of this group

setDescriptionMap

public void setDescriptionMap(Map<Locale,String> descriptionMap,
                              Locale defaultLocale)
Sets the localized descriptions of this group from the map of locales and localized descriptions, and sets the default locale.

Specified by:
setDescriptionMap in interface GroupModel
Parameters:
descriptionMap - the locales and localized descriptions of this group
defaultLocale - the default locale

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(BaseModel<?> baseModel)
Specified by:
setExpandoBridgeAttributes in interface BaseModel<Group>
Specified by:
setExpandoBridgeAttributes in interface GroupModel

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
Specified by:
setExpandoBridgeAttributes in interface BaseModel<Group>
Specified by:
setExpandoBridgeAttributes in interface GroupModel

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(ServiceContext serviceContext)
Description copied from interface: BaseModel
Sets the expando bridge attributes for this model instance to the attributes stored in the service context.

Specified by:
setExpandoBridgeAttributes in interface BaseModel<Group>
Specified by:
setExpandoBridgeAttributes in interface GroupModel
Parameters:
serviceContext - the service context to be applied
See Also:
ServiceContext.getExpandoBridgeAttributes()

setFriendlyURL

public void setFriendlyURL(String friendlyURL)
Sets the friendly u r l of this group.

Specified by:
setFriendlyURL in interface GroupModel
Parameters:
friendlyURL - the friendly u r l of this group

setGroupId

public void setGroupId(long groupId)
Sets the group ID of this group.

Specified by:
setGroupId in interface GroupModel
Parameters:
groupId - the group ID of this group

setGroupKey

public void setGroupKey(String groupKey)
Sets the group key of this group.

Specified by:
setGroupKey in interface GroupModel
Parameters:
groupKey - the group key of this group

setInheritContent

public void setInheritContent(boolean inheritContent)
Sets whether this group is inherit content.

Specified by:
setInheritContent in interface GroupModel
Parameters:
inheritContent - the inherit content of this group

setLiveGroupId

public void setLiveGroupId(long liveGroupId)
Sets the live group ID of this group.

Specified by:
setLiveGroupId in interface GroupModel
Parameters:
liveGroupId - the live group ID of this group

setManualMembership

public void setManualMembership(boolean manualMembership)
Sets whether this group is manual membership.

Specified by:
setManualMembership in interface GroupModel
Parameters:
manualMembership - the manual membership of this group

setMembershipRestriction

public void setMembershipRestriction(int membershipRestriction)
Sets the membership restriction of this group.

Specified by:
setMembershipRestriction in interface GroupModel
Parameters:
membershipRestriction - the membership restriction of this group

setMvccVersion

public void setMvccVersion(long mvccVersion)
Sets the mvcc version of this group.

Specified by:
setMvccVersion in interface GroupModel
Specified by:
setMvccVersion in interface MVCCModel
Parameters:
mvccVersion - the mvcc version of this group

setName

public void setName(String name)
Sets the name of this group.

Specified by:
setName in interface GroupModel
Parameters:
name - the name of this group

setName

public void setName(String name,
                    Locale locale)
Sets the localized name of this group in the language.

Specified by:
setName in interface GroupModel
Parameters:
name - the localized name of this group
locale - the locale of the language

setName

public void setName(String name,
                    Locale locale,
                    Locale defaultLocale)
Sets the localized name of this group in the language, and sets the default locale.

Specified by:
setName in interface GroupModel
Parameters:
name - the localized name of this group
locale - the locale of the language
defaultLocale - the default locale

setNameCurrentLanguageId

public void setNameCurrentLanguageId(String languageId)
Specified by:
setNameCurrentLanguageId in interface GroupModel

setNameMap

public void setNameMap(Map<Locale,String> nameMap)
Sets the localized names of this group from the map of locales and localized names.

Specified by:
setNameMap in interface GroupModel
Parameters:
nameMap - the locales and localized names of this group

setNameMap

public void setNameMap(Map<Locale,String> nameMap,
                       Locale defaultLocale)
Sets the localized names of this group from the map of locales and localized names, and sets the default locale.

Specified by:
setNameMap in interface GroupModel
Parameters:
nameMap - the locales and localized names of this group
defaultLocale - the default locale

setNew

public void setNew(boolean n)
Description copied from interface: BaseModel
Sets whether this model instance does not yet exist in the database.

Specified by:
setNew in interface BaseModel<Group>
Specified by:
setNew in interface GroupModel
Parameters:
n - whether this model instance does not yet exist in the database

setParentGroupId

public void setParentGroupId(long parentGroupId)
Sets the parent group ID of this group.

Specified by:
setParentGroupId in interface GroupModel
Parameters:
parentGroupId - the parent group ID of this group

setPrimaryKey

public void setPrimaryKey(long primaryKey)
Sets the primary key of this group.

Specified by:
setPrimaryKey in interface GroupModel
Parameters:
primaryKey - the primary key of this group

setPrimaryKeyObj

public void setPrimaryKeyObj(Serializable primaryKeyObj)
Description copied from interface: BaseModel
Sets the primary key of this model instance.

Specified by:
setPrimaryKeyObj in interface BaseModel<Group>
Specified by:
setPrimaryKeyObj in interface ClassedModel
Specified by:
setPrimaryKeyObj in interface GroupModel
Parameters:
primaryKeyObj - the primary key of this model instance

setRemoteStagingGroupCount

public void setRemoteStagingGroupCount(int remoteStagingGroupCount)
Sets the remote staging group count of this group.

Specified by:
setRemoteStagingGroupCount in interface GroupModel
Parameters:
remoteStagingGroupCount - the remote staging group count of this group

setSite

public void setSite(boolean site)
Sets whether this group is site.

Specified by:
setSite in interface GroupModel
Parameters:
site - the site of this group

setTreePath

public void setTreePath(String treePath)
Sets the tree path of this group.

Specified by:
setTreePath in interface GroupModel
Parameters:
treePath - the tree path of this group

setType

public void setType(int type)
Sets the type of this group.

Specified by:
setType in interface GroupModel
Parameters:
type - the type of this group

setTypeSettings

public void setTypeSettings(String typeSettings)
Sets the type settings of this group.

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

setTypeSettingsProperties

public void setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)
Specified by:
setTypeSettingsProperties in interface Group

setUuid

public void setUuid(String uuid)
Sets the uuid of this group.

Specified by:
setUuid in interface GroupModel
Parameters:
uuid - the uuid of this group

toCacheModel

public CacheModel<Group> toCacheModel()
Description copied from interface: BaseModel
Returns a cache model object for this entity used by entity cache.

Specified by:
toCacheModel in interface BaseModel<Group>
Specified by:
toCacheModel in interface GroupModel
Returns:
the cache model object

toEscapedModel

public Group toEscapedModel()
Description copied from interface: BaseModel
Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:
toEscapedModel in interface BaseModel<Group>
Specified by:
toEscapedModel in interface GroupModel
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toString

public String toString()
Specified by:
toString in interface GroupModel
Overrides:
toString in class Object

toUnescapedModel

public Group toUnescapedModel()
Specified by:
toUnescapedModel in interface BaseModel<Group>
Specified by:
toUnescapedModel in interface GroupModel

toXmlString

public String toXmlString()
Description copied from interface: BaseModel
Returns the XML representation of this model instance.

Specified by:
toXmlString in interface BaseModel<Group>
Specified by:
toXmlString in interface GroupModel
Returns:
the XML representation of this model instance

updateTreePath

public void updateTreePath(String treePath)
Specified by:
updateTreePath in interface TreeModel

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

getWrappedModel

public Group getWrappedModel()
Specified by:
getWrappedModel in interface ModelWrapper<Group>

isEntityCacheEnabled

public boolean isEntityCacheEnabled()
Description copied from interface: BaseModel
Returns true if this model's entity cache is enabled.

Specified by:
isEntityCacheEnabled in interface BaseModel<Group>
Returns:
true if this model's entity cache is enabled; false otherwise

isFinderCacheEnabled

public boolean isFinderCacheEnabled()
Description copied from interface: BaseModel
Returns true if this model's finder cache is enabled.

Specified by:
isFinderCacheEnabled in interface BaseModel<Group>
Returns:
true if this model's finder cache is enabled; false otherwise

resetOriginalValues

public void resetOriginalValues()
Description copied from interface: BaseModel
Reset all original fields to current values.

Specified by:
resetOriginalValues in interface BaseModel<Group>

Liferay 7.0-ce-b4