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