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