Liferay 6.0.3

com.liferay.portal.model
Interface UserGroupModel

All Superinterfaces:
BaseModel<UserGroup>, Cloneable, Comparable<UserGroup>, Serializable
All Known Subinterfaces:
UserGroup
All Known Implementing Classes:
UserGroupImpl, UserGroupModelImpl, UserGroupWrapper

public interface UserGroupModel
extends BaseModel<UserGroup>

This interface is a model that represents the UserGroup table in the database.

See Also:
UserGroup, UserGroupImpl, UserGroupModelImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(UserGroup userGroup)
           
 long getCompanyId()
           
 String getDescription()
           
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 String getName()
           
 long getParentUserGroupId()
           
 long getPrimaryKey()
           
 Serializable getPrimaryKeyObj()
          Gets the primary key for this model instance.
 long getUserGroupId()
           
 int hashCode()
           
 boolean isCachedModel()
          Determines if this model instance was retrieved from the entity cache.
 boolean isEscapedModel()
          Determines if this model instance has been wrapped with an HTML auto escape handler.
 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)
           
 void setDescription(String description)
           
 void setEscapedModel(boolean escapedModel)
          Sets whether this model instance has been wrapped with an HTML auto escape handler.
 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)
           
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setParentUserGroupId(long parentUserGroupId)
           
 void setPrimaryKey(long pk)
           
 void setUserGroupId(long userGroupId)
           
 UserGroup toEscapedModel()
           
 String toString()
           
 String toXmlString()
          Gets the XML representation of this model instance.
 

Method Detail

getPrimaryKey

long getPrimaryKey()

setPrimaryKey

void setPrimaryKey(long pk)

getUserGroupId

long getUserGroupId()

setUserGroupId

void setUserGroupId(long userGroupId)

getCompanyId

long getCompanyId()

setCompanyId

void setCompanyId(long companyId)

getParentUserGroupId

long getParentUserGroupId()

setParentUserGroupId

void setParentUserGroupId(long parentUserGroupId)

getName

String getName()

setName

void setName(String name)

getDescription

String getDescription()

setDescription

void setDescription(String description)

toEscapedModel

UserGroup toEscapedModel()

isNew

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>
Returns:
true if this model instance does not yet exist in the database; false otherwise

setNew

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>
Parameters:
n - whether this model instance does not yet exist in the database

isCachedModel

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>
Returns:
true if this model instance was retrieved from the entity cache; false otherwise
See Also:
BaseModel.setCachedModel(boolean)

setCachedModel

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>
Parameters:
cachedModel - whether this model instance was retrieved from the entity cache
See Also:
EntityCache

isEscapedModel

boolean isEscapedModel()
Description copied from interface: BaseModel
Determines if this model instance has been wrapped with an HTML auto escape handler.

Specified by:
isEscapedModel in interface BaseModel<UserGroup>
Returns:
true if this model instance has been wrapped with an HTML auto escape handler; false otherwise
See Also:
BaseModel.setEscapedModel(boolean)

setEscapedModel

void setEscapedModel(boolean escapedModel)
Description copied from interface: BaseModel
Sets whether this model instance has been wrapped with an HTML auto escape handler.

A model instance can be wrapped with an HTML auto escape handler using its toEscapedModel method. For example, UserModel.toEscapedModel().

Specified by:
setEscapedModel in interface BaseModel<UserGroup>
Parameters:
escapedModel - whether this model instance has been wrapped with an HTML auto escape handler
See Also:
AutoEscapeBeanHandler

getPrimaryKeyObj

Serializable getPrimaryKeyObj()
Description copied from interface: BaseModel
Gets the primary key for this model instance.

Specified by:
getPrimaryKeyObj in interface BaseModel<UserGroup>
Returns:
the primary key

getExpandoBridge

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

Specified by:
getExpandoBridge in interface BaseModel<UserGroup>
Returns:
the expando bridge

setExpandoBridgeAttributes

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>
Parameters:
serviceContext - the service context to retrieve the expando bridge attributes from
See Also:
ServiceContext.getExpandoBridgeAttributes( )

clone

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

Specified by:
clone in interface BaseModel<UserGroup>
Returns:
the clone

compareTo

int compareTo(UserGroup userGroup)
Specified by:
compareTo in interface Comparable<UserGroup>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toString

String toString()
Overrides:
toString in class Object

toXmlString

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

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

Liferay 6.0.3