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