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.portlet.journal.model; 016 017 import com.liferay.portal.LocaleException; 018 import com.liferay.portal.kernel.bean.AutoEscape; 019 import com.liferay.portal.kernel.exception.SystemException; 020 import com.liferay.portal.model.BaseModel; 021 import com.liferay.portal.model.CacheModel; 022 import com.liferay.portal.model.GroupedModel; 023 import com.liferay.portal.service.ServiceContext; 024 025 import com.liferay.portlet.expando.model.ExpandoBridge; 026 027 import java.io.Serializable; 028 029 import java.util.Date; 030 import java.util.Locale; 031 import java.util.Map; 032 033 /** 034 * The base model interface for the JournalTemplate service. Represents a row in the "JournalTemplate" database table, with each column mapped to a property of this class. 035 * 036 * <p> 037 * This interface and its corresponding implementation {@link com.liferay.portlet.journal.model.impl.JournalTemplateModelImpl} 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.portlet.journal.model.impl.JournalTemplateImpl}. 038 * </p> 039 * 040 * @author Brian Wing Shun Chan 041 * @see JournalTemplate 042 * @see com.liferay.portlet.journal.model.impl.JournalTemplateImpl 043 * @see com.liferay.portlet.journal.model.impl.JournalTemplateModelImpl 044 * @generated 045 */ 046 public interface JournalTemplateModel extends BaseModel<JournalTemplate>, 047 GroupedModel { 048 /* 049 * NOTE FOR DEVELOPERS: 050 * 051 * Never modify or reference this interface directly. All methods that expect a journal template model instance should use the {@link JournalTemplate} interface instead. 052 */ 053 054 /** 055 * Returns the primary key of this journal template. 056 * 057 * @return the primary key of this journal template 058 */ 059 public long getPrimaryKey(); 060 061 /** 062 * Sets the primary key of this journal template. 063 * 064 * @param primaryKey the primary key of this journal template 065 */ 066 public void setPrimaryKey(long primaryKey); 067 068 /** 069 * Returns the uuid of this journal template. 070 * 071 * @return the uuid of this journal template 072 */ 073 @AutoEscape 074 public String getUuid(); 075 076 /** 077 * Sets the uuid of this journal template. 078 * 079 * @param uuid the uuid of this journal template 080 */ 081 public void setUuid(String uuid); 082 083 /** 084 * Returns the ID of this journal template. 085 * 086 * @return the ID of this journal template 087 */ 088 public long getId(); 089 090 /** 091 * Sets the ID of this journal template. 092 * 093 * @param id the ID of this journal template 094 */ 095 public void setId(long id); 096 097 /** 098 * Returns the group ID of this journal template. 099 * 100 * @return the group ID of this journal template 101 */ 102 public long getGroupId(); 103 104 /** 105 * Sets the group ID of this journal template. 106 * 107 * @param groupId the group ID of this journal template 108 */ 109 public void setGroupId(long groupId); 110 111 /** 112 * Returns the company ID of this journal template. 113 * 114 * @return the company ID of this journal template 115 */ 116 public long getCompanyId(); 117 118 /** 119 * Sets the company ID of this journal template. 120 * 121 * @param companyId the company ID of this journal template 122 */ 123 public void setCompanyId(long companyId); 124 125 /** 126 * Returns the user ID of this journal template. 127 * 128 * @return the user ID of this journal template 129 */ 130 public long getUserId(); 131 132 /** 133 * Sets the user ID of this journal template. 134 * 135 * @param userId the user ID of this journal template 136 */ 137 public void setUserId(long userId); 138 139 /** 140 * Returns the user uuid of this journal template. 141 * 142 * @return the user uuid of this journal template 143 * @throws SystemException if a system exception occurred 144 */ 145 public String getUserUuid() throws SystemException; 146 147 /** 148 * Sets the user uuid of this journal template. 149 * 150 * @param userUuid the user uuid of this journal template 151 */ 152 public void setUserUuid(String userUuid); 153 154 /** 155 * Returns the user name of this journal template. 156 * 157 * @return the user name of this journal template 158 */ 159 @AutoEscape 160 public String getUserName(); 161 162 /** 163 * Sets the user name of this journal template. 164 * 165 * @param userName the user name of this journal template 166 */ 167 public void setUserName(String userName); 168 169 /** 170 * Returns the create date of this journal template. 171 * 172 * @return the create date of this journal template 173 */ 174 public Date getCreateDate(); 175 176 /** 177 * Sets the create date of this journal template. 178 * 179 * @param createDate the create date of this journal template 180 */ 181 public void setCreateDate(Date createDate); 182 183 /** 184 * Returns the modified date of this journal template. 185 * 186 * @return the modified date of this journal template 187 */ 188 public Date getModifiedDate(); 189 190 /** 191 * Sets the modified date of this journal template. 192 * 193 * @param modifiedDate the modified date of this journal template 194 */ 195 public void setModifiedDate(Date modifiedDate); 196 197 /** 198 * Returns the template ID of this journal template. 199 * 200 * @return the template ID of this journal template 201 */ 202 public String getTemplateId(); 203 204 /** 205 * Sets the template ID of this journal template. 206 * 207 * @param templateId the template ID of this journal template 208 */ 209 public void setTemplateId(String templateId); 210 211 /** 212 * Returns the structure ID of this journal template. 213 * 214 * @return the structure ID of this journal template 215 */ 216 public String getStructureId(); 217 218 /** 219 * Sets the structure ID of this journal template. 220 * 221 * @param structureId the structure ID of this journal template 222 */ 223 public void setStructureId(String structureId); 224 225 /** 226 * Returns the name of this journal template. 227 * 228 * @return the name of this journal template 229 */ 230 public String getName(); 231 232 /** 233 * Returns the localized name of this journal template in the language. Uses the default language if no localization exists for the requested language. 234 * 235 * @param locale the locale of the language 236 * @return the localized name of this journal template 237 */ 238 @AutoEscape 239 public String getName(Locale locale); 240 241 /** 242 * Returns the localized name of this journal template in the language, optionally using the default language if no localization exists for the requested language. 243 * 244 * @param locale the local of the language 245 * @param useDefault whether to use the default language if no localization exists for the requested language 246 * @return the localized name of this journal template. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned. 247 */ 248 @AutoEscape 249 public String getName(Locale locale, boolean useDefault); 250 251 /** 252 * Returns the localized name of this journal template in the language. Uses the default language if no localization exists for the requested language. 253 * 254 * @param languageId the ID of the language 255 * @return the localized name of this journal template 256 */ 257 @AutoEscape 258 public String getName(String languageId); 259 260 /** 261 * Returns the localized name of this journal template in the language, optionally using the default language if no localization exists for the requested language. 262 * 263 * @param languageId the ID of the language 264 * @param useDefault whether to use the default language if no localization exists for the requested language 265 * @return the localized name of this journal template 266 */ 267 @AutoEscape 268 public String getName(String languageId, boolean useDefault); 269 270 @AutoEscape 271 public String getNameCurrentLanguageId(); 272 273 @AutoEscape 274 public String getNameCurrentValue(); 275 276 /** 277 * Returns a map of the locales and localized names of this journal template. 278 * 279 * @return the locales and localized names of this journal template 280 */ 281 public Map<Locale, String> getNameMap(); 282 283 /** 284 * Sets the name of this journal template. 285 * 286 * @param name the name of this journal template 287 */ 288 public void setName(String name); 289 290 /** 291 * Sets the localized name of this journal template in the language. 292 * 293 * @param name the localized name of this journal template 294 * @param locale the locale of the language 295 */ 296 public void setName(String name, Locale locale); 297 298 /** 299 * Sets the localized name of this journal template in the language, and sets the default locale. 300 * 301 * @param name the localized name of this journal template 302 * @param locale the locale of the language 303 * @param defaultLocale the default locale 304 */ 305 public void setName(String name, Locale locale, Locale defaultLocale); 306 307 public void setNameCurrentLanguageId(String languageId); 308 309 /** 310 * Sets the localized names of this journal template from the map of locales and localized names. 311 * 312 * @param nameMap the locales and localized names of this journal template 313 */ 314 public void setNameMap(Map<Locale, String> nameMap); 315 316 /** 317 * Sets the localized names of this journal template from the map of locales and localized names, and sets the default locale. 318 * 319 * @param nameMap the locales and localized names of this journal template 320 * @param defaultLocale the default locale 321 */ 322 public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale); 323 324 /** 325 * Returns the description of this journal template. 326 * 327 * @return the description of this journal template 328 */ 329 public String getDescription(); 330 331 /** 332 * Returns the localized description of this journal template in the language. Uses the default language if no localization exists for the requested language. 333 * 334 * @param locale the locale of the language 335 * @return the localized description of this journal template 336 */ 337 @AutoEscape 338 public String getDescription(Locale locale); 339 340 /** 341 * Returns the localized description of this journal template in the language, optionally using the default language if no localization exists for the requested language. 342 * 343 * @param locale the local of the language 344 * @param useDefault whether to use the default language if no localization exists for the requested language 345 * @return the localized description of this journal template. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned. 346 */ 347 @AutoEscape 348 public String getDescription(Locale locale, boolean useDefault); 349 350 /** 351 * Returns the localized description of this journal template in the language. Uses the default language if no localization exists for the requested language. 352 * 353 * @param languageId the ID of the language 354 * @return the localized description of this journal template 355 */ 356 @AutoEscape 357 public String getDescription(String languageId); 358 359 /** 360 * Returns the localized description of this journal template in the language, optionally using the default language if no localization exists for the requested language. 361 * 362 * @param languageId the ID of the language 363 * @param useDefault whether to use the default language if no localization exists for the requested language 364 * @return the localized description of this journal template 365 */ 366 @AutoEscape 367 public String getDescription(String languageId, boolean useDefault); 368 369 @AutoEscape 370 public String getDescriptionCurrentLanguageId(); 371 372 @AutoEscape 373 public String getDescriptionCurrentValue(); 374 375 /** 376 * Returns a map of the locales and localized descriptions of this journal template. 377 * 378 * @return the locales and localized descriptions of this journal template 379 */ 380 public Map<Locale, String> getDescriptionMap(); 381 382 /** 383 * Sets the description of this journal template. 384 * 385 * @param description the description of this journal template 386 */ 387 public void setDescription(String description); 388 389 /** 390 * Sets the localized description of this journal template in the language. 391 * 392 * @param description the localized description of this journal template 393 * @param locale the locale of the language 394 */ 395 public void setDescription(String description, Locale locale); 396 397 /** 398 * Sets the localized description of this journal template in the language, and sets the default locale. 399 * 400 * @param description the localized description of this journal template 401 * @param locale the locale of the language 402 * @param defaultLocale the default locale 403 */ 404 public void setDescription(String description, Locale locale, 405 Locale defaultLocale); 406 407 public void setDescriptionCurrentLanguageId(String languageId); 408 409 /** 410 * Sets the localized descriptions of this journal template from the map of locales and localized descriptions. 411 * 412 * @param descriptionMap the locales and localized descriptions of this journal template 413 */ 414 public void setDescriptionMap(Map<Locale, String> descriptionMap); 415 416 /** 417 * Sets the localized descriptions of this journal template from the map of locales and localized descriptions, and sets the default locale. 418 * 419 * @param descriptionMap the locales and localized descriptions of this journal template 420 * @param defaultLocale the default locale 421 */ 422 public void setDescriptionMap(Map<Locale, String> descriptionMap, 423 Locale defaultLocale); 424 425 /** 426 * Returns the xsl of this journal template. 427 * 428 * @return the xsl of this journal template 429 */ 430 @AutoEscape 431 public String getXsl(); 432 433 /** 434 * Sets the xsl of this journal template. 435 * 436 * @param xsl the xsl of this journal template 437 */ 438 public void setXsl(String xsl); 439 440 /** 441 * Returns the lang type of this journal template. 442 * 443 * @return the lang type of this journal template 444 */ 445 @AutoEscape 446 public String getLangType(); 447 448 /** 449 * Sets the lang type of this journal template. 450 * 451 * @param langType the lang type of this journal template 452 */ 453 public void setLangType(String langType); 454 455 /** 456 * Returns the cacheable of this journal template. 457 * 458 * @return the cacheable of this journal template 459 */ 460 public boolean getCacheable(); 461 462 /** 463 * Returns <code>true</code> if this journal template is cacheable. 464 * 465 * @return <code>true</code> if this journal template is cacheable; <code>false</code> otherwise 466 */ 467 public boolean isCacheable(); 468 469 /** 470 * Sets whether this journal template is cacheable. 471 * 472 * @param cacheable the cacheable of this journal template 473 */ 474 public void setCacheable(boolean cacheable); 475 476 /** 477 * Returns the small image of this journal template. 478 * 479 * @return the small image of this journal template 480 */ 481 public boolean getSmallImage(); 482 483 /** 484 * Returns <code>true</code> if this journal template is small image. 485 * 486 * @return <code>true</code> if this journal template is small image; <code>false</code> otherwise 487 */ 488 public boolean isSmallImage(); 489 490 /** 491 * Sets whether this journal template is small image. 492 * 493 * @param smallImage the small image of this journal template 494 */ 495 public void setSmallImage(boolean smallImage); 496 497 /** 498 * Returns the small image ID of this journal template. 499 * 500 * @return the small image ID of this journal template 501 */ 502 public long getSmallImageId(); 503 504 /** 505 * Sets the small image ID of this journal template. 506 * 507 * @param smallImageId the small image ID of this journal template 508 */ 509 public void setSmallImageId(long smallImageId); 510 511 /** 512 * Returns the small image u r l of this journal template. 513 * 514 * @return the small image u r l of this journal template 515 */ 516 @AutoEscape 517 public String getSmallImageURL(); 518 519 /** 520 * Sets the small image u r l of this journal template. 521 * 522 * @param smallImageURL the small image u r l of this journal template 523 */ 524 public void setSmallImageURL(String smallImageURL); 525 526 public boolean isNew(); 527 528 public void setNew(boolean n); 529 530 public boolean isCachedModel(); 531 532 public void setCachedModel(boolean cachedModel); 533 534 public boolean isEscapedModel(); 535 536 public Serializable getPrimaryKeyObj(); 537 538 public void setPrimaryKeyObj(Serializable primaryKeyObj); 539 540 public ExpandoBridge getExpandoBridge(); 541 542 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 543 544 public void prepareLocalizedFieldsForImport(Locale defaultImportLocale) 545 throws LocaleException; 546 547 public Object clone(); 548 549 public int compareTo(JournalTemplate journalTemplate); 550 551 public int hashCode(); 552 553 public CacheModel<JournalTemplate> toCacheModel(); 554 555 public JournalTemplate toEscapedModel(); 556 557 public JournalTemplate toUnescapedModel(); 558 559 public String toString(); 560 561 public String toXmlString(); 562 }