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.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.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 AssetCategory service. Represents a row in the "AssetCategory" 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.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}. 040 * </p> 041 * 042 * @author Brian Wing Shun Chan 043 * @see AssetCategory 044 * @see com.liferay.portlet.asset.model.impl.AssetCategoryImpl 045 * @see com.liferay.portlet.asset.model.impl.AssetCategoryModelImpl 046 * @generated 047 */ 048 @ProviderType 049 public interface AssetCategoryModel extends BaseModel<AssetCategory>, 050 StagedGroupedModel { 051 /* 052 * NOTE FOR DEVELOPERS: 053 * 054 * Never modify or reference this interface directly. All methods that expect a asset category model instance should use the {@link AssetCategory} interface instead. 055 */ 056 057 /** 058 * Returns the primary key of this asset category. 059 * 060 * @return the primary key of this asset category 061 */ 062 public long getPrimaryKey(); 063 064 /** 065 * Sets the primary key of this asset category. 066 * 067 * @param primaryKey the primary key of this asset category 068 */ 069 public void setPrimaryKey(long primaryKey); 070 071 /** 072 * Returns the uuid of this asset category. 073 * 074 * @return the uuid of this asset category 075 */ 076 @AutoEscape 077 @Override 078 public String getUuid(); 079 080 /** 081 * Sets the uuid of this asset category. 082 * 083 * @param uuid the uuid of this asset category 084 */ 085 @Override 086 public void setUuid(String uuid); 087 088 /** 089 * Returns the category ID of this asset category. 090 * 091 * @return the category ID of this asset category 092 */ 093 public long getCategoryId(); 094 095 /** 096 * Sets the category ID of this asset category. 097 * 098 * @param categoryId the category ID of this asset category 099 */ 100 public void setCategoryId(long categoryId); 101 102 /** 103 * Returns the group ID of this asset category. 104 * 105 * @return the group ID of this asset category 106 */ 107 @Override 108 public long getGroupId(); 109 110 /** 111 * Sets the group ID of this asset category. 112 * 113 * @param groupId the group ID of this asset category 114 */ 115 @Override 116 public void setGroupId(long groupId); 117 118 /** 119 * Returns the company ID of this asset category. 120 * 121 * @return the company ID of this asset category 122 */ 123 @Override 124 public long getCompanyId(); 125 126 /** 127 * Sets the company ID of this asset category. 128 * 129 * @param companyId the company ID of this asset category 130 */ 131 @Override 132 public void setCompanyId(long companyId); 133 134 /** 135 * Returns the user ID of this asset category. 136 * 137 * @return the user ID of this asset category 138 */ 139 @Override 140 public long getUserId(); 141 142 /** 143 * Sets the user ID of this asset category. 144 * 145 * @param userId the user ID of this asset category 146 */ 147 @Override 148 public void setUserId(long userId); 149 150 /** 151 * Returns the user uuid of this asset category. 152 * 153 * @return the user uuid of this asset category 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 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 @Override 488 public boolean isNew(); 489 490 @Override 491 public void setNew(boolean n); 492 493 @Override 494 public boolean isCachedModel(); 495 496 @Override 497 public void setCachedModel(boolean cachedModel); 498 499 @Override 500 public boolean isEscapedModel(); 501 502 @Override 503 public Serializable getPrimaryKeyObj(); 504 505 @Override 506 public void setPrimaryKeyObj(Serializable primaryKeyObj); 507 508 @Override 509 public ExpandoBridge getExpandoBridge(); 510 511 @Override 512 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 513 514 @Override 515 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 516 517 @Override 518 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 519 520 public String[] getAvailableLanguageIds(); 521 522 public String getDefaultLanguageId(); 523 524 public void prepareLocalizedFieldsForImport() throws LocaleException; 525 526 public void prepareLocalizedFieldsForImport(Locale defaultImportLocale) 527 throws LocaleException; 528 529 @Override 530 public Object clone(); 531 532 @Override 533 public int compareTo(AssetCategory assetCategory); 534 535 @Override 536 public int hashCode(); 537 538 @Override 539 public CacheModel<AssetCategory> toCacheModel(); 540 541 @Override 542 public AssetCategory toEscapedModel(); 543 544 @Override 545 public AssetCategory toUnescapedModel(); 546 547 @Override 548 public String toString(); 549 550 @Override 551 public String toXmlString(); 552 }