001 /** 002 * Copyright (c) 2000-2012 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 import java.util.Date; 025 import java.util.Locale; 026 import java.util.Map; 027 028 /** 029 * The base model interface for the LayoutSetPrototype service. Represents a row in the "LayoutSetPrototype" database table, with each column mapped to a property of this class. 030 * 031 * <p> 032 * This interface and its corresponding implementation {@link com.liferay.portal.model.impl.LayoutSetPrototypeModelImpl} 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.LayoutSetPrototypeImpl}. 033 * </p> 034 * 035 * @author Brian Wing Shun Chan 036 * @see LayoutSetPrototype 037 * @see com.liferay.portal.model.impl.LayoutSetPrototypeImpl 038 * @see com.liferay.portal.model.impl.LayoutSetPrototypeModelImpl 039 * @generated 040 */ 041 public interface LayoutSetPrototypeModel extends BaseModel<LayoutSetPrototype> { 042 /* 043 * NOTE FOR DEVELOPERS: 044 * 045 * Never modify or reference this interface directly. All methods that expect a layout set prototype model instance should use the {@link LayoutSetPrototype} interface instead. 046 */ 047 048 /** 049 * Returns the primary key of this layout set prototype. 050 * 051 * @return the primary key of this layout set prototype 052 */ 053 public long getPrimaryKey(); 054 055 /** 056 * Sets the primary key of this layout set prototype. 057 * 058 * @param primaryKey the primary key of this layout set prototype 059 */ 060 public void setPrimaryKey(long primaryKey); 061 062 /** 063 * Returns the uuid of this layout set prototype. 064 * 065 * @return the uuid of this layout set prototype 066 */ 067 @AutoEscape 068 public String getUuid(); 069 070 /** 071 * Sets the uuid of this layout set prototype. 072 * 073 * @param uuid the uuid of this layout set prototype 074 */ 075 public void setUuid(String uuid); 076 077 /** 078 * Returns the layout set prototype ID of this layout set prototype. 079 * 080 * @return the layout set prototype ID of this layout set prototype 081 */ 082 public long getLayoutSetPrototypeId(); 083 084 /** 085 * Sets the layout set prototype ID of this layout set prototype. 086 * 087 * @param layoutSetPrototypeId the layout set prototype ID of this layout set prototype 088 */ 089 public void setLayoutSetPrototypeId(long layoutSetPrototypeId); 090 091 /** 092 * Returns the company ID of this layout set prototype. 093 * 094 * @return the company ID of this layout set prototype 095 */ 096 public long getCompanyId(); 097 098 /** 099 * Sets the company ID of this layout set prototype. 100 * 101 * @param companyId the company ID of this layout set prototype 102 */ 103 public void setCompanyId(long companyId); 104 105 /** 106 * Returns the create date of this layout set prototype. 107 * 108 * @return the create date of this layout set prototype 109 */ 110 public Date getCreateDate(); 111 112 /** 113 * Sets the create date of this layout set prototype. 114 * 115 * @param createDate the create date of this layout set prototype 116 */ 117 public void setCreateDate(Date createDate); 118 119 /** 120 * Returns the modified date of this layout set prototype. 121 * 122 * @return the modified date of this layout set prototype 123 */ 124 public Date getModifiedDate(); 125 126 /** 127 * Sets the modified date of this layout set prototype. 128 * 129 * @param modifiedDate the modified date of this layout set prototype 130 */ 131 public void setModifiedDate(Date modifiedDate); 132 133 /** 134 * Returns the name of this layout set prototype. 135 * 136 * @return the name of this layout set prototype 137 */ 138 public String getName(); 139 140 /** 141 * Returns the localized name of this layout set prototype in the language. Uses the default language if no localization exists for the requested language. 142 * 143 * @param locale the locale of the language 144 * @return the localized name of this layout set prototype 145 */ 146 @AutoEscape 147 public String getName(Locale locale); 148 149 /** 150 * Returns the localized name of this layout set prototype in the language, optionally using the default language if no localization exists for the requested language. 151 * 152 * @param locale the local of the language 153 * @param useDefault whether to use the default language if no localization exists for the requested language 154 * @return the localized name of this layout set prototype. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned. 155 */ 156 @AutoEscape 157 public String getName(Locale locale, boolean useDefault); 158 159 /** 160 * Returns the localized name of this layout set prototype in the language. Uses the default language if no localization exists for the requested language. 161 * 162 * @param languageId the ID of the language 163 * @return the localized name of this layout set prototype 164 */ 165 @AutoEscape 166 public String getName(String languageId); 167 168 /** 169 * Returns the localized name of this layout set prototype in the language, optionally using the default language if no localization exists for the requested language. 170 * 171 * @param languageId the ID of the language 172 * @param useDefault whether to use the default language if no localization exists for the requested language 173 * @return the localized name of this layout set prototype 174 */ 175 @AutoEscape 176 public String getName(String languageId, boolean useDefault); 177 178 @AutoEscape 179 public String getNameCurrentLanguageId(); 180 181 @AutoEscape 182 public String getNameCurrentValue(); 183 184 /** 185 * Returns a map of the locales and localized names of this layout set prototype. 186 * 187 * @return the locales and localized names of this layout set prototype 188 */ 189 public Map<Locale, String> getNameMap(); 190 191 /** 192 * Sets the name of this layout set prototype. 193 * 194 * @param name the name of this layout set prototype 195 */ 196 public void setName(String name); 197 198 /** 199 * Sets the localized name of this layout set prototype in the language. 200 * 201 * @param name the localized name of this layout set prototype 202 * @param locale the locale of the language 203 */ 204 public void setName(String name, Locale locale); 205 206 /** 207 * Sets the localized name of this layout set prototype in the language, and sets the default locale. 208 * 209 * @param name the localized name of this layout set prototype 210 * @param locale the locale of the language 211 * @param defaultLocale the default locale 212 */ 213 public void setName(String name, Locale locale, Locale defaultLocale); 214 215 public void setNameCurrentLanguageId(String languageId); 216 217 /** 218 * Sets the localized names of this layout set prototype from the map of locales and localized names. 219 * 220 * @param nameMap the locales and localized names of this layout set prototype 221 */ 222 public void setNameMap(Map<Locale, String> nameMap); 223 224 /** 225 * Sets the localized names of this layout set prototype from the map of locales and localized names, and sets the default locale. 226 * 227 * @param nameMap the locales and localized names of this layout set prototype 228 * @param defaultLocale the default locale 229 */ 230 public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale); 231 232 /** 233 * Returns the description of this layout set prototype. 234 * 235 * @return the description of this layout set prototype 236 */ 237 @AutoEscape 238 public String getDescription(); 239 240 /** 241 * Sets the description of this layout set prototype. 242 * 243 * @param description the description of this layout set prototype 244 */ 245 public void setDescription(String description); 246 247 /** 248 * Returns the settings of this layout set prototype. 249 * 250 * @return the settings of this layout set prototype 251 */ 252 @AutoEscape 253 public String getSettings(); 254 255 /** 256 * Sets the settings of this layout set prototype. 257 * 258 * @param settings the settings of this layout set prototype 259 */ 260 public void setSettings(String settings); 261 262 /** 263 * Returns the active of this layout set prototype. 264 * 265 * @return the active of this layout set prototype 266 */ 267 public boolean getActive(); 268 269 /** 270 * Returns <code>true</code> if this layout set prototype is active. 271 * 272 * @return <code>true</code> if this layout set prototype is active; <code>false</code> otherwise 273 */ 274 public boolean isActive(); 275 276 /** 277 * Sets whether this layout set prototype is active. 278 * 279 * @param active the active of this layout set prototype 280 */ 281 public void setActive(boolean active); 282 283 public boolean isNew(); 284 285 public void setNew(boolean n); 286 287 public boolean isCachedModel(); 288 289 public void setCachedModel(boolean cachedModel); 290 291 public boolean isEscapedModel(); 292 293 public Serializable getPrimaryKeyObj(); 294 295 public void setPrimaryKeyObj(Serializable primaryKeyObj); 296 297 public ExpandoBridge getExpandoBridge(); 298 299 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 300 301 public Object clone(); 302 303 public int compareTo(LayoutSetPrototype layoutSetPrototype); 304 305 public int hashCode(); 306 307 public CacheModel<LayoutSetPrototype> toCacheModel(); 308 309 public LayoutSetPrototype toEscapedModel(); 310 311 public String toString(); 312 313 public String toXmlString(); 314 }