com.liferay.portal.model
Interface UserIdMapperModel

All Superinterfaces:

BaseModel<UserIdMapper>, Cloneable, Comparable<UserIdMapper>, Serializable

All Known Subinterfaces:

UserIdMapper

All Known Implementing Classes:

UserIdMapperImpl, UserIdMapperModelImpl, 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.

Never modify or reference this interface directly. All methods that expect a user id mapper model instance should use the UserIdMapper interface instead.

See Also:

UserIdMapper, UserIdMapperImpl, UserIdMapperModelImpl

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(UserIdMapper userIdMapper)
String	getDescription() Gets the description of this user id mapper.
ExpandoBridge	getExpandoBridge() Gets the expando bridge for this model instance.
String	getExternalUserId() Gets the external user id of this user id mapper.
long	getPrimaryKey() Gets the primary key of this user id mapper.
Serializable	getPrimaryKeyObj() Gets the primary key of this model instance.
String	getType() Gets the type of this user id mapper.
long	getUserId() Gets the user id of this user id mapper.
long	getUserIdMapperId() Gets the user id mapper id of this user id mapper.
String	getUserUuid() Gets the user uuid of this user id mapper.
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	setDescription(String description) Sets the description of this user id mapper.
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	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 pk) Sets the primary key of this user id mapper
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.
UserIdMapper	toEscapedModel() Gets a copy of this user id mapper 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

long getPrimaryKey()

Gets the primary key of this user id mapper.

Returns:

the primary key of this user id mapper

setPrimaryKey

void setPrimaryKey(long pk)

Sets the primary key of this user id mapper

Parameters:

pk - the primary key of this user id mapper

getUserIdMapperId

long getUserIdMapperId()

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

Gets 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

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

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

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

Gets 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

toEscapedModel

UserIdMapper toEscapedModel()

Gets a copy of this user id mapper 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<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

Determines 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

Determines if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<UserIdMapper>

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

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

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

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

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

Returns:

the XML representation of this model instance