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