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