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