001 /** 002 * Copyright (c) 2000-present 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.model.BaseModel; 022 import com.liferay.portal.model.CacheModel; 023 import com.liferay.portal.model.LocalizedModel; 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>, LocalizedModel, 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 */ 155 @Override 156 public String getUserUuid(); 157 158 /** 159 * Sets the user uuid of this d d m content. 160 * 161 * @param userUuid the user uuid of this d d m content 162 */ 163 @Override 164 public void setUserUuid(String userUuid); 165 166 /** 167 * Returns the user name of this d d m content. 168 * 169 * @return the user name of this d d m content 170 */ 171 @AutoEscape 172 @Override 173 public String getUserName(); 174 175 /** 176 * Sets the user name of this d d m content. 177 * 178 * @param userName the user name of this d d m content 179 */ 180 @Override 181 public void setUserName(String userName); 182 183 /** 184 * Returns the create date of this d d m content. 185 * 186 * @return the create date of this d d m content 187 */ 188 @Override 189 public Date getCreateDate(); 190 191 /** 192 * Sets the create date of this d d m content. 193 * 194 * @param createDate the create date of this d d m content 195 */ 196 @Override 197 public void setCreateDate(Date createDate); 198 199 /** 200 * Returns the modified date of this d d m content. 201 * 202 * @return the modified date of this d d m content 203 */ 204 @Override 205 public Date getModifiedDate(); 206 207 /** 208 * Sets the modified date of this d d m content. 209 * 210 * @param modifiedDate the modified date of this d d m content 211 */ 212 @Override 213 public void setModifiedDate(Date modifiedDate); 214 215 /** 216 * Returns the name of this d d m content. 217 * 218 * @return the name of this d d m content 219 */ 220 public String getName(); 221 222 /** 223 * 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. 224 * 225 * @param locale the locale of the language 226 * @return the localized name of this d d m content 227 */ 228 @AutoEscape 229 public String getName(Locale locale); 230 231 /** 232 * 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. 233 * 234 * @param locale the local of the language 235 * @param useDefault whether to use the default language if no localization exists for the requested language 236 * @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. 237 */ 238 @AutoEscape 239 public String getName(Locale locale, boolean useDefault); 240 241 /** 242 * 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. 243 * 244 * @param languageId the ID of the language 245 * @return the localized name of this d d m content 246 */ 247 @AutoEscape 248 public String getName(String languageId); 249 250 /** 251 * 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. 252 * 253 * @param languageId the ID of the language 254 * @param useDefault whether to use the default language if no localization exists for the requested language 255 * @return the localized name of this d d m content 256 */ 257 @AutoEscape 258 public String getName(String languageId, boolean useDefault); 259 260 @AutoEscape 261 public String getNameCurrentLanguageId(); 262 263 @AutoEscape 264 public String getNameCurrentValue(); 265 266 /** 267 * Returns a map of the locales and localized names of this d d m content. 268 * 269 * @return the locales and localized names of this d d m content 270 */ 271 public Map<Locale, String> getNameMap(); 272 273 /** 274 * Sets the name of this d d m content. 275 * 276 * @param name the name of this d d m content 277 */ 278 public void setName(String name); 279 280 /** 281 * Sets the localized name of this d d m content in the language. 282 * 283 * @param name the localized name of this d d m content 284 * @param locale the locale of the language 285 */ 286 public void setName(String name, Locale locale); 287 288 /** 289 * Sets the localized name of this d d m content in the language, and sets the default locale. 290 * 291 * @param name the localized name of this d d m content 292 * @param locale the locale of the language 293 * @param defaultLocale the default locale 294 */ 295 public void setName(String name, Locale locale, Locale defaultLocale); 296 297 public void setNameCurrentLanguageId(String languageId); 298 299 /** 300 * Sets the localized names of this d d m content from the map of locales and localized names. 301 * 302 * @param nameMap the locales and localized names of this d d m content 303 */ 304 public void setNameMap(Map<Locale, String> nameMap); 305 306 /** 307 * Sets the localized names of this d d m content from the map of locales and localized names, and sets the default locale. 308 * 309 * @param nameMap the locales and localized names of this d d m content 310 * @param defaultLocale the default locale 311 */ 312 public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale); 313 314 /** 315 * Returns the description of this d d m content. 316 * 317 * @return the description of this d d m content 318 */ 319 @AutoEscape 320 public String getDescription(); 321 322 /** 323 * Sets the description of this d d m content. 324 * 325 * @param description the description of this d d m content 326 */ 327 public void setDescription(String description); 328 329 /** 330 * Returns the data of this d d m content. 331 * 332 * @return the data of this d d m content 333 */ 334 @AutoEscape 335 public String getData(); 336 337 /** 338 * Sets the data of this d d m content. 339 * 340 * @param data the data of this d d m content 341 */ 342 public void setData(String data); 343 344 @Override 345 public boolean isNew(); 346 347 @Override 348 public void setNew(boolean n); 349 350 @Override 351 public boolean isCachedModel(); 352 353 @Override 354 public void setCachedModel(boolean cachedModel); 355 356 @Override 357 public boolean isEscapedModel(); 358 359 @Override 360 public Serializable getPrimaryKeyObj(); 361 362 @Override 363 public void setPrimaryKeyObj(Serializable primaryKeyObj); 364 365 @Override 366 public ExpandoBridge getExpandoBridge(); 367 368 @Override 369 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 370 371 @Override 372 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 373 374 @Override 375 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 376 377 @Override 378 public String[] getAvailableLanguageIds(); 379 380 @Override 381 public String getDefaultLanguageId(); 382 383 @Override 384 public void prepareLocalizedFieldsForImport() throws LocaleException; 385 386 @Override 387 public void prepareLocalizedFieldsForImport(Locale defaultImportLocale) 388 throws LocaleException; 389 390 @Override 391 public Object clone(); 392 393 @Override 394 public int compareTo( 395 com.liferay.portlet.dynamicdatamapping.model.DDMContent ddmContent); 396 397 @Override 398 public int hashCode(); 399 400 @Override 401 public CacheModel<com.liferay.portlet.dynamicdatamapping.model.DDMContent> toCacheModel(); 402 403 @Override 404 public com.liferay.portlet.dynamicdatamapping.model.DDMContent toEscapedModel(); 405 406 @Override 407 public com.liferay.portlet.dynamicdatamapping.model.DDMContent toUnescapedModel(); 408 409 @Override 410 public String toString(); 411 412 @Override 413 public String toXmlString(); 414 }