com.liferay.portal.kernel.model

Class RegionWrapper

Object

com.liferay.portal.kernel.model.RegionWrapper

All Implemented Interfaces:

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

@ProviderType
public class RegionWrapper
extends Object
implements Region, ModelWrapper<Region>

This class is a wrapper for Region.

Author:

Brian Wing Shun Chan

See Also:

Region, Serialized Form

{$generated.description}

Field Summary

Fields inherited from interface com.liferay.portal.kernel.model.Region

REGION_ID_ACCESSOR

Constructor Summary

Constructors

Constructor and Description
RegionWrapper(Region region)

Method Summary

Modifier and Type	Method and Description
Object	clone() Creates a shallow clone of this model instance.
int	compareTo(Region region)
boolean	equals(Object obj)
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.
Map<String,Object>	getModelAttributes()
Class<?>	getModelClass()
String	getModelClassName()
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.
Region	getWrappedModel()
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	isEntityCacheEnabled() Returns true if this model's entity cache is enabled.
boolean	isEscapedModel() Returns true if this model instance is escaped.
boolean	isFinderCacheEnabled() Returns true if this model's finder cache is enabled.
boolean	isNew() Returns true if this model instance does not yet exist in the database.
void	resetOriginalValues() Reset all original fields to current values.
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	setModelAttributes(Map<String,Object> attributes)
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 class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RegionWrapper

public RegionWrapper(Region region)

Method Detail

getModelClass

public Class<?> getModelClass()

Specified by:

getModelClass in interface ClassedModel

getModelClassName

public String getModelClassName()

Specified by:

getModelClassName in interface ClassedModel

getModelAttributes

public Map<String,Object> getModelAttributes()

Specified by:

getModelAttributes in interface BaseModel<Region>

setModelAttributes

public void setModelAttributes(Map<String,Object> attributes)

Specified by:

setModelAttributes in interface BaseModel<Region>

clone

public Object clone()

Description copied from interface: BaseModel

Creates a shallow clone of this model instance.

Specified by:

clone in interface BaseModel<Region>

Specified by:

clone in interface RegionModel

Overrides:

clone in class Object

Returns:

the shallow clone of this model instance

compareTo

public int compareTo(Region region)

Specified by:

compareTo in interface RegionModel

Specified by:

compareTo in interface Comparable<Region>

getActive

public boolean getActive()

Returns the active of this region.

Specified by:

getActive in interface RegionModel

Returns:

the active of this region

getCountryId

public long getCountryId()

Returns the country ID of this region.

Specified by:

getCountryId in interface RegionModel

Returns:

the country ID of this region

getExpandoBridge

public 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

Specified by:

getExpandoBridge in interface RegionModel

Returns:

the expando bridge for this model instance

getMvccVersion

public long getMvccVersion()

Returns the mvcc version of this region.

Specified by:

getMvccVersion in interface MVCCModel

Specified by:

getMvccVersion in interface RegionModel

Returns:

the mvcc version of this region

getName

public String getName()

Returns the name of this region.

Specified by:

getName in interface RegionModel

Returns:

the name of this region

getPrimaryKey

public long getPrimaryKey()

Returns the primary key of this region.

Specified by:

getPrimaryKey in interface RegionModel

Returns:

the primary key of this region

getPrimaryKeyObj

public 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

Specified by:

getPrimaryKeyObj in interface RegionModel

Returns:

the primary key of this model instance

getRegionCode

public String getRegionCode()

Returns the region code of this region.

Specified by:

getRegionCode in interface RegionModel

Returns:

the region code of this region

getRegionId

public long getRegionId()

Returns the region ID of this region.

Specified by:

getRegionId in interface RegionModel

Returns:

the region ID of this region

hashCode

public int hashCode()

Specified by:

hashCode in interface RegionModel

Overrides:

hashCode in class Object

isActive

public boolean isActive()

Returns true if this region is active.

Specified by:

isActive in interface RegionModel

Returns:

true if this region is active; false otherwise

isCachedModel

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

Specified by:

isCachedModel in interface RegionModel

Returns:

true if this model instance was retrieved from the entity cache; false otherwise

See Also:

BaseModel.setCachedModel(boolean)

isEscapedModel

public boolean isEscapedModel()

Description copied from interface: BaseModel

Returns true if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<Region>

Specified by:

isEscapedModel in interface RegionModel

Returns:

true if this model instance is escaped; false otherwise

isNew

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

Specified by:

isNew in interface RegionModel

Returns:

true if this model instance does not yet exist in the database; false otherwise

setActive

public void setActive(boolean active)

Sets whether this region is active.

Specified by:

setActive in interface RegionModel

Parameters:

active - the active of this region

setCachedModel

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

Specified by:

setCachedModel in interface RegionModel

Parameters:

cachedModel - whether this model instance was retrieved from the entity cache

See Also:

EntityCache

setCountryId

public void setCountryId(long countryId)

Sets the country ID of this region.

Specified by:

setCountryId in interface RegionModel

Parameters:

countryId - the country ID of this region

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(BaseModel<?> baseModel)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<Region>

Specified by:

setExpandoBridgeAttributes in interface RegionModel

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<Region>

Specified by:

setExpandoBridgeAttributes in interface RegionModel

setExpandoBridgeAttributes

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

Specified by:

setExpandoBridgeAttributes in interface RegionModel

Parameters:

serviceContext - the service context to be applied

See Also:

ServiceContext.getExpandoBridgeAttributes()

setMvccVersion

public void setMvccVersion(long mvccVersion)

Sets the mvcc version of this region.

Specified by:

setMvccVersion in interface MVCCModel

Specified by:

setMvccVersion in interface RegionModel

Parameters:

mvccVersion - the mvcc version of this region

setName

public void setName(String name)

Sets the name of this region.

Specified by:

setName in interface RegionModel

Parameters:

name - the name of this region

setNew

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

Specified by:

setNew in interface RegionModel

Parameters:

n - whether this model instance does not yet exist in the database

setPrimaryKey

public void setPrimaryKey(long primaryKey)

Sets the primary key of this region.

Specified by:

setPrimaryKey in interface RegionModel

Parameters:

primaryKey - the primary key of this region

setPrimaryKeyObj

public 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

Specified by:

setPrimaryKeyObj in interface RegionModel

Parameters:

primaryKeyObj - the primary key of this model instance

setRegionCode

public void setRegionCode(String regionCode)

Sets the region code of this region.

Specified by:

setRegionCode in interface RegionModel

Parameters:

regionCode - the region code of this region

setRegionId

public void setRegionId(long regionId)

Sets the region ID of this region.

Specified by:

setRegionId in interface RegionModel

Parameters:

regionId - the region ID of this region

toCacheModel

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

Specified by:

toCacheModel in interface RegionModel

Returns:

the cache model object

toEscapedModel

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

Specified by:

toEscapedModel in interface RegionModel

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toString

public String toString()

Specified by:

toString in interface RegionModel

Overrides:

toString in class Object

toUnescapedModel

public Region toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<Region>

Specified by:

toUnescapedModel in interface RegionModel

toXmlString

public String toXmlString()

Description copied from interface: BaseModel

Returns the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<Region>

Specified by:

toXmlString in interface RegionModel

Returns:

the XML representation of this model instance

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getWrappedModel

public Region getWrappedModel()

Specified by:

getWrappedModel in interface ModelWrapper<Region>

isEntityCacheEnabled

public boolean isEntityCacheEnabled()

Description copied from interface: BaseModel

Returns true if this model's entity cache is enabled.

Specified by:

isEntityCacheEnabled in interface BaseModel<Region>

Returns:

true if this model's entity cache is enabled; false otherwise

isFinderCacheEnabled

public boolean isFinderCacheEnabled()

Description copied from interface: BaseModel

Returns true if this model's finder cache is enabled.

Specified by:

isFinderCacheEnabled in interface BaseModel<Region>

Returns:

true if this model's finder cache is enabled; false otherwise

resetOriginalValues

public void resetOriginalValues()

Description copied from interface: BaseModel

Reset all original fields to current values.

Specified by:

resetOriginalValues in interface BaseModel<Region>