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 AssetVocabulary service. Represents a row in the "AssetVocabulary" 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.AssetVocabularyModelImpl} 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.AssetVocabularyImpl}. 041 * </p> 042 * 043 * @author Brian Wing Shun Chan 044 * @see AssetVocabulary 045 * @see com.liferay.portlet.asset.model.impl.AssetVocabularyImpl 046 * @see com.liferay.portlet.asset.model.impl.AssetVocabularyModelImpl 047 * @generated 048 */ 049 @ProviderType 050 public interface AssetVocabularyModel extends BaseModel<AssetVocabulary>, 051 LocalizedModel, ShardedModel, StagedGroupedModel { 052 /* 053 * NOTE FOR DEVELOPERS: 054 * 055 * Never modify or reference this interface directly. All methods that expect a asset vocabulary model instance should use the {@link AssetVocabulary} interface instead. 056 */ 057 058 /** 059 * Returns the primary key of this asset vocabulary. 060 * 061 * @return the primary key of this asset vocabulary 062 */ 063 public long getPrimaryKey(); 064 065 /** 066 * Sets the primary key of this asset vocabulary. 067 * 068 * @param primaryKey the primary key of this asset vocabulary 069 */ 070 public void setPrimaryKey(long primaryKey); 071 072 /** 073 * Returns the uuid of this asset vocabulary. 074 * 075 * @return the uuid of this asset vocabulary 076 */ 077 @AutoEscape 078 @Override 079 public String getUuid(); 080 081 /** 082 * Sets the uuid of this asset vocabulary. 083 * 084 * @param uuid the uuid of this asset vocabulary 085 */ 086 @Override 087 public void setUuid(String uuid); 088 089 /** 090 * Returns the vocabulary ID of this asset vocabulary. 091 * 092 * @return the vocabulary ID of this asset vocabulary 093 */ 094 public long getVocabularyId(); 095 096 /** 097 * Sets the vocabulary ID of this asset vocabulary. 098 * 099 * @param vocabularyId the vocabulary ID of this asset vocabulary 100 */ 101 public void setVocabularyId(long vocabularyId); 102 103 /** 104 * Returns the group ID of this asset vocabulary. 105 * 106 * @return the group ID of this asset vocabulary 107 */ 108 @Override 109 public long getGroupId(); 110 111 /** 112 * Sets the group ID of this asset vocabulary. 113 * 114 * @param groupId the group ID of this asset vocabulary 115 */ 116 @Override 117 public void setGroupId(long groupId); 118 119 /** 120 * Returns the company ID of this asset vocabulary. 121 * 122 * @return the company ID of this asset vocabulary 123 */ 124 @Override 125 public long getCompanyId(); 126 127 /** 128 * Sets the company ID of this asset vocabulary. 129 * 130 * @param companyId the company ID of this asset vocabulary 131 */ 132 @Override 133 public void setCompanyId(long companyId); 134 135 /** 136 * Returns the user ID of this asset vocabulary. 137 * 138 * @return the user ID of this asset vocabulary 139 */ 140 @Override 141 public long getUserId(); 142 143 /** 144 * Sets the user ID of this asset vocabulary. 145 * 146 * @param userId the user ID of this asset vocabulary 147 */ 148 @Override 149 public void setUserId(long userId); 150 151 /** 152 * Returns the user uuid of this asset vocabulary. 153 * 154 * @return the user uuid of this asset vocabulary 155 */ 156 @Override 157 public String getUserUuid(); 158 159 /** 160 * Sets the user uuid of this asset vocabulary. 161 * 162 * @param userUuid the user uuid of this asset vocabulary 163 */ 164 @Override 165 public void setUserUuid(String userUuid); 166 167 /** 168 * Returns the user name of this asset vocabulary. 169 * 170 * @return the user name of this asset vocabulary 171 */ 172 @AutoEscape 173 @Override 174 public String getUserName(); 175 176 /** 177 * Sets the user name of this asset vocabulary. 178 * 179 * @param userName the user name of this asset vocabulary 180 */ 181 @Override 182 public void setUserName(String userName); 183 184 /** 185 * Returns the create date of this asset vocabulary. 186 * 187 * @return the create date of this asset vocabulary 188 */ 189 @Override 190 public Date getCreateDate(); 191 192 /** 193 * Sets the create date of this asset vocabulary. 194 * 195 * @param createDate the create date of this asset vocabulary 196 */ 197 @Override 198 public void setCreateDate(Date createDate); 199 200 /** 201 * Returns the modified date of this asset vocabulary. 202 * 203 * @return the modified date of this asset vocabulary 204 */ 205 @Override 206 public Date getModifiedDate(); 207 208 /** 209 * Sets the modified date of this asset vocabulary. 210 * 211 * @param modifiedDate the modified date of this asset vocabulary 212 */ 213 @Override 214 public void setModifiedDate(Date modifiedDate); 215 216 /** 217 * Returns the name of this asset vocabulary. 218 * 219 * @return the name of this asset vocabulary 220 */ 221 @AutoEscape 222 public String getName(); 223 224 /** 225 * Sets the name of this asset vocabulary. 226 * 227 * @param name the name of this asset vocabulary 228 */ 229 public void setName(String name); 230 231 /** 232 * Returns the title of this asset vocabulary. 233 * 234 * @return the title of this asset vocabulary 235 */ 236 public String getTitle(); 237 238 /** 239 * Returns the localized title of this asset vocabulary 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 title of this asset vocabulary 243 */ 244 @AutoEscape 245 public String getTitle(Locale locale); 246 247 /** 248 * Returns the localized title of this asset vocabulary 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 title of this asset vocabulary. 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 getTitle(Locale locale, boolean useDefault); 256 257 /** 258 * Returns the localized title of this asset vocabulary 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 title of this asset vocabulary 262 */ 263 @AutoEscape 264 public String getTitle(String languageId); 265 266 /** 267 * Returns the localized title of this asset vocabulary 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 title of this asset vocabulary 272 */ 273 @AutoEscape 274 public String getTitle(String languageId, boolean useDefault); 275 276 @AutoEscape 277 public String getTitleCurrentLanguageId(); 278 279 @AutoEscape 280 public String getTitleCurrentValue(); 281 282 /** 283 * Returns a map of the locales and localized titles of this asset vocabulary. 284 * 285 * @return the locales and localized titles of this asset vocabulary 286 */ 287 public Map<Locale, String> getTitleMap(); 288 289 /** 290 * Sets the title of this asset vocabulary. 291 * 292 * @param title the title of this asset vocabulary 293 */ 294 public void setTitle(String title); 295 296 /** 297 * Sets the localized title of this asset vocabulary in the language. 298 * 299 * @param title the localized title of this asset vocabulary 300 * @param locale the locale of the language 301 */ 302 public void setTitle(String title, Locale locale); 303 304 /** 305 * Sets the localized title of this asset vocabulary in the language, and sets the default locale. 306 * 307 * @param title the localized title of this asset vocabulary 308 * @param locale the locale of the language 309 * @param defaultLocale the default locale 310 */ 311 public void setTitle(String title, Locale locale, Locale defaultLocale); 312 313 public void setTitleCurrentLanguageId(String languageId); 314 315 /** 316 * Sets the localized titles of this asset vocabulary from the map of locales and localized titles. 317 * 318 * @param titleMap the locales and localized titles of this asset vocabulary 319 */ 320 public void setTitleMap(Map<Locale, String> titleMap); 321 322 /** 323 * Sets the localized titles of this asset vocabulary from the map of locales and localized titles, and sets the default locale. 324 * 325 * @param titleMap the locales and localized titles of this asset vocabulary 326 * @param defaultLocale the default locale 327 */ 328 public void setTitleMap(Map<Locale, String> titleMap, Locale defaultLocale); 329 330 /** 331 * Returns the description of this asset vocabulary. 332 * 333 * @return the description of this asset vocabulary 334 */ 335 public String getDescription(); 336 337 /** 338 * Returns the localized description of this asset vocabulary 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 asset vocabulary 342 */ 343 @AutoEscape 344 public String getDescription(Locale locale); 345 346 /** 347 * Returns the localized description of this asset vocabulary 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 asset vocabulary. 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 asset vocabulary 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 asset vocabulary 361 */ 362 @AutoEscape 363 public String getDescription(String languageId); 364 365 /** 366 * Returns the localized description of this asset vocabulary 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 asset vocabulary 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 asset vocabulary. 383 * 384 * @return the locales and localized descriptions of this asset vocabulary 385 */ 386 public Map<Locale, String> getDescriptionMap(); 387 388 /** 389 * Sets the description of this asset vocabulary. 390 * 391 * @param description the description of this asset vocabulary 392 */ 393 public void setDescription(String description); 394 395 /** 396 * Sets the localized description of this asset vocabulary in the language. 397 * 398 * @param description the localized description of this asset vocabulary 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 asset vocabulary in the language, and sets the default locale. 405 * 406 * @param description the localized description of this asset vocabulary 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 asset vocabulary from the map of locales and localized descriptions. 417 * 418 * @param descriptionMap the locales and localized descriptions of this asset vocabulary 419 */ 420 public void setDescriptionMap(Map<Locale, String> descriptionMap); 421 422 /** 423 * Sets the localized descriptions of this asset vocabulary from the map of locales and localized descriptions, and sets the default locale. 424 * 425 * @param descriptionMap the locales and localized descriptions of this asset vocabulary 426 * @param defaultLocale the default locale 427 */ 428 public void setDescriptionMap(Map<Locale, String> descriptionMap, 429 Locale defaultLocale); 430 431 /** 432 * Returns the settings of this asset vocabulary. 433 * 434 * @return the settings of this asset vocabulary 435 */ 436 @AutoEscape 437 public String getSettings(); 438 439 /** 440 * Sets the settings of this asset vocabulary. 441 * 442 * @param settings the settings of this asset vocabulary 443 */ 444 public void setSettings(String settings); 445 446 /** 447 * Returns the last publish date of this asset vocabulary. 448 * 449 * @return the last publish date of this asset vocabulary 450 */ 451 @Override 452 public Date getLastPublishDate(); 453 454 /** 455 * Sets the last publish date of this asset vocabulary. 456 * 457 * @param lastPublishDate the last publish date of this asset vocabulary 458 */ 459 @Override 460 public void setLastPublishDate(Date lastPublishDate); 461 462 @Override 463 public boolean isNew(); 464 465 @Override 466 public void setNew(boolean n); 467 468 @Override 469 public boolean isCachedModel(); 470 471 @Override 472 public void setCachedModel(boolean cachedModel); 473 474 @Override 475 public boolean isEscapedModel(); 476 477 @Override 478 public Serializable getPrimaryKeyObj(); 479 480 @Override 481 public void setPrimaryKeyObj(Serializable primaryKeyObj); 482 483 @Override 484 public ExpandoBridge getExpandoBridge(); 485 486 @Override 487 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 488 489 @Override 490 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 491 492 @Override 493 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 494 495 @Override 496 public String[] getAvailableLanguageIds(); 497 498 @Override 499 public String getDefaultLanguageId(); 500 501 @Override 502 public void prepareLocalizedFieldsForImport() throws LocaleException; 503 504 @Override 505 public void prepareLocalizedFieldsForImport(Locale defaultImportLocale) 506 throws LocaleException; 507 508 @Override 509 public Object clone(); 510 511 @Override 512 public int compareTo( 513 com.liferay.portlet.asset.model.AssetVocabulary assetVocabulary); 514 515 @Override 516 public int hashCode(); 517 518 @Override 519 public CacheModel<com.liferay.portlet.asset.model.AssetVocabulary> toCacheModel(); 520 521 @Override 522 public com.liferay.portlet.asset.model.AssetVocabulary toEscapedModel(); 523 524 @Override 525 public com.liferay.portlet.asset.model.AssetVocabulary toUnescapedModel(); 526 527 @Override 528 public String toString(); 529 530 @Override 531 public String toXmlString(); 532 }