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