com.liferay.portal.model
Class GroupWrapper

java.lang.Object
  com.liferay.portal.model.GroupWrapper

All Implemented Interfaces:

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

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

This class is a wrapper for Group.

See Also:

Group, Serialized Form

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

Constructor Summary

GroupWrapper(Group group)

Method Summary

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.
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.
long	getDefaultPrivatePlid()
long	getDefaultPublicPlid()
String	getDescription() Returns the description of this group.
String	getDescriptiveName()
String	getDescriptiveName(Locale locale)
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.
Group	getLiveGroup()
long	getLiveGroupId() Returns the live group ID of this group.
Map<String,Object>	getModelAttributes()
Class<?>	getModelClass()
String	getModelClassName()
String	getName() Returns the name of this group.
long	getOrganizationId()
Group	getParentGroup()
long	getParentGroupId() Returns the parent group ID of this group.
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()
boolean	getSite() Returns the site of this group.
Group	getStagingGroup()
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)
Group	getWrappedGroup() Deprecated. Renamed to getWrappedModel()
Group	getWrappedModel()
int	hashCode()
boolean	hasPrivateLayouts()
boolean	hasPublicLayouts()
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	isCommunity() Deprecated. As of 6.1.0, renamed to isRegularSite()
boolean	isCompany()
boolean	isControlPanel()
boolean	isEscapedModel() Returns true if this model instance is escaped.
boolean	isGuest()
boolean	isInStagingPortlet(String portletId)
boolean	isLayout()
boolean	isLayoutPrototype()
boolean	isLayoutSetPrototype()
boolean	isNew() Returns true if this model instance does not yet exist in the database.
boolean	isOrganization()
boolean	isRegularSite()
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	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	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	setLiveGroupId(long liveGroupId) Sets the live group ID of this group.
void	setModelAttributes(Map<String,Object> attributes)
void	setName(String name) Sets the name of this group.
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	setSite(boolean site) Sets whether this group is site.
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)
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.

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>

getPrimaryKey

public long getPrimaryKey()

Returns the primary key of this group.

Specified by:

getPrimaryKey in interface GroupModel

Returns:

the primary key 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

getGroupId

public long getGroupId()

Returns the group ID of this group.

Specified by:

getGroupId in interface GroupModel

Returns:

the group ID 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

getCompanyId

public long getCompanyId()

Returns the company ID of this group.

Specified by:

getCompanyId in interface GroupModel

Returns:

the company ID of this group

setCompanyId

public void setCompanyId(long companyId)

Sets the company ID of this group.

Specified by:

setCompanyId in interface GroupModel

Parameters:

companyId - 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

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

getCreatorUserUuid

public String getCreatorUserUuid()
                          throws SystemException

Returns the creator user uuid of this group.

Specified by:

getCreatorUserUuid in interface GroupModel

Returns:

the creator user uuid of this group

Throws:

SystemException - if a system exception occurred

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

getClassName

public String getClassName()

Returns the fully qualified class name of this group.

Specified by:

getClassName in interface AttachedModel

Specified by:

getClassName in interface GroupModel

Returns:

the fully qualified class name of this group

setClassName

public void setClassName(String className)

Specified by:

setClassName in interface GroupModel

getClassNameId

public long getClassNameId()

Returns the class name ID of this group.

Specified by:

getClassNameId in interface AttachedModel

Specified by:

getClassNameId in interface GroupModel

Returns:

the class name ID of this group

setClassNameId

public void setClassNameId(long classNameId)

Sets the class name ID of this group.

Specified by:

setClassNameId in interface AttachedModel

Specified by:

setClassNameId in interface GroupModel

Parameters:

classNameId - 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

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

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

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

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

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

getName

public String getName()

Returns the name of this group.

Specified by:

getName in interface GroupModel

Returns:

the name 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

getDescription

public String getDescription()

Returns the description of this group.

Specified by:

getDescription in interface GroupModel

Returns:

the description 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

getType

public int getType()

Returns the type of this group.

Specified by:

getType in interface GroupModel

Returns:

the type 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

getTypeSettings

public String getTypeSettings()

Returns the type settings of this group.

Specified by:

getTypeSettings in interface Group

Specified by:

getTypeSettings in interface GroupModel

Returns:

the type settings of this group

setTypeSettings

public void setTypeSettings(String typeSettings)

Sets the type settings of this group.

Specified by:

setTypeSettings in interface Group

Specified by:

setTypeSettings in interface GroupModel

Parameters:

typeSettings - the type settings of this group

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

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

getSite

public boolean getSite()

Returns the site of this group.

Specified by:

getSite in interface GroupModel

Returns:

the site of this group

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

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

getActive

public boolean getActive()

Returns the active of this group.

Specified by:

getActive in interface GroupModel

Returns:

the active of this group

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

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

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

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

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)

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

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

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

Returns:

the primary key of this model instance

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

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

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

See Also:

ServiceContext.getExpandoBridgeAttributes( )

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>

hashCode

public int hashCode()

Specified by:

hashCode in interface GroupModel

Overrides:

hashCode in class Object

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

toUnescapedModel

public Group toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<Group>

Specified by:

toUnescapedModel in interface GroupModel

toString

public String toString()

Specified by:

toString in interface GroupModel

Overrides:

toString in class Object

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

persist

public void persist()
             throws SystemException

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

Throws:

SystemException - if a system exception occurred

getDefaultPrivatePlid

public long getDefaultPrivatePlid()

Specified by:

getDefaultPrivatePlid in interface Group

getDefaultPublicPlid

public long getDefaultPublicPlid()

Specified by:

getDefaultPublicPlid in interface Group

getDescriptiveName

public String getDescriptiveName()
                          throws PortalException,
                                 SystemException

Specified by:

getDescriptiveName in interface Group

Throws:

PortalException

SystemException

getDescriptiveName

public String getDescriptiveName(Locale locale)
                          throws PortalException,
                                 SystemException

Specified by:

getDescriptiveName in interface Group

Throws:

PortalException

SystemException

getLiveGroup

public Group getLiveGroup()

Specified by:

getLiveGroup in interface Group

getOrganizationId

public long getOrganizationId()

Specified by:

getOrganizationId in interface Group

getParentGroup

public Group getParentGroup()
                     throws PortalException,
                            SystemException

Specified by:

getParentGroup in interface Group

Throws:

PortalException

SystemException

getPathFriendlyURL

public String getPathFriendlyURL(boolean privateLayout,
                                 ThemeDisplay themeDisplay)

Specified by:

getPathFriendlyURL in interface Group

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

getStagingGroup

public Group getStagingGroup()

Specified by:

getStagingGroup in interface Group

getTypeLabel

public String getTypeLabel()

Specified by:

getTypeLabel in interface Group

getTypeSettingsProperties

public UnicodeProperties getTypeSettingsProperties()

Specified by:

getTypeSettingsProperties in interface Group

getTypeSettingsProperty

public String getTypeSettingsProperty(String key)

Specified by:

getTypeSettingsProperty in interface Group

hasPrivateLayouts

public boolean hasPrivateLayouts()

Specified by:

hasPrivateLayouts in interface Group

hasPublicLayouts

public boolean hasPublicLayouts()

Specified by:

hasPublicLayouts in interface Group

hasStagingGroup

public boolean hasStagingGroup()

Specified by:

hasStagingGroup in interface Group

isCommunity

public boolean isCommunity()

Deprecated. As of 6.1.0, renamed to isRegularSite()

Specified by:

isCommunity in interface Group

isCompany

public boolean isCompany()

Specified by:

isCompany in interface Group

isControlPanel

public boolean isControlPanel()

Specified by:

isControlPanel in interface Group

isGuest

public boolean isGuest()

Specified by:

isGuest in interface Group

isInStagingPortlet

public boolean isInStagingPortlet(String portletId)

Specified by:

isInStagingPortlet in interface Group

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

isOrganization

public boolean isOrganization()

Specified by:

isOrganization in interface Group

isRegularSite

public boolean isRegularSite()

Specified by:

isRegularSite in interface Group

isShowSite

public boolean isShowSite(PermissionChecker permissionChecker,
                          boolean privateSite)
                   throws PortalException,
                          SystemException

Specified by:

isShowSite in interface Group

Throws:

PortalException

SystemException

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

setTypeSettingsProperties

public void setTypeSettingsProperties(UnicodeProperties typeSettingsProperties)

Specified by:

setTypeSettingsProperties in interface Group

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getWrappedGroup

public Group getWrappedGroup()

Deprecated. Renamed to getWrappedModel()

getWrappedModel

public Group getWrappedModel()

Specified by:

getWrappedModel in interface ModelWrapper<Group>

resetOriginalValues

public void resetOriginalValues()

Description copied from interface: BaseModel

Reset all original fields to current values.

Specified by:

resetOriginalValues in interface BaseModel<Group>