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 aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.LocaleException; 020 import com.liferay.portal.kernel.bean.AutoEscape; 021 import com.liferay.portal.kernel.exception.SystemException; 022 import com.liferay.portal.service.ServiceContext; 023 024 import com.liferay.portlet.expando.model.ExpandoBridge; 025 026 import java.io.Serializable; 027 028 import java.util.Date; 029 import java.util.Locale; 030 import java.util.Map; 031 032 /** 033 * The base model interface for the LayoutPrototype service. Represents a row in the "LayoutPrototype" database table, with each column mapped to a property of this class. 034 * 035 * <p> 036 * This interface and its corresponding implementation {@link com.liferay.portal.model.impl.LayoutPrototypeModelImpl} 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.LayoutPrototypeImpl}. 037 * </p> 038 * 039 * @author Brian Wing Shun Chan 040 * @see LayoutPrototype 041 * @see com.liferay.portal.model.impl.LayoutPrototypeImpl 042 * @see com.liferay.portal.model.impl.LayoutPrototypeModelImpl 043 * @generated 044 */ 045 @ProviderType 046 public interface LayoutPrototypeModel extends BaseModel<LayoutPrototype>, 047 StagedAuditedModel { 048 /* 049 * NOTE FOR DEVELOPERS: 050 * 051 * Never modify or reference this interface directly. All methods that expect a layout prototype model instance should use the {@link LayoutPrototype} interface instead. 052 */ 053 054 /** 055 * Returns the primary key of this layout prototype. 056 * 057 * @return the primary key of this layout prototype 058 */ 059 public long getPrimaryKey(); 060 061 /** 062 * Sets the primary key of this layout prototype. 063 * 064 * @param primaryKey the primary key of this layout prototype 065 */ 066 public void setPrimaryKey(long primaryKey); 067 068 /** 069 * Returns the uuid of this layout prototype. 070 * 071 * @return the uuid of this layout prototype 072 */ 073 @AutoEscape 074 @Override 075 public String getUuid(); 076 077 /** 078 * Sets the uuid of this layout prototype. 079 * 080 * @param uuid the uuid of this layout prototype 081 */ 082 @Override 083 public void setUuid(String uuid); 084 085 /** 086 * Returns the layout prototype ID of this layout prototype. 087 * 088 * @return the layout prototype ID of this layout prototype 089 */ 090 public long getLayoutPrototypeId(); 091 092 /** 093 * Sets the layout prototype ID of this layout prototype. 094 * 095 * @param layoutPrototypeId the layout prototype ID of this layout prototype 096 */ 097 public void setLayoutPrototypeId(long layoutPrototypeId); 098 099 /** 100 * Returns the company ID of this layout prototype. 101 * 102 * @return the company ID of this layout prototype 103 */ 104 @Override 105 public long getCompanyId(); 106 107 /** 108 * Sets the company ID of this layout prototype. 109 * 110 * @param companyId the company ID of this layout prototype 111 */ 112 @Override 113 public void setCompanyId(long companyId); 114 115 /** 116 * Returns the user ID of this layout prototype. 117 * 118 * @return the user ID of this layout prototype 119 */ 120 @Override 121 public long getUserId(); 122 123 /** 124 * Sets the user ID of this layout prototype. 125 * 126 * @param userId the user ID of this layout prototype 127 */ 128 @Override 129 public void setUserId(long userId); 130 131 /** 132 * Returns the user uuid of this layout prototype. 133 * 134 * @return the user uuid of this layout prototype 135 * @throws SystemException if a system exception occurred 136 */ 137 @Override 138 public String getUserUuid() throws SystemException; 139 140 /** 141 * Sets the user uuid of this layout prototype. 142 * 143 * @param userUuid the user uuid of this layout prototype 144 */ 145 @Override 146 public void setUserUuid(String userUuid); 147 148 /** 149 * Returns the user name of this layout prototype. 150 * 151 * @return the user name of this layout prototype 152 */ 153 @AutoEscape 154 @Override 155 public String getUserName(); 156 157 /** 158 * Sets the user name of this layout prototype. 159 * 160 * @param userName the user name of this layout prototype 161 */ 162 @Override 163 public void setUserName(String userName); 164 165 /** 166 * Returns the create date of this layout prototype. 167 * 168 * @return the create date of this layout prototype 169 */ 170 @Override 171 public Date getCreateDate(); 172 173 /** 174 * Sets the create date of this layout prototype. 175 * 176 * @param createDate the create date of this layout prototype 177 */ 178 @Override 179 public void setCreateDate(Date createDate); 180 181 /** 182 * Returns the modified date of this layout prototype. 183 * 184 * @return the modified date of this layout prototype 185 */ 186 @Override 187 public Date getModifiedDate(); 188 189 /** 190 * Sets the modified date of this layout prototype. 191 * 192 * @param modifiedDate the modified date of this layout prototype 193 */ 194 @Override 195 public void setModifiedDate(Date modifiedDate); 196 197 /** 198 * Returns the name of this layout prototype. 199 * 200 * @return the name of this layout prototype 201 */ 202 public String getName(); 203 204 /** 205 * Returns the localized name of this layout prototype in the language. Uses the default language if no localization exists for the requested language. 206 * 207 * @param locale the locale of the language 208 * @return the localized name of this layout prototype 209 */ 210 @AutoEscape 211 public String getName(Locale locale); 212 213 /** 214 * Returns the localized name of this layout prototype in the language, optionally using the default language if no localization exists for the requested language. 215 * 216 * @param locale the local of the language 217 * @param useDefault whether to use the default language if no localization exists for the requested language 218 * @return the localized name of this layout prototype. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned. 219 */ 220 @AutoEscape 221 public String getName(Locale locale, boolean useDefault); 222 223 /** 224 * Returns the localized name of this layout prototype in the language. Uses the default language if no localization exists for the requested language. 225 * 226 * @param languageId the ID of the language 227 * @return the localized name of this layout prototype 228 */ 229 @AutoEscape 230 public String getName(String languageId); 231 232 /** 233 * Returns the localized name of this layout prototype in the language, optionally using the default language if no localization exists for the requested language. 234 * 235 * @param languageId the ID of the language 236 * @param useDefault whether to use the default language if no localization exists for the requested language 237 * @return the localized name of this layout prototype 238 */ 239 @AutoEscape 240 public String getName(String languageId, boolean useDefault); 241 242 @AutoEscape 243 public String getNameCurrentLanguageId(); 244 245 @AutoEscape 246 public String getNameCurrentValue(); 247 248 /** 249 * Returns a map of the locales and localized names of this layout prototype. 250 * 251 * @return the locales and localized names of this layout prototype 252 */ 253 public Map<Locale, String> getNameMap(); 254 255 /** 256 * Sets the name of this layout prototype. 257 * 258 * @param name the name of this layout prototype 259 */ 260 public void setName(String name); 261 262 /** 263 * Sets the localized name of this layout prototype in the language. 264 * 265 * @param name the localized name of this layout prototype 266 * @param locale the locale of the language 267 */ 268 public void setName(String name, Locale locale); 269 270 /** 271 * Sets the localized name of this layout prototype in the language, and sets the default locale. 272 * 273 * @param name the localized name of this layout prototype 274 * @param locale the locale of the language 275 * @param defaultLocale the default locale 276 */ 277 public void setName(String name, Locale locale, Locale defaultLocale); 278 279 public void setNameCurrentLanguageId(String languageId); 280 281 /** 282 * Sets the localized names of this layout prototype from the map of locales and localized names. 283 * 284 * @param nameMap the locales and localized names of this layout prototype 285 */ 286 public void setNameMap(Map<Locale, String> nameMap); 287 288 /** 289 * Sets the localized names of this layout prototype from the map of locales and localized names, and sets the default locale. 290 * 291 * @param nameMap the locales and localized names of this layout prototype 292 * @param defaultLocale the default locale 293 */ 294 public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale); 295 296 /** 297 * Returns the description of this layout prototype. 298 * 299 * @return the description of this layout prototype 300 */ 301 @AutoEscape 302 public String getDescription(); 303 304 /** 305 * Sets the description of this layout prototype. 306 * 307 * @param description the description of this layout prototype 308 */ 309 public void setDescription(String description); 310 311 /** 312 * Returns the settings of this layout prototype. 313 * 314 * @return the settings of this layout prototype 315 */ 316 @AutoEscape 317 public String getSettings(); 318 319 /** 320 * Sets the settings of this layout prototype. 321 * 322 * @param settings the settings of this layout prototype 323 */ 324 public void setSettings(String settings); 325 326 /** 327 * Returns the active of this layout prototype. 328 * 329 * @return the active of this layout prototype 330 */ 331 public boolean getActive(); 332 333 /** 334 * Returns <code>true</code> if this layout prototype is active. 335 * 336 * @return <code>true</code> if this layout prototype is active; <code>false</code> otherwise 337 */ 338 public boolean isActive(); 339 340 /** 341 * Sets whether this layout prototype is active. 342 * 343 * @param active the active of this layout prototype 344 */ 345 public void setActive(boolean active); 346 347 @Override 348 public boolean isNew(); 349 350 @Override 351 public void setNew(boolean n); 352 353 @Override 354 public boolean isCachedModel(); 355 356 @Override 357 public void setCachedModel(boolean cachedModel); 358 359 @Override 360 public boolean isEscapedModel(); 361 362 @Override 363 public Serializable getPrimaryKeyObj(); 364 365 @Override 366 public void setPrimaryKeyObj(Serializable primaryKeyObj); 367 368 @Override 369 public ExpandoBridge getExpandoBridge(); 370 371 @Override 372 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 373 374 @Override 375 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 376 377 @Override 378 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 379 380 public String[] getAvailableLanguageIds(); 381 382 public String getDefaultLanguageId(); 383 384 public void prepareLocalizedFieldsForImport() throws LocaleException; 385 386 public void prepareLocalizedFieldsForImport(Locale defaultImportLocale) 387 throws LocaleException; 388 389 @Override 390 public Object clone(); 391 392 @Override 393 public int compareTo(LayoutPrototype layoutPrototype); 394 395 @Override 396 public int hashCode(); 397 398 @Override 399 public CacheModel<LayoutPrototype> toCacheModel(); 400 401 @Override 402 public LayoutPrototype toEscapedModel(); 403 404 @Override 405 public LayoutPrototype toUnescapedModel(); 406 407 @Override 408 public String toString(); 409 410 @Override 411 public String toXmlString(); 412 }