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