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