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