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