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 DDMStructure service. Represents a row in the "DDMStructure" 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.DDMStructureModelImpl} 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.DDMStructureImpl}. 037 * </p> 038 * 039 * @author Brian Wing Shun Chan 040 * @see DDMStructure 041 * @see com.liferay.portlet.dynamicdatamapping.model.impl.DDMStructureImpl 042 * @see com.liferay.portlet.dynamicdatamapping.model.impl.DDMStructureModelImpl 043 * @generated 044 */ 045 public interface DDMStructureModel extends BaseModel<DDMStructure>, GroupedModel { 046 /* 047 * NOTE FOR DEVELOPERS: 048 * 049 * Never modify or reference this interface directly. All methods that expect a d d m structure model instance should use the {@link DDMStructure} interface instead. 050 */ 051 052 /** 053 * Returns the primary key of this d d m structure. 054 * 055 * @return the primary key of this d d m structure 056 */ 057 public long getPrimaryKey(); 058 059 /** 060 * Sets the primary key of this d d m structure. 061 * 062 * @param primaryKey the primary key of this d d m structure 063 */ 064 public void setPrimaryKey(long primaryKey); 065 066 /** 067 * Returns the uuid of this d d m structure. 068 * 069 * @return the uuid of this d d m structure 070 */ 071 @AutoEscape 072 public String getUuid(); 073 074 /** 075 * Sets the uuid of this d d m structure. 076 * 077 * @param uuid the uuid of this d d m structure 078 */ 079 public void setUuid(String uuid); 080 081 /** 082 * Returns the structure ID of this d d m structure. 083 * 084 * @return the structure ID of this d d m structure 085 */ 086 public long getStructureId(); 087 088 /** 089 * Sets the structure ID of this d d m structure. 090 * 091 * @param structureId the structure ID of this d d m structure 092 */ 093 public void setStructureId(long structureId); 094 095 /** 096 * Returns the group ID of this d d m structure. 097 * 098 * @return the group ID of this d d m structure 099 */ 100 public long getGroupId(); 101 102 /** 103 * Sets the group ID of this d d m structure. 104 * 105 * @param groupId the group ID of this d d m structure 106 */ 107 public void setGroupId(long groupId); 108 109 /** 110 * Returns the company ID of this d d m structure. 111 * 112 * @return the company ID of this d d m structure 113 */ 114 public long getCompanyId(); 115 116 /** 117 * Sets the company ID of this d d m structure. 118 * 119 * @param companyId the company ID of this d d m structure 120 */ 121 public void setCompanyId(long companyId); 122 123 /** 124 * Returns the user ID of this d d m structure. 125 * 126 * @return the user ID of this d d m structure 127 */ 128 public long getUserId(); 129 130 /** 131 * Sets the user ID of this d d m structure. 132 * 133 * @param userId the user ID of this d d m structure 134 */ 135 public void setUserId(long userId); 136 137 /** 138 * Returns the user uuid of this d d m structure. 139 * 140 * @return the user uuid of this d d m structure 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 structure. 147 * 148 * @param userUuid the user uuid of this d d m structure 149 */ 150 public void setUserUuid(String userUuid); 151 152 /** 153 * Returns the user name of this d d m structure. 154 * 155 * @return the user name of this d d m structure 156 */ 157 @AutoEscape 158 public String getUserName(); 159 160 /** 161 * Sets the user name of this d d m structure. 162 * 163 * @param userName the user name of this d d m structure 164 */ 165 public void setUserName(String userName); 166 167 /** 168 * Returns the create date of this d d m structure. 169 * 170 * @return the create date of this d d m structure 171 */ 172 public Date getCreateDate(); 173 174 /** 175 * Sets the create date of this d d m structure. 176 * 177 * @param createDate the create date of this d d m structure 178 */ 179 public void setCreateDate(Date createDate); 180 181 /** 182 * Returns the modified date of this d d m structure. 183 * 184 * @return the modified date of this d d m structure 185 */ 186 public Date getModifiedDate(); 187 188 /** 189 * Sets the modified date of this d d m structure. 190 * 191 * @param modifiedDate the modified date of this d d m structure 192 */ 193 public void setModifiedDate(Date modifiedDate); 194 195 /** 196 * Returns the fully qualified class name of this d d m structure. 197 * 198 * @return the fully qualified class name of this d d m structure 199 */ 200 public String getClassName(); 201 202 /** 203 * Returns the class name ID of this d d m structure. 204 * 205 * @return the class name ID of this d d m structure 206 */ 207 public long getClassNameId(); 208 209 /** 210 * Sets the class name ID of this d d m structure. 211 * 212 * @param classNameId the class name ID of this d d m structure 213 */ 214 public void setClassNameId(long classNameId); 215 216 /** 217 * Returns the structure key of this d d m structure. 218 * 219 * @return the structure key of this d d m structure 220 */ 221 public String getStructureKey(); 222 223 /** 224 * Sets the structure key of this d d m structure. 225 * 226 * @param structureKey the structure key of this d d m structure 227 */ 228 public void setStructureKey(String structureKey); 229 230 /** 231 * Returns the name of this d d m structure. 232 * 233 * @return the name of this d d m structure 234 */ 235 public String getName(); 236 237 /** 238 * Returns the localized name of this d d m structure in the language. Uses the default language if no localization exists for the requested language. 239 * 240 * @param locale the locale of the language 241 * @return the localized name of this d d m structure 242 */ 243 @AutoEscape 244 public String getName(Locale locale); 245 246 /** 247 * Returns the localized name of this d d m structure in the language, optionally using the default language if no localization exists for the requested language. 248 * 249 * @param locale the local of the language 250 * @param useDefault whether to use the default language if no localization exists for the requested language 251 * @return the localized name of this d d m structure. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned. 252 */ 253 @AutoEscape 254 public String getName(Locale locale, boolean useDefault); 255 256 /** 257 * Returns the localized name of this d d m structure in the language. Uses the default language if no localization exists for the requested language. 258 * 259 * @param languageId the ID of the language 260 * @return the localized name of this d d m structure 261 */ 262 @AutoEscape 263 public String getName(String languageId); 264 265 /** 266 * Returns the localized name of this d d m structure in the language, optionally using the default language if no localization exists for the requested language. 267 * 268 * @param languageId the ID of the language 269 * @param useDefault whether to use the default language if no localization exists for the requested language 270 * @return the localized name of this d d m structure 271 */ 272 @AutoEscape 273 public String getName(String languageId, boolean useDefault); 274 275 @AutoEscape 276 public String getNameCurrentLanguageId(); 277 278 @AutoEscape 279 public String getNameCurrentValue(); 280 281 /** 282 * Returns a map of the locales and localized names of this d d m structure. 283 * 284 * @return the locales and localized names of this d d m structure 285 */ 286 public Map<Locale, String> getNameMap(); 287 288 /** 289 * Sets the name of this d d m structure. 290 * 291 * @param name the name of this d d m structure 292 */ 293 public void setName(String name); 294 295 /** 296 * Sets the localized name of this d d m structure in the language. 297 * 298 * @param name the localized name of this d d m structure 299 * @param locale the locale of the language 300 */ 301 public void setName(String name, Locale locale); 302 303 /** 304 * Sets the localized name of this d d m structure in the language, and sets the default locale. 305 * 306 * @param name the localized name of this d d m structure 307 * @param locale the locale of the language 308 * @param defaultLocale the default locale 309 */ 310 public void setName(String name, Locale locale, Locale defaultLocale); 311 312 public void setNameCurrentLanguageId(String languageId); 313 314 /** 315 * Sets the localized names of this d d m structure from the map of locales and localized names. 316 * 317 * @param nameMap the locales and localized names of this d d m structure 318 */ 319 public void setNameMap(Map<Locale, String> nameMap); 320 321 /** 322 * Sets the localized names of this d d m structure from the map of locales and localized names, and sets the default locale. 323 * 324 * @param nameMap the locales and localized names of this d d m structure 325 * @param defaultLocale the default locale 326 */ 327 public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale); 328 329 /** 330 * Returns the description of this d d m structure. 331 * 332 * @return the description of this d d m structure 333 */ 334 public String getDescription(); 335 336 /** 337 * Returns the localized description of this d d m structure in the language. Uses the default language if no localization exists for the requested language. 338 * 339 * @param locale the locale of the language 340 * @return the localized description of this d d m structure 341 */ 342 @AutoEscape 343 public String getDescription(Locale locale); 344 345 /** 346 * Returns the localized description of this d d m structure in the language, optionally using the default language if no localization exists for the requested language. 347 * 348 * @param locale the local of the language 349 * @param useDefault whether to use the default language if no localization exists for the requested language 350 * @return the localized description of this d d m structure. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned. 351 */ 352 @AutoEscape 353 public String getDescription(Locale locale, boolean useDefault); 354 355 /** 356 * Returns the localized description of this d d m structure in the language. Uses the default language if no localization exists for the requested language. 357 * 358 * @param languageId the ID of the language 359 * @return the localized description of this d d m structure 360 */ 361 @AutoEscape 362 public String getDescription(String languageId); 363 364 /** 365 * Returns the localized description of this d d m structure in the language, optionally using the default language if no localization exists for the requested language. 366 * 367 * @param languageId the ID of the language 368 * @param useDefault whether to use the default language if no localization exists for the requested language 369 * @return the localized description of this d d m structure 370 */ 371 @AutoEscape 372 public String getDescription(String languageId, boolean useDefault); 373 374 @AutoEscape 375 public String getDescriptionCurrentLanguageId(); 376 377 @AutoEscape 378 public String getDescriptionCurrentValue(); 379 380 /** 381 * Returns a map of the locales and localized descriptions of this d d m structure. 382 * 383 * @return the locales and localized descriptions of this d d m structure 384 */ 385 public Map<Locale, String> getDescriptionMap(); 386 387 /** 388 * Sets the description of this d d m structure. 389 * 390 * @param description the description of this d d m structure 391 */ 392 public void setDescription(String description); 393 394 /** 395 * Sets the localized description of this d d m structure in the language. 396 * 397 * @param description the localized description of this d d m structure 398 * @param locale the locale of the language 399 */ 400 public void setDescription(String description, Locale locale); 401 402 /** 403 * Sets the localized description of this d d m structure in the language, and sets the default locale. 404 * 405 * @param description the localized description of this d d m structure 406 * @param locale the locale of the language 407 * @param defaultLocale the default locale 408 */ 409 public void setDescription(String description, Locale locale, 410 Locale defaultLocale); 411 412 public void setDescriptionCurrentLanguageId(String languageId); 413 414 /** 415 * Sets the localized descriptions of this d d m structure from the map of locales and localized descriptions. 416 * 417 * @param descriptionMap the locales and localized descriptions of this d d m structure 418 */ 419 public void setDescriptionMap(Map<Locale, String> descriptionMap); 420 421 /** 422 * Sets the localized descriptions of this d d m structure from the map of locales and localized descriptions, and sets the default locale. 423 * 424 * @param descriptionMap the locales and localized descriptions of this d d m structure 425 * @param defaultLocale the default locale 426 */ 427 public void setDescriptionMap(Map<Locale, String> descriptionMap, 428 Locale defaultLocale); 429 430 /** 431 * Returns the xsd of this d d m structure. 432 * 433 * @return the xsd of this d d m structure 434 */ 435 @AutoEscape 436 public String getXsd(); 437 438 /** 439 * Sets the xsd of this d d m structure. 440 * 441 * @param xsd the xsd of this d d m structure 442 */ 443 public void setXsd(String xsd); 444 445 /** 446 * Returns the storage type of this d d m structure. 447 * 448 * @return the storage type of this d d m structure 449 */ 450 @AutoEscape 451 public String getStorageType(); 452 453 /** 454 * Sets the storage type of this d d m structure. 455 * 456 * @param storageType the storage type of this d d m structure 457 */ 458 public void setStorageType(String storageType); 459 460 /** 461 * Returns the type of this d d m structure. 462 * 463 * @return the type of this d d m structure 464 */ 465 public int getType(); 466 467 /** 468 * Sets the type of this d d m structure. 469 * 470 * @param type the type of this d d m structure 471 */ 472 public void setType(int type); 473 474 public boolean isNew(); 475 476 public void setNew(boolean n); 477 478 public boolean isCachedModel(); 479 480 public void setCachedModel(boolean cachedModel); 481 482 public boolean isEscapedModel(); 483 484 public Serializable getPrimaryKeyObj(); 485 486 public void setPrimaryKeyObj(Serializable primaryKeyObj); 487 488 public ExpandoBridge getExpandoBridge(); 489 490 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 491 492 public Object clone(); 493 494 public int compareTo(DDMStructure ddmStructure); 495 496 public int hashCode(); 497 498 public CacheModel<DDMStructure> toCacheModel(); 499 500 public DDMStructure toEscapedModel(); 501 502 public String toString(); 503 504 public String toXmlString(); 505 }