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