Liferay 6.1.2-ce-ga3

com.liferay.portal.model
Interface UserIdMapperModel

All Superinterfaces:
BaseModel<UserIdMapper>, ClassedModel, Cloneable, Comparable<UserIdMapper>, Serializable
All Known Subinterfaces:
UserIdMapper
All Known Implementing Classes:
UserIdMapperWrapper

public interface UserIdMapperModel
extends BaseModel<UserIdMapper>

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

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

See Also:
UserIdMapper, UserIdMapperImpl, UserIdMapperModelImpl

Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(UserIdMapper userIdMapper)
           
 String getDescription()
          Returns the description of this user ID mapper.
 ExpandoBridge getExpandoBridge()
          Returns the expando bridge for this model instance.
 String getExternalUserId()
          Returns the external user ID of this user ID mapper.
 long getPrimaryKey()
          Returns the primary key of this user ID mapper.
 Serializable getPrimaryKeyObj()
          Returns the primary key of this model instance.
 String getType()
          Returns the type of this user ID mapper.
 long getUserId()
          Returns the user ID of this user ID mapper.
 long getUserIdMapperId()
          Returns the user ID mapper ID of this user ID mapper.
 String getUserUuid()
          Returns the user uuid of this user ID mapper.
 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 setDescription(String description)
          Sets the description of this user ID mapper.
 void setExpandoBridgeAttributes(ServiceContext serviceContext)
          Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
 void setExternalUserId(String externalUserId)
          Sets the external user ID of this user ID mapper.
 void setNew(boolean n)
          Sets whether this model instance does not yet exist in the database.
 void setPrimaryKey(long primaryKey)
          Sets the primary key of this user ID mapper.
 void setPrimaryKeyObj(Serializable primaryKeyObj)
          Sets the primary key of this model instance.
 void setType(String type)
          Sets the type of this user ID mapper.
 void setUserId(long userId)
          Sets the user ID of this user ID mapper.
 void setUserIdMapperId(long userIdMapperId)
          Sets the user ID mapper ID of this user ID mapper.
 void setUserUuid(String userUuid)
          Sets the user uuid of this user ID mapper.
 CacheModel<UserIdMapper> toCacheModel()
          Returns a cache model object for this entity used by entity cache.
 UserIdMapper toEscapedModel()
          Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 UserIdMapper 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

long getPrimaryKey()
Returns the primary key of this user ID mapper.

Returns:
the primary key of this user ID mapper

setPrimaryKey

void setPrimaryKey(long primaryKey)
Sets the primary key of this user ID mapper.

Parameters:
primaryKey - the primary key of this user ID mapper

getUserIdMapperId

long getUserIdMapperId()
Returns the user ID mapper ID of this user ID mapper.

Returns:
the user ID mapper ID of this user ID mapper

setUserIdMapperId

void setUserIdMapperId(long userIdMapperId)
Sets the user ID mapper ID of this user ID mapper.

Parameters:
userIdMapperId - the user ID mapper ID of this user ID mapper

getUserId

long getUserId()
Returns the user ID of this user ID mapper.

Returns:
the user ID of this user ID mapper

setUserId

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

Parameters:
userId - the user ID of this user ID mapper

getUserUuid

String getUserUuid()
                   throws SystemException
Returns the user uuid of this user ID mapper.

Returns:
the user uuid of this user ID mapper
Throws:
SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)
Sets the user uuid of this user ID mapper.

Parameters:
userUuid - the user uuid of this user ID mapper

getType

@AutoEscape
String getType()
Returns the type of this user ID mapper.

Returns:
the type of this user ID mapper

setType

void setType(String type)
Sets the type of this user ID mapper.

Parameters:
type - the type of this user ID mapper

getDescription

@AutoEscape
String getDescription()
Returns the description of this user ID mapper.

Returns:
the description of this user ID mapper

setDescription

void setDescription(String description)
Sets the description of this user ID mapper.

Parameters:
description - the description of this user ID mapper

getExternalUserId

@AutoEscape
String getExternalUserId()
Returns the external user ID of this user ID mapper.

Returns:
the external user ID of this user ID mapper

setExternalUserId

void setExternalUserId(String externalUserId)
Sets the external user ID of this user ID mapper.

Parameters:
externalUserId - the external user ID of this user ID mapper

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<UserIdMapper>
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<UserIdMapper>
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<UserIdMapper>
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<UserIdMapper>
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<UserIdMapper>
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<UserIdMapper>
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<UserIdMapper>
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<UserIdMapper>
Specified by:
getExpandoBridge in interface ClassedModel
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<UserIdMapper>
Parameters:
serviceContext - the service context
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<UserIdMapper>
Returns:
the shallow clone of this model instance

compareTo

int compareTo(UserIdMapper userIdMapper)
Specified by:
compareTo in interface Comparable<UserIdMapper>

hashCode

int hashCode()
Overrides:
hashCode in class Object

toCacheModel

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

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

toEscapedModel

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

toUnescapedModel

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

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

Liferay 6.1.2-ce-ga3