001 /** 002 * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved. 003 * 004 * The contents of this file are subject to the terms of the Liferay Enterprise 005 * Subscription License ("License"). You may not use this file except in 006 * compliance with the License. You can obtain a copy of the License by 007 * contacting Liferay, Inc. See the License for the specific language governing 008 * permissions and limitations under the License, including but not limited to 009 * distribution rights of the Software. 010 * 011 * 012 * 013 */ 014 015 package com.liferay.portlet.asset.model; 016 017 import com.liferay.portal.kernel.bean.AutoEscape; 018 import com.liferay.portal.kernel.exception.SystemException; 019 import com.liferay.portal.model.BaseModel; 020 import com.liferay.portal.model.CacheModel; 021 import com.liferay.portal.model.GroupedModel; 022 import com.liferay.portal.service.ServiceContext; 023 024 import com.liferay.portlet.expando.model.ExpandoBridge; 025 026 import java.io.Serializable; 027 028 import java.util.Date; 029 import java.util.Locale; 030 import java.util.Map; 031 032 /** 033 * The base model interface for the AssetCategory service. Represents a row in the "AssetCategory" database table, with each column mapped to a property of this class. 034 * 035 * <p> 036 * This interface and its corresponding implementation {@link com.liferay.portlet.asset.model.impl.AssetCategoryModelImpl} 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.AssetCategoryImpl}. 037 * </p> 038 * 039 * @author Brian Wing Shun Chan 040 * @see AssetCategory 041 * @see com.liferay.portlet.asset.model.impl.AssetCategoryImpl 042 * @see com.liferay.portlet.asset.model.impl.AssetCategoryModelImpl 043 * @generated 044 */ 045 public interface AssetCategoryModel extends BaseModel<AssetCategory>, 046 GroupedModel { 047 /* 048 * NOTE FOR DEVELOPERS: 049 * 050 * Never modify or reference this interface directly. All methods that expect a asset category model instance should use the {@link AssetCategory} interface instead. 051 */ 052 053 /** 054 * Gets the primary key of this asset category. 055 * 056 * @return the primary key of this asset category 057 */ 058 public long getPrimaryKey(); 059 060 /** 061 * Sets the primary key of this asset category 062 * 063 * @param primaryKey the primary key of this asset category 064 */ 065 public void setPrimaryKey(long primaryKey); 066 067 /** 068 * Gets the uuid of this asset category. 069 * 070 * @return the uuid of this asset category 071 */ 072 @AutoEscape 073 public String getUuid(); 074 075 /** 076 * Sets the uuid of this asset category. 077 * 078 * @param uuid the uuid of this asset category 079 */ 080 public void setUuid(String uuid); 081 082 /** 083 * Gets the category ID of this asset category. 084 * 085 * @return the category ID of this asset category 086 */ 087 public long getCategoryId(); 088 089 /** 090 * Sets the category ID of this asset category. 091 * 092 * @param categoryId the category ID of this asset category 093 */ 094 public void setCategoryId(long categoryId); 095 096 /** 097 * Gets the group ID of this asset category. 098 * 099 * @return the group ID of this asset category 100 */ 101 public long getGroupId(); 102 103 /** 104 * Sets the group ID of this asset category. 105 * 106 * @param groupId the group ID of this asset category 107 */ 108 public void setGroupId(long groupId); 109 110 /** 111 * Gets the company ID of this asset category. 112 * 113 * @return the company ID of this asset category 114 */ 115 public long getCompanyId(); 116 117 /** 118 * Sets the company ID of this asset category. 119 * 120 * @param companyId the company ID of this asset category 121 */ 122 public void setCompanyId(long companyId); 123 124 /** 125 * Gets the user ID of this asset category. 126 * 127 * @return the user ID of this asset category 128 */ 129 public long getUserId(); 130 131 /** 132 * Sets the user ID of this asset category. 133 * 134 * @param userId the user ID of this asset category 135 */ 136 public void setUserId(long userId); 137 138 /** 139 * Gets the user uuid of this asset category. 140 * 141 * @return the user uuid of this asset category 142 * @throws SystemException if a system exception occurred 143 */ 144 public String getUserUuid() throws SystemException; 145 146 /** 147 * Sets the user uuid of this asset category. 148 * 149 * @param userUuid the user uuid of this asset category 150 */ 151 public void setUserUuid(String userUuid); 152 153 /** 154 * Gets the user name of this asset category. 155 * 156 * @return the user name of this asset category 157 */ 158 @AutoEscape 159 public String getUserName(); 160 161 /** 162 * Sets the user name of this asset category. 163 * 164 * @param userName the user name of this asset category 165 */ 166 public void setUserName(String userName); 167 168 /** 169 * Gets the create date of this asset category. 170 * 171 * @return the create date of this asset category 172 */ 173 public Date getCreateDate(); 174 175 /** 176 * Sets the create date of this asset category. 177 * 178 * @param createDate the create date of this asset category 179 */ 180 public void setCreateDate(Date createDate); 181 182 /** 183 * Gets the modified date of this asset category. 184 * 185 * @return the modified date of this asset category 186 */ 187 public Date getModifiedDate(); 188 189 /** 190 * Sets the modified date of this asset category. 191 * 192 * @param modifiedDate the modified date of this asset category 193 */ 194 public void setModifiedDate(Date modifiedDate); 195 196 /** 197 * Gets the parent category ID of this asset category. 198 * 199 * @return the parent category ID of this asset category 200 */ 201 public long getParentCategoryId(); 202 203 /** 204 * Sets the parent category ID of this asset category. 205 * 206 * @param parentCategoryId the parent category ID of this asset category 207 */ 208 public void setParentCategoryId(long parentCategoryId); 209 210 /** 211 * Gets the left category ID of this asset category. 212 * 213 * @return the left category ID of this asset category 214 */ 215 public long getLeftCategoryId(); 216 217 /** 218 * Sets the left category ID of this asset category. 219 * 220 * @param leftCategoryId the left category ID of this asset category 221 */ 222 public void setLeftCategoryId(long leftCategoryId); 223 224 /** 225 * Gets the right category ID of this asset category. 226 * 227 * @return the right category ID of this asset category 228 */ 229 public long getRightCategoryId(); 230 231 /** 232 * Sets the right category ID of this asset category. 233 * 234 * @param rightCategoryId the right category ID of this asset category 235 */ 236 public void setRightCategoryId(long rightCategoryId); 237 238 /** 239 * Gets the name of this asset category. 240 * 241 * @return the name of this asset category 242 */ 243 @AutoEscape 244 public String getName(); 245 246 /** 247 * Sets the name of this asset category. 248 * 249 * @param name the name of this asset category 250 */ 251 public void setName(String name); 252 253 /** 254 * Gets the title of this asset category. 255 * 256 * @return the title of this asset category 257 */ 258 public String getTitle(); 259 260 /** 261 * Gets the localized title of this asset category. Uses the default language if no localization exists for the requested language. 262 * 263 * @param locale the locale to get the localized title for 264 * @return the localized title of this asset category 265 */ 266 public String getTitle(Locale locale); 267 268 /** 269 * Gets the localized title of this asset category, optionally using the default language if no localization exists for the requested language. 270 * 271 * @param locale the local to get the localized title for 272 * @param useDefault whether to use the default language if no localization exists for the requested language 273 * @return the localized title of this asset category. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned. 274 */ 275 public String getTitle(Locale locale, boolean useDefault); 276 277 /** 278 * Gets the localized title of this asset category. Uses the default language if no localization exists for the requested language. 279 * 280 * @param languageId the id of the language to get the localized title for 281 * @return the localized title of this asset category 282 */ 283 public String getTitle(String languageId); 284 285 /** 286 * Gets the localized title of this asset category, optionally using the default language if no localization exists for the requested language. 287 * 288 * @param languageId the id of the language to get the localized title for 289 * @param useDefault whether to use the default language if no localization exists for the requested language 290 * @return the localized title of this asset category 291 */ 292 public String getTitle(String languageId, boolean useDefault); 293 294 /** 295 * Gets a map of the locales and localized title of this asset category. 296 * 297 * @return the locales and localized title 298 */ 299 public Map<Locale, String> getTitleMap(); 300 301 /** 302 * Sets the title of this asset category. 303 * 304 * @param title the title of this asset category 305 */ 306 public void setTitle(String title); 307 308 /** 309 * Sets the localized title of this asset category. 310 * 311 * @param locale the locale to set the localized title for 312 * @param title the localized title of this asset category 313 */ 314 public void setTitle(Locale locale, String title); 315 316 /** 317 * Sets the localized titles of this asset category from the map of locales and localized titles. 318 * 319 * @param titleMap the locales and localized titles of this asset category 320 */ 321 public void setTitleMap(Map<Locale, String> titleMap); 322 323 /** 324 * Gets the vocabulary ID of this asset category. 325 * 326 * @return the vocabulary ID of this asset category 327 */ 328 public long getVocabularyId(); 329 330 /** 331 * Sets the vocabulary ID of this asset category. 332 * 333 * @param vocabularyId the vocabulary ID of this asset category 334 */ 335 public void setVocabularyId(long vocabularyId); 336 337 public boolean isNew(); 338 339 public void setNew(boolean n); 340 341 public boolean isCachedModel(); 342 343 public void setCachedModel(boolean cachedModel); 344 345 public boolean isEscapedModel(); 346 347 public void setEscapedModel(boolean escapedModel); 348 349 public Serializable getPrimaryKeyObj(); 350 351 public void setPrimaryKeyObj(Serializable primaryKeyObj); 352 353 public ExpandoBridge getExpandoBridge(); 354 355 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 356 357 public Object clone(); 358 359 public int compareTo(AssetCategory assetCategory); 360 361 public int hashCode(); 362 363 public CacheModel<AssetCategory> toCacheModel(); 364 365 public AssetCategory toEscapedModel(); 366 367 public String toString(); 368 369 public String toXmlString(); 370 }