001 /** 002 * Copyright (c) 2000-2010 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.annotation.AutoEscape; 018 import com.liferay.portal.kernel.exception.SystemException; 019 import com.liferay.portal.model.BaseModel; 020 import com.liferay.portal.service.ServiceContext; 021 022 import com.liferay.portlet.expando.model.ExpandoBridge; 023 024 import java.io.Serializable; 025 026 import java.util.Date; 027 import java.util.Locale; 028 import java.util.Map; 029 030 /** 031 * 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. 032 * 033 * <p> 034 * 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}. 035 * </p> 036 * 037 * <p> 038 * Never modify or reference this interface directly. All methods that expect a asset vocabulary model instance should use the {@link AssetVocabulary} interface instead. 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 /** 049 * Gets the primary key of this asset vocabulary. 050 * 051 * @return the primary key of this asset vocabulary 052 */ 053 public long getPrimaryKey(); 054 055 /** 056 * Sets the primary key of this asset vocabulary 057 * 058 * @param pk the primary key of this asset vocabulary 059 */ 060 public void setPrimaryKey(long pk); 061 062 /** 063 * Gets the uuid of this asset vocabulary. 064 * 065 * @return the uuid of this asset vocabulary 066 */ 067 @AutoEscape 068 public String getUuid(); 069 070 /** 071 * Sets the uuid of this asset vocabulary. 072 * 073 * @param uuid the uuid of this asset vocabulary 074 */ 075 public void setUuid(String uuid); 076 077 /** 078 * Gets the vocabulary id of this asset vocabulary. 079 * 080 * @return the vocabulary id of this asset vocabulary 081 */ 082 public long getVocabularyId(); 083 084 /** 085 * Sets the vocabulary id of this asset vocabulary. 086 * 087 * @param vocabularyId the vocabulary id of this asset vocabulary 088 */ 089 public void setVocabularyId(long vocabularyId); 090 091 /** 092 * Gets the group id of this asset vocabulary. 093 * 094 * @return the group id of this asset vocabulary 095 */ 096 public long getGroupId(); 097 098 /** 099 * Sets the group id of this asset vocabulary. 100 * 101 * @param groupId the group id of this asset vocabulary 102 */ 103 public void setGroupId(long groupId); 104 105 /** 106 * Gets the company id of this asset vocabulary. 107 * 108 * @return the company id of this asset vocabulary 109 */ 110 public long getCompanyId(); 111 112 /** 113 * Sets the company id of this asset vocabulary. 114 * 115 * @param companyId the company id of this asset vocabulary 116 */ 117 public void setCompanyId(long companyId); 118 119 /** 120 * Gets the user id of this asset vocabulary. 121 * 122 * @return the user id of this asset vocabulary 123 */ 124 public long getUserId(); 125 126 /** 127 * Sets the user id of this asset vocabulary. 128 * 129 * @param userId the user id of this asset vocabulary 130 */ 131 public void setUserId(long userId); 132 133 /** 134 * Gets the user uuid of this asset vocabulary. 135 * 136 * @return the user uuid of this asset vocabulary 137 * @throws SystemException if a system exception occurred 138 */ 139 public String getUserUuid() throws SystemException; 140 141 /** 142 * Sets the user uuid of this asset vocabulary. 143 * 144 * @param userUuid the user uuid of this asset vocabulary 145 */ 146 public void setUserUuid(String userUuid); 147 148 /** 149 * Gets the user name of this asset vocabulary. 150 * 151 * @return the user name of this asset vocabulary 152 */ 153 @AutoEscape 154 public String getUserName(); 155 156 /** 157 * Sets the user name of this asset vocabulary. 158 * 159 * @param userName the user name of this asset vocabulary 160 */ 161 public void setUserName(String userName); 162 163 /** 164 * Gets the create date of this asset vocabulary. 165 * 166 * @return the create date of this asset vocabulary 167 */ 168 public Date getCreateDate(); 169 170 /** 171 * Sets the create date of this asset vocabulary. 172 * 173 * @param createDate the create date of this asset vocabulary 174 */ 175 public void setCreateDate(Date createDate); 176 177 /** 178 * Gets the modified date of this asset vocabulary. 179 * 180 * @return the modified date of this asset vocabulary 181 */ 182 public Date getModifiedDate(); 183 184 /** 185 * Sets the modified date of this asset vocabulary. 186 * 187 * @param modifiedDate the modified date of this asset vocabulary 188 */ 189 public void setModifiedDate(Date modifiedDate); 190 191 /** 192 * Gets the name of this asset vocabulary. 193 * 194 * @return the name of this asset vocabulary 195 */ 196 @AutoEscape 197 public String getName(); 198 199 /** 200 * Sets the name of this asset vocabulary. 201 * 202 * @param name the name of this asset vocabulary 203 */ 204 public void setName(String name); 205 206 /** 207 * Gets the title of this asset vocabulary. 208 * 209 * @return the title of this asset vocabulary 210 */ 211 public String getTitle(); 212 213 /** 214 * Gets the localized title of this asset vocabulary. Uses the default language if no localization exists for the requested language. 215 * 216 * @param locale the locale to get the localized title for 217 * @return the localized title of this asset vocabulary 218 */ 219 public String getTitle(Locale locale); 220 221 /** 222 * Gets the localized title of this asset vocabulary, optionally using the default language if no localization exists for the requested language. 223 * 224 * @param locale the local to get the localized title for 225 * @param useDefault whether to use the default language if no localization exists for the requested language 226 * @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. 227 */ 228 public String getTitle(Locale locale, boolean useDefault); 229 230 /** 231 * Gets the localized title of this asset vocabulary. Uses the default language if no localization exists for the requested language. 232 * 233 * @param languageId the id of the language to get the localized title for 234 * @return the localized title of this asset vocabulary 235 */ 236 public String getTitle(String languageId); 237 238 /** 239 * Gets the localized title of this asset vocabulary, optionally using the default language if no localization exists for the requested language. 240 * 241 * @param languageId the id of the language to get the localized title for 242 * @param useDefault whether to use the default language if no localization exists for the requested language 243 * @return the localized title of this asset vocabulary 244 */ 245 public String getTitle(String languageId, boolean useDefault); 246 247 /** 248 * Gets a map of the locales and localized title of this asset vocabulary. 249 * 250 * @return the locales and localized title 251 */ 252 public Map<Locale, String> getTitleMap(); 253 254 /** 255 * Sets the title of this asset vocabulary. 256 * 257 * @param title the title of this asset vocabulary 258 */ 259 public void setTitle(String title); 260 261 /** 262 * Sets the localized title of this asset vocabulary. 263 * 264 * @param locale the locale to set the localized title for 265 * @param title the localized title of this asset vocabulary 266 */ 267 public void setTitle(Locale locale, String title); 268 269 /** 270 * Sets the localized titles of this asset vocabulary from the map of locales and localized titles. 271 * 272 * @param titleMap the locales and localized titles of this asset vocabulary 273 */ 274 public void setTitleMap(Map<Locale, String> titleMap); 275 276 /** 277 * Gets the description of this asset vocabulary. 278 * 279 * @return the description of this asset vocabulary 280 */ 281 public String getDescription(); 282 283 /** 284 * Gets the localized description of this asset vocabulary. Uses the default language if no localization exists for the requested language. 285 * 286 * @param locale the locale to get the localized description for 287 * @return the localized description of this asset vocabulary 288 */ 289 public String getDescription(Locale locale); 290 291 /** 292 * Gets the localized description of this asset vocabulary, optionally using the default language if no localization exists for the requested language. 293 * 294 * @param locale the local to get the localized description for 295 * @param useDefault whether to use the default language if no localization exists for the requested language 296 * @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. 297 */ 298 public String getDescription(Locale locale, boolean useDefault); 299 300 /** 301 * Gets the localized description of this asset vocabulary. Uses the default language if no localization exists for the requested language. 302 * 303 * @param languageId the id of the language to get the localized description for 304 * @return the localized description of this asset vocabulary 305 */ 306 public String getDescription(String languageId); 307 308 /** 309 * Gets the localized description of this asset vocabulary, optionally using the default language if no localization exists for the requested language. 310 * 311 * @param languageId the id of the language to get the localized description for 312 * @param useDefault whether to use the default language if no localization exists for the requested language 313 * @return the localized description of this asset vocabulary 314 */ 315 public String getDescription(String languageId, boolean useDefault); 316 317 /** 318 * Gets a map of the locales and localized description of this asset vocabulary. 319 * 320 * @return the locales and localized description 321 */ 322 public Map<Locale, String> getDescriptionMap(); 323 324 /** 325 * Sets the description of this asset vocabulary. 326 * 327 * @param description the description of this asset vocabulary 328 */ 329 public void setDescription(String description); 330 331 /** 332 * Sets the localized description of this asset vocabulary. 333 * 334 * @param locale the locale to set the localized description for 335 * @param description the localized description of this asset vocabulary 336 */ 337 public void setDescription(Locale locale, String description); 338 339 /** 340 * Sets the localized descriptions of this asset vocabulary from the map of locales and localized descriptions. 341 * 342 * @param descriptionMap the locales and localized descriptions of this asset vocabulary 343 */ 344 public void setDescriptionMap(Map<Locale, String> descriptionMap); 345 346 /** 347 * Gets the settings of this asset vocabulary. 348 * 349 * @return the settings of this asset vocabulary 350 */ 351 @AutoEscape 352 public String getSettings(); 353 354 /** 355 * Sets the settings of this asset vocabulary. 356 * 357 * @param settings the settings of this asset vocabulary 358 */ 359 public void setSettings(String settings); 360 361 /** 362 * Gets a copy of this asset vocabulary as an escaped model instance by wrapping it with an {@link com.liferay.portal.kernel.bean.AutoEscapeBeanHandler}. 363 * 364 * @return the escaped model instance 365 * @see com.liferay.portal.kernel.bean.AutoEscapeBeanHandler 366 */ 367 public AssetVocabulary toEscapedModel(); 368 369 public boolean isNew(); 370 371 public void setNew(boolean n); 372 373 public boolean isCachedModel(); 374 375 public void setCachedModel(boolean cachedModel); 376 377 public boolean isEscapedModel(); 378 379 public void setEscapedModel(boolean escapedModel); 380 381 public Serializable getPrimaryKeyObj(); 382 383 public ExpandoBridge getExpandoBridge(); 384 385 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 386 387 public Object clone(); 388 389 public int compareTo(AssetVocabulary assetVocabulary); 390 391 public int hashCode(); 392 393 public String toString(); 394 395 public String toXmlString(); 396 }