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