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