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