Liferay 6.0.5

com.liferay.portal.model
Class RegionWrapper

java.lang.Object
  extended by com.liferay.portal.model.RegionWrapper
All Implemented Interfaces:
BaseModel<Region>, Region, RegionModel, Serializable, Cloneable, Comparable<Region>

public class RegionWrapper
extends Object
implements Region

This class is a wrapper for Region.

See Also:
Region, Serialized Form
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary
RegionWrapper(Region region)
           
 
Method Summary
 Object clone()
          Creates a shallow clone of this model instance.
 int compareTo(Region region)
           
 boolean getActive()
          Gets the active of this region.
 long getCountryId()
          Gets the country id of this region.
 ExpandoBridge getExpandoBridge()
          Gets the expando bridge for this model instance.
 String getName()
          Gets the name of this region.
 long getPrimaryKey()
          Gets the primary key of this region.
 Serializable getPrimaryKeyObj()
          Gets the primary key of this model instance.
 String getRegionCode()
          Gets the region code of this region.
 long getRegionId()
          Gets the region id of this region.
 Region getWrappedRegion()
           
 int hashCode()
           
 boolean isActive()
          Determines whether this region is active.
 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 setActive(boolean active)
          Sets whether this {$entity.humanName} 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 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 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 pk)
          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.
 Region toEscapedModel()
          Gets a copy of this region as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
 String toString()
           
 String toXmlString()
          Gets the XML representation of this model instance.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RegionWrapper

public RegionWrapper(Region region)
Method Detail

getPrimaryKey

public long getPrimaryKey()
Description copied from interface: RegionModel
Gets the primary key of this region.

Specified by:
getPrimaryKey in interface RegionModel
Returns:
the primary key of this region

setPrimaryKey

public void setPrimaryKey(long pk)
Description copied from interface: RegionModel
Sets the primary key of this region

Specified by:
setPrimaryKey in interface RegionModel
Parameters:
pk - the primary key of this region

getRegionId

public long getRegionId()
Description copied from interface: RegionModel
Gets the region id of this region.

Specified by:
getRegionId in interface RegionModel
Returns:
the region id of this region

setRegionId

public void setRegionId(long regionId)
Description copied from interface: RegionModel
Sets the region id of this region.

Specified by:
setRegionId in interface RegionModel
Parameters:
regionId - the region id of this region

getCountryId

public long getCountryId()
Description copied from interface: RegionModel
Gets the country id of this region.

Specified by:
getCountryId in interface RegionModel
Returns:
the country id of this region

setCountryId

public void setCountryId(long countryId)
Description copied from interface: RegionModel
Sets the country id of this region.

Specified by:
setCountryId in interface RegionModel
Parameters:
countryId - the country id of this region

getRegionCode

public String getRegionCode()
Description copied from interface: RegionModel
Gets the region code of this region.

Specified by:
getRegionCode in interface RegionModel
Returns:
the region code of this region

setRegionCode

public void setRegionCode(String regionCode)
Description copied from interface: RegionModel
Sets the region code of this region.

Specified by:
setRegionCode in interface RegionModel
Parameters:
regionCode - the region code of this region

getName

public String getName()
Description copied from interface: RegionModel
Gets the name of this region.

Specified by:
getName in interface RegionModel
Returns:
the name of this region

setName

public void setName(String name)
Description copied from interface: RegionModel
Sets the name of this region.

Specified by:
setName in interface RegionModel
Parameters:
name - the name of this region

getActive

public boolean getActive()
Description copied from interface: RegionModel
Gets the active of this region.

Specified by:
getActive in interface RegionModel
Returns:
the active of this region

isActive

public boolean isActive()
Description copied from interface: RegionModel
Determines whether this region is active.

Specified by:
isActive in interface RegionModel
Returns:
whether this region is active

setActive

public void setActive(boolean active)
Description copied from interface: RegionModel
Sets whether this {$entity.humanName} is active.

Specified by:
setActive in interface RegionModel
Parameters:
active - the active of this region

toEscapedModel

public Region toEscapedModel()
Description copied from interface: RegionModel
Gets a copy of this region as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:
toEscapedModel in interface RegionModel
Returns:
the escaped model instance
See Also:
AutoEscapeBeanHandler

isNew

public 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<Region>
Specified by:
isNew in interface RegionModel
Returns:
true if this model instance does not yet exist in the database; false otherwise

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

isCachedModel

public boolean isCachedModel()
Description copied from interface: BaseModel
Determines 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)

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

isEscapedModel

public boolean isEscapedModel()
Description copied from interface: BaseModel
Determines 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
See Also:
BaseModel.setEscapedModel(boolean)

setEscapedModel

public 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<Region>
Specified by:
setEscapedModel in interface RegionModel
Parameters:
escapedModel - whether this model instance is escaped
See Also:
AutoEscapeBeanHandler

getPrimaryKeyObj

public Serializable getPrimaryKeyObj()
Description copied from interface: BaseModel
Gets the primary key of this model instance.

Specified by:
getPrimaryKeyObj in interface BaseModel<Region>
Specified by:
getPrimaryKeyObj in interface RegionModel
Returns:
the primary key of this model instance

getExpandoBridge

public ExpandoBridge getExpandoBridge()
Description copied from interface: BaseModel
Gets the expando bridge for this model instance.

Specified by:
getExpandoBridge in interface BaseModel<Region>
Specified by:
getExpandoBridge in interface RegionModel
Returns:
the expando bridge for this model instance

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 retrieve the expando bridge attributes from
See Also:
ServiceContext.getExpandoBridgeAttributes( )

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>

hashCode

public int hashCode()
Specified by:
hashCode in interface RegionModel
Overrides:
hashCode in class Object

toString

public String toString()
Specified by:
toString in interface RegionModel
Overrides:
toString in class Object

toXmlString

public String toXmlString()
Description copied from interface: BaseModel
Gets 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

getWrappedRegion

public Region getWrappedRegion()

Liferay 6.0.5