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