Liferay 6.0.5

com.liferay.portal.model
Interface UserGroupRoleModel

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

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.

Never modify or reference this interface directly. All methods that expect a user group role model instance should use the UserGroupRole interface instead.

See Also:
UserGroupRole, UserGroupRoleImpl, UserGroupRoleModelImpl
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(UserGroupRole userGroupRole)
           
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 long getGroupId()
          Gets the group id of this user group role.
 UserGroupRolePK getPrimaryKey()
          Gets the primary key of this user group role.
 Serializable getPrimaryKeyObj()
          Gets the primary key of this model instance.
 long getRoleId()
          Gets the role id of this user group role.
 long getUserId()
          Gets the user id of this user group role.
 String getUserUuid()
          Gets the user uuid of this user group role.
 int hashCode()
           
 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 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 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 pk)
          Sets the primary key of this user group role
 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.
 UserGroupRole toEscapedModel()
          Gets a copy of this user group role as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 String toXmlString()
          Gets the XML representation of this model instance.
 

Method Detail

getPrimaryKey

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

Returns:
the primary key of this user group role

setPrimaryKey

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

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

getUserId

long getUserId()
Gets 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
Gets 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()
Gets 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()
Gets 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

toEscapedModel

UserGroupRole toEscapedModel()
Gets a copy of this user group role as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

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<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
Determines 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
Determines if this model instance is escaped.

Specified by:
isEscapedModel in interface BaseModel<UserGroupRole>
Returns:
true if this model instance is escaped; false otherwise
See Also:
BaseModel.setEscapedModel(boolean)

setEscapedModel

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<UserGroupRole>
Parameters:
escapedModel - whether this model instance is escaped
See Also:
AutoEscapeBeanHandler

getPrimaryKeyObj

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

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

getExpandoBridge

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

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

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

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<UserGroupRole>
Returns:
the XML representation of this model instance

Liferay 6.0.5