Liferay 6.2-ce-ga5

com.liferay.portal.model
Interface UserGroupRoleModel

All Superinterfaces:
BaseModel<UserGroupRole>, ClassedModel, Cloneable, Comparable<UserGroupRole>, Serializable
All Known Subinterfaces:
UserGroupRole
All Known Implementing Classes:
UserGroupRoleBaseImpl, UserGroupRoleImpl, UserGroupRoleModelImpl, UserGroupRoleWrapper

@ProviderType
public interface UserGroupRoleModel
extends BaseModel<UserGroupRole>

The base model interface for the UserGroupRole service. Represents a row in the "UserGroupRole" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation UserGroupRoleModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in UserGroupRoleImpl.

See Also:
UserGroupRole, UserGroupRoleImpl, UserGroupRoleModelImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(UserGroupRole userGroupRole)
           
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 long getGroupId()
          Returns the group ID of this user group role.
 UserGroupRolePK getPrimaryKey()
          Returns the primary key of this user group role.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 long getRoleId()
          Returns the role ID of this user group role.
 long getUserId()
          Returns the user ID of this user group role.
 String getUserUuid()
          Returns the user uuid of this user group role.
 int hashCode()
           
 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 setCachedModel(boolean cachedModel)
          Sets whether this model instance was retrieved from the entity cache.
 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 setGroupId(long groupId)
          Sets the group ID of this user group role.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setPrimaryKey(UserGroupRolePK primaryKey)
          Sets the primary key of this user group role.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setRoleId(long roleId)
          Sets the role ID of this user group role.
 void setUserId(long userId)
          Sets the user ID of this user group role.
 void setUserUuid(String userUuid)
          Sets the user uuid of this user group role.
 CacheModel<UserGroupRole> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 UserGroupRole toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 UserGroupRole toUnescapedModel()
           
 String toXmlString()
          Returns the XML representation of this model instance.
 
Methods inherited from interface com.liferay.portal.model.BaseModel
getModelAttributes, resetOriginalValues, setModelAttributes
 
Methods inherited from interface com.liferay.portal.model.ClassedModel
getModelClass, getModelClassName
 

Method Detail

getPrimaryKey

UserGroupRolePK getPrimaryKey()
Returns the primary key of this user group role.

Returns:
the primary key of this user group role

setPrimaryKey

void setPrimaryKey(UserGroupRolePK primaryKey)
Sets the primary key of this user group role.

Parameters:
primaryKey - the primary key of this user group role

getUserId

long getUserId()
Returns the user ID of this user group role.

Returns:
the user ID of this user group role

setUserId

void setUserId(long userId)
Sets the user ID of this user group role.

Parameters:
userId - the user ID of this user group role

getUserUuid

String getUserUuid()
                   throws SystemException
Returns the user uuid of this user group role.

Returns:
the user uuid of this user group role
Throws:
SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)
Sets the user uuid of this user group role.

Parameters:
userUuid - the user uuid of this user group role

getGroupId

long getGroupId()
Returns the group ID of this user group role.

Returns:
the group ID of this user group role

setGroupId

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

Parameters:
groupId - the group ID of this user group role

getRoleId

long getRoleId()
Returns the role ID of this user group role.

Returns:
the role ID of this user group role

setRoleId

void setRoleId(long roleId)
Sets the role ID of this user group role.

Parameters:
roleId - the role ID of this user group role

isNew

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

isCachedModel

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

isEscapedModel

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

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

getPrimaryKeyObj

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

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

setPrimaryKeyObj

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

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

getExpandoBridge

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

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

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(BaseModel<?> baseModel)
Specified by:
setExpandoBridgeAttributes in interface BaseModel<UserGroupRole>

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
Specified by:
setExpandoBridgeAttributes in interface BaseModel<UserGroupRole>

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<UserGroupRole>
Parameters:
serviceContext - the service context to be applied
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<UserGroupRole>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(UserGroupRole userGroupRole)
Specified by:
compareTo in interface Comparable<UserGroupRole>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

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

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

toEscapedModel

UserGroupRole 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<UserGroupRole>
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

toUnescapedModel

UserGroupRole toUnescapedModel()
Specified by:
toUnescapedModel in interface BaseModel<UserGroupRole>

toString

String toString()
Overrides:
toString in class Object

toXmlString

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

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

Liferay 6.2-ce-ga5