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