com.liferay.portal.kernel.model

Interface RegionModel

All Superinterfaces:

AuditedModel, BaseModel<Region>, ClassedModel, Cloneable, Comparable<Region>, MVCCModel, Serializable, ShardedModel, StagedAuditedModel, StagedModel

All Known Subinterfaces:

Region

All Known Implementing Classes:

RegionWrapper

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

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 com.liferay.portal.model.impl.RegionModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in com.liferay.portal.model.impl.RegionImpl.

Author:

Brian Wing Shun Chan

See Also:

Region

{$generated.description}

Method Summary

Modifier and Type	Method and Description
Region	cloneWithOriginalValues()
boolean	getActive() Returns the active of this region.
String[]	getAvailableLanguageIds()
long	getCompanyId() Returns the company ID of this region.
long	getCountryId() Returns the country ID of this region.
Date	getCreateDate() Returns the create date of this region.
String	getDefaultLanguageId() Returns the default language ID of this region.
Map<String,String>	getLanguageIdToTitleMap()
Date	getLastPublishDate() Returns the last publish date of this region.
Date	getModifiedDate() Returns the modified date of this region.
long	getMvccVersion() Returns the mvcc version of this region.
String	getName() Returns the name of this region.
double	getPosition() Returns the position of this region.
long	getPrimaryKey() Returns the primary key of this region.
String	getRegionCode() Returns the region code of this region.
long	getRegionId() Returns the region ID of this region.
String	getTitle()
String	getTitle(String languageId)
String	getTitle(String languageId, boolean useDefault)
String	getTitleMapAsXML()
long	getUserId() Returns the user ID of this region.
String	getUserName() Returns the user name of this region.
String	getUserUuid() Returns the user uuid of this region.
String	getUuid() Returns the uuid of this region.
boolean	isActive() Returns true if this region is active.
void	setActive(boolean active) Sets whether this region is active.
void	setCompanyId(long companyId) Sets the company ID of this region.
void	setCountryId(long countryId) Sets the country ID of this region.
void	setCreateDate(Date createDate) Sets the create date of this region.
void	setDefaultLanguageId(String defaultLanguageId) Sets the default language ID of this region.
void	setLastPublishDate(Date lastPublishDate) Sets the last publish date of this region.
void	setModifiedDate(Date modifiedDate) Sets the modified date of this region.
void	setMvccVersion(long mvccVersion) Sets the mvcc version of this region.
void	setName(String name) Sets the name of this region.
void	setPosition(double position) Sets the position of this region.
void	setPrimaryKey(long primaryKey) Sets the primary key of this region.
void	setRegionCode(String regionCode) Sets the region code of this region.
void	setRegionId(long regionId) Sets the region ID of this region.
void	setUserId(long userId) Sets the user ID of this region.
void	setUserName(String userName) Sets the user name of this region.
void	setUserUuid(String userUuid) Sets the user uuid of this region.
void	setUuid(String uuid) Sets the uuid of this region.

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

clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel, toXmlString

Methods inherited from interface Comparable

compareTo

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

clone, getStagedModelType

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

getUuid

@AutoEscape
String getUuid()

Returns the uuid of this region.

Specified by:

getUuid in interface StagedModel

Returns:

the uuid of this region

setUuid

void setUuid(String uuid)

Sets the uuid of this region.

Specified by:

setUuid in interface StagedModel

Parameters:

uuid - the uuid of this region

getDefaultLanguageId

@AutoEscape
String getDefaultLanguageId()

Returns the default language ID of this region.

Returns:

the default language ID of this region

setDefaultLanguageId

void setDefaultLanguageId(String defaultLanguageId)

Sets the default language ID of this region.

Parameters:

defaultLanguageId - the default language ID 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

getCompanyId

long getCompanyId()

Returns the company ID of this region.

Specified by:

getCompanyId in interface AuditedModel

Specified by:

getCompanyId in interface ShardedModel

Specified by:

getCompanyId in interface StagedModel

Returns:

the company ID of this region

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this region.

Specified by:

setCompanyId in interface AuditedModel

Specified by:

setCompanyId in interface ShardedModel

Specified by:

setCompanyId in interface StagedModel

Parameters:

companyId - the company ID of this region

getUserId

long getUserId()

Returns the user ID of this region.

Specified by:

getUserId in interface AuditedModel

Returns:

the user ID of this region

setUserId

void setUserId(long userId)

Sets the user ID of this region.

Specified by:

setUserId in interface AuditedModel

Parameters:

userId - the user ID of this region

getUserUuid

String getUserUuid()

Returns the user uuid of this region.

Specified by:

getUserUuid in interface AuditedModel

Returns:

the user uuid of this region

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this region.

Specified by:

setUserUuid in interface AuditedModel

Parameters:

userUuid - the user uuid of this region

getUserName

@AutoEscape
String getUserName()

Returns the user name of this region.

Specified by:

getUserName in interface AuditedModel

Returns:

the user name of this region

setUserName

void setUserName(String userName)

Sets the user name of this region.

Specified by:

setUserName in interface AuditedModel

Parameters:

userName - the user name of this region

getCreateDate

Date getCreateDate()

Returns the create date of this region.

Specified by:

getCreateDate in interface AuditedModel

Specified by:

getCreateDate in interface StagedModel

Returns:

the create date of this region

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this region.

Specified by:

setCreateDate in interface AuditedModel

Specified by:

setCreateDate in interface StagedModel

Parameters:

createDate - the create date of this region

getModifiedDate

Date getModifiedDate()

Returns the modified date of this region.

Specified by:

getModifiedDate in interface AuditedModel

Specified by:

getModifiedDate in interface StagedModel

Returns:

the modified date of this region

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this region.

Specified by:

setModifiedDate in interface AuditedModel

Specified by:

setModifiedDate in interface StagedModel

Parameters:

modifiedDate - the modified date 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

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

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

getPosition

double getPosition()

Returns the position of this region.

Returns:

the position of this region

setPosition

void setPosition(double position)

Sets the position of this region.

Parameters:

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

getLastPublishDate

Date getLastPublishDate()

Returns the last publish date of this region.

Returns:

the last publish date of this region

setLastPublishDate

void setLastPublishDate(Date lastPublishDate)

Sets the last publish date of this region.

Parameters:

lastPublishDate - the last publish date of this region

getAvailableLanguageIds

String[] getAvailableLanguageIds()

getTitle

String getTitle()

getTitle

String getTitle(String languageId)

getTitle

String getTitle(String languageId,
                boolean useDefault)

getTitleMapAsXML

String getTitleMapAsXML()

getLanguageIdToTitleMap

Map<String,String> getLanguageIdToTitleMap()

cloneWithOriginalValues

Region cloneWithOriginalValues()

Specified by:

cloneWithOriginalValues in interface BaseModel<Region>