001 /** 002 * Copyright (c) 2000-2010 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.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 AssetCategory service. Represents a row in the "AssetCategory" 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.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}. 035 * </p> 036 * 037 * <p> 038 * Never modify or reference this interface directly. All methods that expect a asset category model instance should use the {@link AssetCategory} interface instead. 039 * </p> 040 * 041 * @author Brian Wing Shun Chan 042 * @see AssetCategory 043 * @see com.liferay.portlet.asset.model.impl.AssetCategoryImpl 044 * @see com.liferay.portlet.asset.model.impl.AssetCategoryModelImpl 045 * @generated 046 */ 047 public interface AssetCategoryModel extends BaseModel<AssetCategory> { 048 /** 049 * Gets the primary key of this asset category. 050 * 051 * @return the primary key of this asset category 052 */ 053 public long getPrimaryKey(); 054 055 /** 056 * Sets the primary key of this asset category 057 * 058 * @param pk the primary key of this asset category 059 */ 060 public void setPrimaryKey(long pk); 061 062 /** 063 * Gets the uuid of this asset category. 064 * 065 * @return the uuid of this asset category 066 */ 067 @AutoEscape 068 public String getUuid(); 069 070 /** 071 * Sets the uuid of this asset category. 072 * 073 * @param uuid the uuid of this asset category 074 */ 075 public void setUuid(String uuid); 076 077 /** 078 * Gets the category id of this asset category. 079 * 080 * @return the category id of this asset category 081 */ 082 public long getCategoryId(); 083 084 /** 085 * Sets the category id of this asset category. 086 * 087 * @param categoryId the category id of this asset category 088 */ 089 public void setCategoryId(long categoryId); 090 091 /** 092 * Gets the group id of this asset category. 093 * 094 * @return the group id of this asset category 095 */ 096 public long getGroupId(); 097 098 /** 099 * Sets the group id of this asset category. 100 * 101 * @param groupId the group id of this asset category 102 */ 103 public void setGroupId(long groupId); 104 105 /** 106 * Gets the company id of this asset category. 107 * 108 * @return the company id of this asset category 109 */ 110 public long getCompanyId(); 111 112 /** 113 * Sets the company id of this asset category. 114 * 115 * @param companyId the company id of this asset category 116 */ 117 public void setCompanyId(long companyId); 118 119 /** 120 * Gets the user id of this asset category. 121 * 122 * @return the user id of this asset category 123 */ 124 public long getUserId(); 125 126 /** 127 * Sets the user id of this asset category. 128 * 129 * @param userId the user id of this asset category 130 */ 131 public void setUserId(long userId); 132 133 /** 134 * Gets the user uuid of this asset category. 135 * 136 * @return the user uuid of this asset category 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 category. 143 * 144 * @param userUuid the user uuid of this asset category 145 */ 146 public void setUserUuid(String userUuid); 147 148 /** 149 * Gets the user name of this asset category. 150 * 151 * @return the user name of this asset category 152 */ 153 @AutoEscape 154 public String getUserName(); 155 156 /** 157 * Sets the user name of this asset category. 158 * 159 * @param userName the user name of this asset category 160 */ 161 public void setUserName(String userName); 162 163 /** 164 * Gets the create date of this asset category. 165 * 166 * @return the create date of this asset category 167 */ 168 public Date getCreateDate(); 169 170 /** 171 * Sets the create date of this asset category. 172 * 173 * @param createDate the create date of this asset category 174 */ 175 public void setCreateDate(Date createDate); 176 177 /** 178 * Gets the modified date of this asset category. 179 * 180 * @return the modified date of this asset category 181 */ 182 public Date getModifiedDate(); 183 184 /** 185 * Sets the modified date of this asset category. 186 * 187 * @param modifiedDate the modified date of this asset category 188 */ 189 public void setModifiedDate(Date modifiedDate); 190 191 /** 192 * Gets the parent category id of this asset category. 193 * 194 * @return the parent category id of this asset category 195 */ 196 public long getParentCategoryId(); 197 198 /** 199 * Sets the parent category id of this asset category. 200 * 201 * @param parentCategoryId the parent category id of this asset category 202 */ 203 public void setParentCategoryId(long parentCategoryId); 204 205 /** 206 * Gets the left category id of this asset category. 207 * 208 * @return the left category id of this asset category 209 */ 210 public long getLeftCategoryId(); 211 212 /** 213 * Sets the left category id of this asset category. 214 * 215 * @param leftCategoryId the left category id of this asset category 216 */ 217 public void setLeftCategoryId(long leftCategoryId); 218 219 /** 220 * Gets the right category id of this asset category. 221 * 222 * @return the right category id of this asset category 223 */ 224 public long getRightCategoryId(); 225 226 /** 227 * Sets the right category id of this asset category. 228 * 229 * @param rightCategoryId the right category id of this asset category 230 */ 231 public void setRightCategoryId(long rightCategoryId); 232 233 /** 234 * Gets the name of this asset category. 235 * 236 * @return the name of this asset category 237 */ 238 @AutoEscape 239 public String getName(); 240 241 /** 242 * Sets the name of this asset category. 243 * 244 * @param name the name of this asset category 245 */ 246 public void setName(String name); 247 248 /** 249 * Gets the title of this asset category. 250 * 251 * @return the title of this asset category 252 */ 253 public String getTitle(); 254 255 /** 256 * Gets the localized title of this asset category. Uses the default language if no localization exists for the requested language. 257 * 258 * @param locale the locale to get the localized title for 259 * @return the localized title of this asset category 260 */ 261 public String getTitle(Locale locale); 262 263 /** 264 * Gets the localized title of this asset category, optionally using the default language if no localization exists for the requested language. 265 * 266 * @param locale the local to get the localized title for 267 * @param useDefault whether to use the default language if no localization exists for the requested language 268 * @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. 269 */ 270 public String getTitle(Locale locale, boolean useDefault); 271 272 /** 273 * Gets the localized title of this asset category. Uses the default language if no localization exists for the requested language. 274 * 275 * @param languageId the id of the language to get the localized title for 276 * @return the localized title of this asset category 277 */ 278 public String getTitle(String languageId); 279 280 /** 281 * Gets the localized title of this asset category, optionally using the default language if no localization exists for the requested language. 282 * 283 * @param languageId the id of the language to get the localized title for 284 * @param useDefault whether to use the default language if no localization exists for the requested language 285 * @return the localized title of this asset category 286 */ 287 public String getTitle(String languageId, boolean useDefault); 288 289 /** 290 * Gets a map of the locales and localized title of this asset category. 291 * 292 * @return the locales and localized title 293 */ 294 public Map<Locale, String> getTitleMap(); 295 296 /** 297 * Sets the title of this asset category. 298 * 299 * @param title the title of this asset category 300 */ 301 public void setTitle(String title); 302 303 /** 304 * Sets the localized title of this asset category. 305 * 306 * @param locale the locale to set the localized title for 307 * @param title the localized title of this asset category 308 */ 309 public void setTitle(Locale locale, String title); 310 311 /** 312 * Sets the localized titles of this asset category from the map of locales and localized titles. 313 * 314 * @param titleMap the locales and localized titles of this asset category 315 */ 316 public void setTitleMap(Map<Locale, String> titleMap); 317 318 /** 319 * Gets the vocabulary id of this asset category. 320 * 321 * @return the vocabulary id of this asset category 322 */ 323 public long getVocabularyId(); 324 325 /** 326 * Sets the vocabulary id of this asset category. 327 * 328 * @param vocabularyId the vocabulary id of this asset category 329 */ 330 public void setVocabularyId(long vocabularyId); 331 332 public boolean isNew(); 333 334 public void setNew(boolean n); 335 336 public boolean isCachedModel(); 337 338 public void setCachedModel(boolean cachedModel); 339 340 public boolean isEscapedModel(); 341 342 public void setEscapedModel(boolean escapedModel); 343 344 public Serializable getPrimaryKeyObj(); 345 346 public ExpandoBridge getExpandoBridge(); 347 348 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 349 350 public Object clone(); 351 352 public int compareTo(AssetCategory assetCategory); 353 354 public int hashCode(); 355 356 public AssetCategory toEscapedModel(); 357 358 public String toString(); 359 360 public String toXmlString(); 361 }