001 /** 002 * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved. 003 * 004 * The contents of this file are subject to the terms of the Liferay Enterprise 005 * Subscription License ("License"). You may not use this file except in 006 * compliance with the License. You can obtain a copy of the License by 007 * contacting Liferay, Inc. See the License for the specific language governing 008 * permissions and limitations under the License, including but not limited to 009 * distribution rights of the Software. 010 * 011 * 012 * 013 */ 014 015 package com.liferay.portal.model; 016 017 import com.liferay.portal.kernel.annotation.AutoEscape; 018 import com.liferay.portal.service.ServiceContext; 019 020 import com.liferay.portlet.expando.model.ExpandoBridge; 021 022 import java.io.Serializable; 023 024 /** 025 * 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. 026 * 027 * <p> 028 * This interface and its corresponding implementation {@link 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 {@link com.liferay.portal.model.impl.RegionImpl}. 029 * </p> 030 * 031 * <p> 032 * Never modify or reference this interface directly. All methods that expect a region model instance should use the {@link Region} interface instead. 033 * </p> 034 * 035 * @author Brian Wing Shun Chan 036 * @see Region 037 * @see com.liferay.portal.model.impl.RegionImpl 038 * @see com.liferay.portal.model.impl.RegionModelImpl 039 * @generated 040 */ 041 public interface RegionModel extends BaseModel<Region> { 042 /** 043 * Gets the primary key of this region. 044 * 045 * @return the primary key of this region 046 */ 047 public long getPrimaryKey(); 048 049 /** 050 * Sets the primary key of this region 051 * 052 * @param pk the primary key of this region 053 */ 054 public void setPrimaryKey(long pk); 055 056 /** 057 * Gets the region id of this region. 058 * 059 * @return the region id of this region 060 */ 061 public long getRegionId(); 062 063 /** 064 * Sets the region id of this region. 065 * 066 * @param regionId the region id of this region 067 */ 068 public void setRegionId(long regionId); 069 070 /** 071 * Gets the country id of this region. 072 * 073 * @return the country id of this region 074 */ 075 public long getCountryId(); 076 077 /** 078 * Sets the country id of this region. 079 * 080 * @param countryId the country id of this region 081 */ 082 public void setCountryId(long countryId); 083 084 /** 085 * Gets the region code of this region. 086 * 087 * @return the region code of this region 088 */ 089 @AutoEscape 090 public String getRegionCode(); 091 092 /** 093 * Sets the region code of this region. 094 * 095 * @param regionCode the region code of this region 096 */ 097 public void setRegionCode(String regionCode); 098 099 /** 100 * Gets the name of this region. 101 * 102 * @return the name of this region 103 */ 104 @AutoEscape 105 public String getName(); 106 107 /** 108 * Sets the name of this region. 109 * 110 * @param name the name of this region 111 */ 112 public void setName(String name); 113 114 /** 115 * Gets the active of this region. 116 * 117 * @return the active of this region 118 */ 119 public boolean getActive(); 120 121 /** 122 * Determines whether this region is active. 123 * 124 * @return whether this region is active 125 */ 126 public boolean isActive(); 127 128 /** 129 * Sets whether this {$entity.humanName} is active. 130 * 131 * @param active the active of this region 132 */ 133 public void setActive(boolean active); 134 135 public boolean isNew(); 136 137 public void setNew(boolean n); 138 139 public boolean isCachedModel(); 140 141 public void setCachedModel(boolean cachedModel); 142 143 public boolean isEscapedModel(); 144 145 public void setEscapedModel(boolean escapedModel); 146 147 public Serializable getPrimaryKeyObj(); 148 149 public ExpandoBridge getExpandoBridge(); 150 151 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 152 153 public Object clone(); 154 155 public int compareTo(Region region); 156 157 public int hashCode(); 158 159 public Region toEscapedModel(); 160 161 public String toString(); 162 163 public String toXmlString(); 164 }