com.liferay.portal.kernel.model

Interface RegionModel

All Superinterfaces:

BaseModel<Region>, ClassedModel, Cloneable, Comparable<Region>, MVCCModel, Serializable

All Known Subinterfaces:

Region

All Known Implementing Classes:

RegionWrapper

@ProviderType
public interface RegionModel
extends BaseModel<Region>, MVCCModel

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

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

Author:

Brian Wing Shun Chan

See Also:

Region, RegionImpl, RegionModelImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
Object	clone() Creates a shallow clone of this model instance.
int	compareTo(Region region)
boolean	getActive() Returns the active of this region.
long	getCountryId() Returns the country ID of this region.
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
long	getMvccVersion() Returns the mvcc version of this region.
String	getName() Returns the name of this region.
long	getPrimaryKey() Returns the primary key of this region.
Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
String	getRegionCode() Returns the region code of this region.
long	getRegionId() Returns the region ID of this region.
int	hashCode()
boolean	isActive() Returns true if this region is active.
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	setActive(boolean active) Sets whether this region is active.
void	setCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.
void	setCountryId(long countryId) Sets the country ID of this region.
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	setMvccVersion(long mvccVersion) Sets the mvcc version of this region.
void	setName(String name) Sets the name of this region.
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 region.
void	setPrimaryKeyObj(Serializable primaryKeyObj) Sets the primary key of this model instance.
void	setRegionCode(String regionCode) Sets the region code of this region.
void	setRegionId(long regionId) Sets the region ID of this region.
CacheModel<Region>	toCacheModel() Returns a cache model object for this entity used by entity cache.
Region	toEscapedModel() Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
Region	toUnescapedModel()
String	toXmlString() Returns the XML representation of this model instance.

Methods inherited from interface com.liferay.portal.kernel.model.BaseModel

getModelAttributes, isEntityCacheEnabled, isFinderCacheEnabled, resetOriginalValues, setModelAttributes

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

getModelClass, getModelClassName

Method Detail

getPrimaryKey

long getPrimaryKey()

Returns the primary key of this region.

Returns:

the primary key of this region

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this region.

Parameters:

primaryKey - the primary key of this region

getMvccVersion

long getMvccVersion()

Returns the mvcc version of this region.

Specified by:

getMvccVersion in interface MVCCModel

Returns:

the mvcc version of this region

setMvccVersion

void setMvccVersion(long mvccVersion)

Sets the mvcc version of this region.

Specified by:

setMvccVersion in interface MVCCModel

Parameters:

mvccVersion - the mvcc version of this region

getRegionId

long getRegionId()

Returns the region ID of this region.

Returns:

the region ID of this region

setRegionId

void setRegionId(long regionId)

Sets the region ID of this region.

Parameters:

regionId - the region ID of this region

getCountryId

long getCountryId()

Returns the country ID of this region.

Returns:

the country ID of this region

setCountryId

void setCountryId(long countryId)

Sets the country ID of this region.

Parameters:

countryId - the country ID of this region

getRegionCode

@AutoEscape
String getRegionCode()

Returns the region code of this region.

Returns:

the region code of this region

setRegionCode

void setRegionCode(String regionCode)

Sets the region code of this region.

Parameters:

regionCode - the region code of this region

getName

@AutoEscape
String getName()

Returns the name of this region.

Returns:

the name of this region

setName

void setName(String name)

Sets the name of this region.

Parameters:

name - the name of this region

getActive

boolean getActive()

Returns the active of this region.

Returns:

the active of this region

isActive

boolean isActive()

Returns true if this region is active.

Returns:

true if this region is active; false otherwise

setActive

void setActive(boolean active)

Sets whether this region is active.

Parameters:

active - the active of this region

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

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

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

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

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

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

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

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

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

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<Region>

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

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

Returns:

the shallow clone of this model instance

compareTo

int compareTo(Region region)

Specified by:

compareTo in interface Comparable<Region>

hashCode

int hashCode()

Overrides:

hashCode in class Object

toCacheModel

CacheModel<Region> toCacheModel()

Description copied from interface: BaseModel

Returns a cache model object for this entity used by entity cache.

Specified by:

toCacheModel in interface BaseModel<Region>

Returns:

the cache model object

toEscapedModel

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

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

Region toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<Region>

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

Returns:

the XML representation of this model instance