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.mobiledevicerules.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.AttachedModel; 023 import com.liferay.portal.model.BaseModel; 024 import com.liferay.portal.model.CacheModel; 025 import com.liferay.portal.model.StagedGroupedModel; 026 import com.liferay.portal.service.ServiceContext; 027 028 import com.liferay.portlet.expando.model.ExpandoBridge; 029 030 import java.io.Serializable; 031 032 import java.util.Date; 033 import java.util.Locale; 034 import java.util.Map; 035 036 /** 037 * The base model interface for the MDRAction service. Represents a row in the "MDRAction" database table, with each column mapped to a property of this class. 038 * 039 * <p> 040 * This interface and its corresponding implementation {@link com.liferay.portlet.mobiledevicerules.model.impl.MDRActionModelImpl} 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.mobiledevicerules.model.impl.MDRActionImpl}. 041 * </p> 042 * 043 * @author Edward C. Han 044 * @see MDRAction 045 * @see com.liferay.portlet.mobiledevicerules.model.impl.MDRActionImpl 046 * @see com.liferay.portlet.mobiledevicerules.model.impl.MDRActionModelImpl 047 * @generated 048 */ 049 @ProviderType 050 public interface MDRActionModel extends AttachedModel, BaseModel<MDRAction>, 051 StagedGroupedModel { 052 /* 053 * NOTE FOR DEVELOPERS: 054 * 055 * Never modify or reference this interface directly. All methods that expect a m d r action model instance should use the {@link MDRAction} interface instead. 056 */ 057 058 /** 059 * Returns the primary key of this m d r action. 060 * 061 * @return the primary key of this m d r action 062 */ 063 public long getPrimaryKey(); 064 065 /** 066 * Sets the primary key of this m d r action. 067 * 068 * @param primaryKey the primary key of this m d r action 069 */ 070 public void setPrimaryKey(long primaryKey); 071 072 /** 073 * Returns the uuid of this m d r action. 074 * 075 * @return the uuid of this m d r action 076 */ 077 @AutoEscape 078 @Override 079 public String getUuid(); 080 081 /** 082 * Sets the uuid of this m d r action. 083 * 084 * @param uuid the uuid of this m d r action 085 */ 086 @Override 087 public void setUuid(String uuid); 088 089 /** 090 * Returns the action ID of this m d r action. 091 * 092 * @return the action ID of this m d r action 093 */ 094 public long getActionId(); 095 096 /** 097 * Sets the action ID of this m d r action. 098 * 099 * @param actionId the action ID of this m d r action 100 */ 101 public void setActionId(long actionId); 102 103 /** 104 * Returns the group ID of this m d r action. 105 * 106 * @return the group ID of this m d r action 107 */ 108 @Override 109 public long getGroupId(); 110 111 /** 112 * Sets the group ID of this m d r action. 113 * 114 * @param groupId the group ID of this m d r action 115 */ 116 @Override 117 public void setGroupId(long groupId); 118 119 /** 120 * Returns the company ID of this m d r action. 121 * 122 * @return the company ID of this m d r action 123 */ 124 @Override 125 public long getCompanyId(); 126 127 /** 128 * Sets the company ID of this m d r action. 129 * 130 * @param companyId the company ID of this m d r action 131 */ 132 @Override 133 public void setCompanyId(long companyId); 134 135 /** 136 * Returns the user ID of this m d r action. 137 * 138 * @return the user ID of this m d r action 139 */ 140 @Override 141 public long getUserId(); 142 143 /** 144 * Sets the user ID of this m d r action. 145 * 146 * @param userId the user ID of this m d r action 147 */ 148 @Override 149 public void setUserId(long userId); 150 151 /** 152 * Returns the user uuid of this m d r action. 153 * 154 * @return the user uuid of this m d r action 155 * @throws SystemException if a system exception occurred 156 */ 157 @Override 158 public String getUserUuid() throws SystemException; 159 160 /** 161 * Sets the user uuid of this m d r action. 162 * 163 * @param userUuid the user uuid of this m d r action 164 */ 165 @Override 166 public void setUserUuid(String userUuid); 167 168 /** 169 * Returns the user name of this m d r action. 170 * 171 * @return the user name of this m d r action 172 */ 173 @AutoEscape 174 @Override 175 public String getUserName(); 176 177 /** 178 * Sets the user name of this m d r action. 179 * 180 * @param userName the user name of this m d r action 181 */ 182 @Override 183 public void setUserName(String userName); 184 185 /** 186 * Returns the create date of this m d r action. 187 * 188 * @return the create date of this m d r action 189 */ 190 @Override 191 public Date getCreateDate(); 192 193 /** 194 * Sets the create date of this m d r action. 195 * 196 * @param createDate the create date of this m d r action 197 */ 198 @Override 199 public void setCreateDate(Date createDate); 200 201 /** 202 * Returns the modified date of this m d r action. 203 * 204 * @return the modified date of this m d r action 205 */ 206 @Override 207 public Date getModifiedDate(); 208 209 /** 210 * Sets the modified date of this m d r action. 211 * 212 * @param modifiedDate the modified date of this m d r action 213 */ 214 @Override 215 public void setModifiedDate(Date modifiedDate); 216 217 /** 218 * Returns the fully qualified class name of this m d r action. 219 * 220 * @return the fully qualified class name of this m d r action 221 */ 222 @Override 223 public String getClassName(); 224 225 public void setClassName(String className); 226 227 /** 228 * Returns the class name ID of this m d r action. 229 * 230 * @return the class name ID of this m d r action 231 */ 232 @Override 233 public long getClassNameId(); 234 235 /** 236 * Sets the class name ID of this m d r action. 237 * 238 * @param classNameId the class name ID of this m d r action 239 */ 240 @Override 241 public void setClassNameId(long classNameId); 242 243 /** 244 * Returns the class p k of this m d r action. 245 * 246 * @return the class p k of this m d r action 247 */ 248 @Override 249 public long getClassPK(); 250 251 /** 252 * Sets the class p k of this m d r action. 253 * 254 * @param classPK the class p k of this m d r action 255 */ 256 @Override 257 public void setClassPK(long classPK); 258 259 /** 260 * Returns the rule group instance ID of this m d r action. 261 * 262 * @return the rule group instance ID of this m d r action 263 */ 264 public long getRuleGroupInstanceId(); 265 266 /** 267 * Sets the rule group instance ID of this m d r action. 268 * 269 * @param ruleGroupInstanceId the rule group instance ID of this m d r action 270 */ 271 public void setRuleGroupInstanceId(long ruleGroupInstanceId); 272 273 /** 274 * Returns the name of this m d r action. 275 * 276 * @return the name of this m d r action 277 */ 278 public String getName(); 279 280 /** 281 * Returns the localized name of this m d r action in the language. Uses the default language if no localization exists for the requested language. 282 * 283 * @param locale the locale of the language 284 * @return the localized name of this m d r action 285 */ 286 @AutoEscape 287 public String getName(Locale locale); 288 289 /** 290 * Returns the localized name of this m d r action in the language, optionally using the default language if no localization exists for the requested language. 291 * 292 * @param locale the local of the language 293 * @param useDefault whether to use the default language if no localization exists for the requested language 294 * @return the localized name of this m d r action. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned. 295 */ 296 @AutoEscape 297 public String getName(Locale locale, boolean useDefault); 298 299 /** 300 * Returns the localized name of this m d r action in the language. Uses the default language if no localization exists for the requested language. 301 * 302 * @param languageId the ID of the language 303 * @return the localized name of this m d r action 304 */ 305 @AutoEscape 306 public String getName(String languageId); 307 308 /** 309 * Returns the localized name of this m d r action in the language, optionally using the default language if no localization exists for the requested language. 310 * 311 * @param languageId the ID of the language 312 * @param useDefault whether to use the default language if no localization exists for the requested language 313 * @return the localized name of this m d r action 314 */ 315 @AutoEscape 316 public String getName(String languageId, boolean useDefault); 317 318 @AutoEscape 319 public String getNameCurrentLanguageId(); 320 321 @AutoEscape 322 public String getNameCurrentValue(); 323 324 /** 325 * Returns a map of the locales and localized names of this m d r action. 326 * 327 * @return the locales and localized names of this m d r action 328 */ 329 public Map<Locale, String> getNameMap(); 330 331 /** 332 * Sets the name of this m d r action. 333 * 334 * @param name the name of this m d r action 335 */ 336 public void setName(String name); 337 338 /** 339 * Sets the localized name of this m d r action in the language. 340 * 341 * @param name the localized name of this m d r action 342 * @param locale the locale of the language 343 */ 344 public void setName(String name, Locale locale); 345 346 /** 347 * Sets the localized name of this m d r action in the language, and sets the default locale. 348 * 349 * @param name the localized name of this m d r action 350 * @param locale the locale of the language 351 * @param defaultLocale the default locale 352 */ 353 public void setName(String name, Locale locale, Locale defaultLocale); 354 355 public void setNameCurrentLanguageId(String languageId); 356 357 /** 358 * Sets the localized names of this m d r action from the map of locales and localized names. 359 * 360 * @param nameMap the locales and localized names of this m d r action 361 */ 362 public void setNameMap(Map<Locale, String> nameMap); 363 364 /** 365 * Sets the localized names of this m d r action from the map of locales and localized names, and sets the default locale. 366 * 367 * @param nameMap the locales and localized names of this m d r action 368 * @param defaultLocale the default locale 369 */ 370 public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale); 371 372 /** 373 * Returns the description of this m d r action. 374 * 375 * @return the description of this m d r action 376 */ 377 public String getDescription(); 378 379 /** 380 * Returns the localized description of this m d r action in the language. Uses the default language if no localization exists for the requested language. 381 * 382 * @param locale the locale of the language 383 * @return the localized description of this m d r action 384 */ 385 @AutoEscape 386 public String getDescription(Locale locale); 387 388 /** 389 * Returns the localized description of this m d r action in the language, optionally using the default language if no localization exists for the requested language. 390 * 391 * @param locale the local of the language 392 * @param useDefault whether to use the default language if no localization exists for the requested language 393 * @return the localized description of this m d r action. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned. 394 */ 395 @AutoEscape 396 public String getDescription(Locale locale, boolean useDefault); 397 398 /** 399 * Returns the localized description of this m d r action in the language. Uses the default language if no localization exists for the requested language. 400 * 401 * @param languageId the ID of the language 402 * @return the localized description of this m d r action 403 */ 404 @AutoEscape 405 public String getDescription(String languageId); 406 407 /** 408 * Returns the localized description of this m d r action in the language, optionally using the default language if no localization exists for the requested language. 409 * 410 * @param languageId the ID of the language 411 * @param useDefault whether to use the default language if no localization exists for the requested language 412 * @return the localized description of this m d r action 413 */ 414 @AutoEscape 415 public String getDescription(String languageId, boolean useDefault); 416 417 @AutoEscape 418 public String getDescriptionCurrentLanguageId(); 419 420 @AutoEscape 421 public String getDescriptionCurrentValue(); 422 423 /** 424 * Returns a map of the locales and localized descriptions of this m d r action. 425 * 426 * @return the locales and localized descriptions of this m d r action 427 */ 428 public Map<Locale, String> getDescriptionMap(); 429 430 /** 431 * Sets the description of this m d r action. 432 * 433 * @param description the description of this m d r action 434 */ 435 public void setDescription(String description); 436 437 /** 438 * Sets the localized description of this m d r action in the language. 439 * 440 * @param description the localized description of this m d r action 441 * @param locale the locale of the language 442 */ 443 public void setDescription(String description, Locale locale); 444 445 /** 446 * Sets the localized description of this m d r action in the language, and sets the default locale. 447 * 448 * @param description the localized description of this m d r action 449 * @param locale the locale of the language 450 * @param defaultLocale the default locale 451 */ 452 public void setDescription(String description, Locale locale, 453 Locale defaultLocale); 454 455 public void setDescriptionCurrentLanguageId(String languageId); 456 457 /** 458 * Sets the localized descriptions of this m d r action from the map of locales and localized descriptions. 459 * 460 * @param descriptionMap the locales and localized descriptions of this m d r action 461 */ 462 public void setDescriptionMap(Map<Locale, String> descriptionMap); 463 464 /** 465 * Sets the localized descriptions of this m d r action from the map of locales and localized descriptions, and sets the default locale. 466 * 467 * @param descriptionMap the locales and localized descriptions of this m d r action 468 * @param defaultLocale the default locale 469 */ 470 public void setDescriptionMap(Map<Locale, String> descriptionMap, 471 Locale defaultLocale); 472 473 /** 474 * Returns the type of this m d r action. 475 * 476 * @return the type of this m d r action 477 */ 478 @AutoEscape 479 public String getType(); 480 481 /** 482 * Sets the type of this m d r action. 483 * 484 * @param type the type of this m d r action 485 */ 486 public void setType(String type); 487 488 /** 489 * Returns the type settings of this m d r action. 490 * 491 * @return the type settings of this m d r action 492 */ 493 @AutoEscape 494 public String getTypeSettings(); 495 496 /** 497 * Sets the type settings of this m d r action. 498 * 499 * @param typeSettings the type settings of this m d r action 500 */ 501 public void setTypeSettings(String typeSettings); 502 503 @Override 504 public boolean isNew(); 505 506 @Override 507 public void setNew(boolean n); 508 509 @Override 510 public boolean isCachedModel(); 511 512 @Override 513 public void setCachedModel(boolean cachedModel); 514 515 @Override 516 public boolean isEscapedModel(); 517 518 @Override 519 public Serializable getPrimaryKeyObj(); 520 521 @Override 522 public void setPrimaryKeyObj(Serializable primaryKeyObj); 523 524 @Override 525 public ExpandoBridge getExpandoBridge(); 526 527 @Override 528 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 529 530 @Override 531 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 532 533 @Override 534 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 535 536 public String[] getAvailableLanguageIds(); 537 538 public String getDefaultLanguageId(); 539 540 public void prepareLocalizedFieldsForImport() throws LocaleException; 541 542 public void prepareLocalizedFieldsForImport(Locale defaultImportLocale) 543 throws LocaleException; 544 545 @Override 546 public Object clone(); 547 548 @Override 549 public int compareTo(MDRAction mdrAction); 550 551 @Override 552 public int hashCode(); 553 554 @Override 555 public CacheModel<MDRAction> toCacheModel(); 556 557 @Override 558 public MDRAction toEscapedModel(); 559 560 @Override 561 public MDRAction toUnescapedModel(); 562 563 @Override 564 public String toString(); 565 566 @Override 567 public String toXmlString(); 568 }