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