com.liferay.portal.model
Class UserGroupWrapper

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

All Implemented Interfaces:

BaseModel<UserGroup>, UserGroup, UserGroupModel, Serializable, Cloneable, Comparable<UserGroup>

public class UserGroupWrapper
extends Object
implements UserGroup

This class is a wrapper for UserGroup.

See Also:

UserGroup, Serialized Form

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

Constructor Summary

UserGroupWrapper(UserGroup userGroup)

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(UserGroup userGroup)
long	getCompanyId() Gets the company id of this user group.
String	getDescription() Gets the description of this user group.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
Group	getGroup()
String	getName() Gets the name of this user group.
long	getParentUserGroupId() Gets the parent user group id of this user group.
long	getPrimaryKey() Gets the primary key of this user group.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
int	getPrivateLayoutsPageCount()
int	getPublicLayoutsPageCount()
long	getUserGroupId() Gets the user group id of this user group.
UserGroup	getWrappedUserGroup()
int	hashCode()
boolean	hasPrivateLayouts()
boolean	hasPublicLayouts()
boolean	isCachedModel() Determines if this model instance was retrieved from the entity cache.
boolean	isEscapedModel() Determines if this model instance is escaped.
boolean	isNew() Determines if this model instance does not yet exist in the database.
void	setCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.
void	setCompanyId(long companyId) Sets the company id of this user group.
void	setDescription(String description) Sets the description of this user group.
void	setEscapedModel(boolean escapedModel) Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.
void	setExpandoBridgeAttributes(ServiceContext serviceContext) Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
void	setName(String name) Sets the name of this user group.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setParentUserGroupId(long parentUserGroupId) Sets the parent user group id of this user group.
void	setPrimaryKey(long pk) Sets the primary key of this user group
void	setUserGroupId(long userGroupId) Sets the user group id of this user group.
UserGroup	toEscapedModel() Gets a copy of this user group as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
String	toXmlString() Gets the XML representation of this model instance.

Methods inherited from class java.lang.Object

equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UserGroupWrapper

public UserGroupWrapper(UserGroup userGroup)

Method Detail

getPrimaryKey

public long getPrimaryKey()

Description copied from interface: UserGroupModel

Gets the primary key of this user group.

Specified by:

getPrimaryKey in interface UserGroupModel

Returns:

the primary key of this user group

setPrimaryKey

public void setPrimaryKey(long pk)

Description copied from interface: UserGroupModel

Sets the primary key of this user group

Specified by:

setPrimaryKey in interface UserGroupModel

Parameters:

pk - the primary key of this user group

getUserGroupId

public long getUserGroupId()

Description copied from interface: UserGroupModel

Gets the user group id of this user group.

Specified by:

getUserGroupId in interface UserGroupModel

Returns:

the user group id of this user group

setUserGroupId

public void setUserGroupId(long userGroupId)

Description copied from interface: UserGroupModel

Sets the user group id of this user group.

Specified by:

setUserGroupId in interface UserGroupModel

Parameters:

userGroupId - the user group id of this user group

getCompanyId

public long getCompanyId()

Description copied from interface: UserGroupModel

Gets the company id of this user group.

Specified by:

getCompanyId in interface UserGroupModel

Returns:

the company id of this user group

setCompanyId

public void setCompanyId(long companyId)

Description copied from interface: UserGroupModel

Sets the company id of this user group.

Specified by:

setCompanyId in interface UserGroupModel

Parameters:

companyId - the company id of this user group

getParentUserGroupId

public long getParentUserGroupId()

Description copied from interface: UserGroupModel

Gets the parent user group id of this user group.

Specified by:

getParentUserGroupId in interface UserGroupModel

Returns:

the parent user group id of this user group

setParentUserGroupId

public void setParentUserGroupId(long parentUserGroupId)

Description copied from interface: UserGroupModel

Sets the parent user group id of this user group.

Specified by:

setParentUserGroupId in interface UserGroupModel

Parameters:

parentUserGroupId - the parent user group id of this user group

getName

public String getName()

Description copied from interface: UserGroupModel

Gets the name of this user group.

Specified by:

getName in interface UserGroupModel

Returns:

the name of this user group

setName

public void setName(String name)

Description copied from interface: UserGroupModel

Sets the name of this user group.

Specified by:

setName in interface UserGroupModel

Parameters:

name - the name of this user group

getDescription

public String getDescription()

Description copied from interface: UserGroupModel

Gets the description of this user group.

Specified by:

getDescription in interface UserGroupModel

Returns:

the description of this user group

setDescription

public void setDescription(String description)

Description copied from interface: UserGroupModel

Sets the description of this user group.

Specified by:

setDescription in interface UserGroupModel

Parameters:

description - the description of this user group

toEscapedModel

public UserGroup toEscapedModel()

Description copied from interface: UserGroupModel

Gets a copy of this user group as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:

toEscapedModel in interface UserGroupModel

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

isNew

public boolean isNew()

Description copied from interface: BaseModel

Determines if this model instance does not yet exist in the database.

Specified by:

isNew in interface BaseModel<UserGroup>

Specified by:

isNew in interface UserGroupModel

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

Specified by:

setNew in interface UserGroupModel

Parameters:

n - whether this model instance does not yet exist in the database

isCachedModel

public boolean isCachedModel()

Description copied from interface: BaseModel

Determines if this model instance was retrieved from the entity cache.

Specified by:

isCachedModel in interface BaseModel<UserGroup>

Specified by:

isCachedModel in interface UserGroupModel

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

Specified by:

setCachedModel in interface UserGroupModel

Parameters:

cachedModel - whether this model instance was retrieved from the entity cache

See Also:

EntityCache

isEscapedModel

public boolean isEscapedModel()

Description copied from interface: BaseModel

Determines if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<UserGroup>

Specified by:

isEscapedModel in interface UserGroupModel

Returns:

true if this model instance is escaped; false otherwise

See Also:

BaseModel.setEscapedModel(boolean)

setEscapedModel

public void setEscapedModel(boolean escapedModel)

Description copied from interface: BaseModel

Sets whether this model instance is escaped, meaning that all strings returned from getter methods are HTML safe.

A model instance can be made escaped by wrapping it with an HTML auto escape handler using its toEscapedModel method. For example, UserModel.toEscapedModel().

Specified by:

setEscapedModel in interface BaseModel<UserGroup>

Specified by:

setEscapedModel in interface UserGroupModel

Parameters:

escapedModel - whether this model instance is escaped

See Also:

AutoEscapeBeanHandler

getPrimaryKeyObj

public Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Gets the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<UserGroup>

Specified by:

getPrimaryKeyObj in interface UserGroupModel

Returns:

the primary key of this model instance

getExpandoBridge

public ExpandoBridge getExpandoBridge()

Description copied from interface: BaseModel

Gets the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface BaseModel<UserGroup>

Specified by:

getExpandoBridge in interface UserGroupModel

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

Specified by:

setExpandoBridgeAttributes in interface UserGroupModel

Parameters:

serviceContext - the service context to retrieve the expando bridge attributes from

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

Specified by:

clone in interface UserGroupModel

Overrides:

clone in class Object

Returns:

the shallow clone of this model instance

compareTo

public int compareTo(UserGroup userGroup)

Specified by:

compareTo in interface UserGroupModel

Specified by:

compareTo in interface Comparable<UserGroup>

hashCode

public int hashCode()

Specified by:

hashCode in interface UserGroupModel

Overrides:

hashCode in class Object

toString

public String toString()

Specified by:

toString in interface UserGroupModel

Overrides:

toString in class Object

toXmlString

public String toXmlString()

Description copied from interface: BaseModel

Gets the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<UserGroup>

Specified by:

toXmlString in interface UserGroupModel

Returns:

the XML representation of this model instance

getGroup

public Group getGroup()
               throws PortalException,
                      SystemException

Specified by:

getGroup in interface UserGroup

Throws:

PortalException

SystemException

getPrivateLayoutsPageCount

public int getPrivateLayoutsPageCount()
                               throws PortalException,
                                      SystemException

Specified by:

getPrivateLayoutsPageCount in interface UserGroup

Throws:

PortalException

SystemException

hasPrivateLayouts

public boolean hasPrivateLayouts()
                          throws PortalException,
                                 SystemException

Specified by:

hasPrivateLayouts in interface UserGroup

Throws:

PortalException

SystemException

getPublicLayoutsPageCount

public int getPublicLayoutsPageCount()
                              throws PortalException,
                                     SystemException

Specified by:

getPublicLayoutsPageCount in interface UserGroup

Throws:

PortalException

SystemException

hasPublicLayouts

public boolean hasPublicLayouts()
                         throws PortalException,
                                SystemException

Specified by:

hasPublicLayouts in interface UserGroup

Throws:

PortalException

SystemException

getWrappedUserGroup

public UserGroup getWrappedUserGroup()