com.liferay.portal.model
Class UserGroupWrapper

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

All Implemented Interfaces:

BaseModel<UserGroup>, ClassedModel, ModelWrapper<UserGroup>, PersistedModel, UserGroup, UserGroupModel, Serializable, Cloneable, Comparable<UserGroup>

public class UserGroupWrapper
extends Object
implements UserGroup, ModelWrapper<UserGroup>

This class is a wrapper for UserGroup.

See Also:

UserGroup, Serialized Form

Field Summary

Fields inherited from interface com.liferay.portal.model.UserGroup

NAME_ACCESSOR

Constructor Summary

UserGroupWrapper(UserGroup userGroup)

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(UserGroup userGroup)
boolean	equals(Object obj)
boolean	getAddedByLDAPImport() Returns the added by l d a p import of this user group.
long	getCompanyId() Returns the company ID of this user group.
String	getDescription() Returns the description of this user group.
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
Group	getGroup()
Map<String,Object>	getModelAttributes()
Class<?>	getModelClass()
String	getModelClassName()
String	getName() Returns the name of this user group.
long	getParentUserGroupId() Returns the parent user group ID of this user group.
long	getPrimaryKey() Returns the primary key of this user group.
Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
int	getPrivateLayoutsPageCount()
int	getPublicLayoutsPageCount()
long	getUserGroupId() Returns the user group ID of this user group.
UserGroup	getWrappedModel()
UserGroup	getWrappedUserGroup() Deprecated. Renamed to getWrappedModel()
int	hashCode()
boolean	hasPrivateLayouts()
boolean	hasPublicLayouts()
boolean	isAddedByLDAPImport() Returns true if this user group is added by l d a p import.
boolean	isCachedModel() Returns true if this model instance was retrieved from the entity cache.
boolean	isEscapedModel() Returns true if this model instance is escaped.
boolean	isNew() Returns true if this model instance does not yet exist in the database.
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	setAddedByLDAPImport(boolean addedByLDAPImport) Sets whether this user group is added by l d a p import.
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	setExpandoBridgeAttributes(ServiceContext serviceContext) Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
void	setModelAttributes(Map<String,Object> attributes)
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 primaryKey) Sets the primary key of this user group.
void	setPrimaryKeyObj(Serializable primaryKeyObj) Sets the primary key of this model instance.
void	setUserGroupId(long userGroupId) Sets the user group ID of this user group.
CacheModel<UserGroup>	toCacheModel() Returns a cache model object for this entity used by entity cache.
UserGroup	toEscapedModel() Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
UserGroup	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

UserGroupWrapper

public UserGroupWrapper(UserGroup userGroup)

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

setModelAttributes

public void setModelAttributes(Map<String,Object> attributes)

Specified by:

setModelAttributes in interface BaseModel<UserGroup>

getPrimaryKey

public long getPrimaryKey()

Returns 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 primaryKey)

Sets the primary key of this user group.

Specified by:

setPrimaryKey in interface UserGroupModel

Parameters:

primaryKey - the primary key of this user group

getUserGroupId

public long getUserGroupId()

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

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

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

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

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

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

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

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

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

Sets the description of this user group.

Specified by:

setDescription in interface UserGroupModel

Parameters:

description - the description of this user group

getAddedByLDAPImport

public boolean getAddedByLDAPImport()

Returns the added by l d a p import of this user group.

Specified by:

getAddedByLDAPImport in interface UserGroupModel

Returns:

the added by l d a p import of this user group

isAddedByLDAPImport

public boolean isAddedByLDAPImport()

Returns true if this user group is added by l d a p import.

Specified by:

isAddedByLDAPImport in interface UserGroupModel

Returns:

true if this user group is added by l d a p import; false otherwise

setAddedByLDAPImport

public void setAddedByLDAPImport(boolean addedByLDAPImport)

Sets whether this user group is added by l d a p import.

Specified by:

setAddedByLDAPImport in interface UserGroupModel

Parameters:

addedByLDAPImport - the added by l d a p import of this user 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<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

Returns true 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

Returns true 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

getPrimaryKeyObj

public Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Returns the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<UserGroup>

Specified by:

getPrimaryKeyObj in interface ClassedModel

Specified by:

getPrimaryKeyObj in interface UserGroupModel

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

Specified by:

setPrimaryKeyObj in interface ClassedModel

Specified by:

setPrimaryKeyObj in interface UserGroupModel

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

Specified by:

getExpandoBridge in interface ClassedModel

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

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

toCacheModel

public CacheModel<UserGroup> toCacheModel()

Description copied from interface: BaseModel

Returns a cache model object for this entity used by entity cache.

Specified by:

toCacheModel in interface BaseModel<UserGroup>

Specified by:

toCacheModel in interface UserGroupModel

Returns:

the cache model object

toEscapedModel

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

Specified by:

toEscapedModel in interface UserGroupModel

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

public UserGroup toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<UserGroup>

Specified by:

toUnescapedModel in interface UserGroupModel

toString

public String toString()

Specified by:

toString in interface UserGroupModel

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

Specified by:

toXmlString in interface UserGroupModel

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

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

getPublicLayoutsPageCount

public int getPublicLayoutsPageCount()
                              throws PortalException,
                                     SystemException

Specified by:

getPublicLayoutsPageCount in interface UserGroup

Throws:

PortalException

SystemException

hasPrivateLayouts

public boolean hasPrivateLayouts()
                          throws PortalException,
                                 SystemException

Specified by:

hasPrivateLayouts in interface UserGroup

Throws:

PortalException

SystemException

hasPublicLayouts

public boolean hasPublicLayouts()
                         throws PortalException,
                                SystemException

Specified by:

hasPublicLayouts in interface UserGroup

Throws:

PortalException

SystemException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getWrappedUserGroup

public UserGroup getWrappedUserGroup()

Deprecated. Renamed to getWrappedModel()

getWrappedModel

public UserGroup getWrappedModel()

Specified by:

getWrappedModel in interface ModelWrapper<UserGroup>

resetOriginalValues

public void resetOriginalValues()

Description copied from interface: BaseModel

Reset all original fields to current values.

Specified by:

resetOriginalValues in interface BaseModel<UserGroup>