001 /** 002 * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved. 003 * 004 * This library is free software; you can redistribute it and/or modify it under 005 * the terms of the GNU Lesser General Public License as published by the Free 006 * Software Foundation; either version 2.1 of the License, or (at your option) 007 * any later version. 008 * 009 * This library is distributed in the hope that it will be useful, but WITHOUT 010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 011 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 012 * details. 013 */ 014 015 package com.liferay.portal.model; 016 017 import com.liferay.portal.kernel.bean.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 * @author Brian Wing Shun Chan 032 * @see Region 033 * @see com.liferay.portal.model.impl.RegionImpl 034 * @see com.liferay.portal.model.impl.RegionModelImpl 035 * @generated 036 */ 037 public interface RegionModel extends BaseModel<Region> { 038 /* 039 * NOTE FOR DEVELOPERS: 040 * 041 * Never modify or reference this interface directly. All methods that expect a region model instance should use the {@link Region} interface instead. 042 */ 043 044 /** 045 * Returns the primary key of this region. 046 * 047 * @return the primary key of this region 048 */ 049 public long getPrimaryKey(); 050 051 /** 052 * Sets the primary key of this region. 053 * 054 * @param primaryKey the primary key of this region 055 */ 056 public void setPrimaryKey(long primaryKey); 057 058 /** 059 * Returns the region ID of this region. 060 * 061 * @return the region ID of this region 062 */ 063 public long getRegionId(); 064 065 /** 066 * Sets the region ID of this region. 067 * 068 * @param regionId the region ID of this region 069 */ 070 public void setRegionId(long regionId); 071 072 /** 073 * Returns the country ID of this region. 074 * 075 * @return the country ID of this region 076 */ 077 public long getCountryId(); 078 079 /** 080 * Sets the country ID of this region. 081 * 082 * @param countryId the country ID of this region 083 */ 084 public void setCountryId(long countryId); 085 086 /** 087 * Returns the region code of this region. 088 * 089 * @return the region code of this region 090 */ 091 @AutoEscape 092 public String getRegionCode(); 093 094 /** 095 * Sets the region code of this region. 096 * 097 * @param regionCode the region code of this region 098 */ 099 public void setRegionCode(String regionCode); 100 101 /** 102 * Returns the name of this region. 103 * 104 * @return the name of this region 105 */ 106 @AutoEscape 107 public String getName(); 108 109 /** 110 * Sets the name of this region. 111 * 112 * @param name the name of this region 113 */ 114 public void setName(String name); 115 116 /** 117 * Returns the active of this region. 118 * 119 * @return the active of this region 120 */ 121 public boolean getActive(); 122 123 /** 124 * Returns <code>true</code> if this region is active. 125 * 126 * @return <code>true</code> if this region is active; <code>false</code> otherwise 127 */ 128 public boolean isActive(); 129 130 /** 131 * Sets whether this region is active. 132 * 133 * @param active the active of this region 134 */ 135 public void setActive(boolean active); 136 137 public boolean isNew(); 138 139 public void setNew(boolean n); 140 141 public boolean isCachedModel(); 142 143 public void setCachedModel(boolean cachedModel); 144 145 public boolean isEscapedModel(); 146 147 public Serializable getPrimaryKeyObj(); 148 149 public void setPrimaryKeyObj(Serializable primaryKeyObj); 150 151 public ExpandoBridge getExpandoBridge(); 152 153 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 154 155 public Object clone(); 156 157 public int compareTo(Region region); 158 159 public int hashCode(); 160 161 public CacheModel<Region> toCacheModel(); 162 163 public Region toEscapedModel(); 164 165 public Region toUnescapedModel(); 166 167 public String toString(); 168 169 public String toXmlString(); 170 }