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