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.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.model.AttachedModel; 022 import com.liferay.portal.model.BaseModel; 023 import com.liferay.portal.model.CacheModel; 024 import com.liferay.portal.model.LocalizedModel; 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 LocalizedModel, 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 */ 156 @Override 157 public String getUserUuid(); 158 159 /** 160 * Sets the user uuid of this m d r action. 161 * 162 * @param userUuid the user uuid of this m d r action 163 */ 164 @Override 165 public void setUserUuid(String userUuid); 166 167 /** 168 * Returns the user name of this m d r action. 169 * 170 * @return the user name of this m d r action 171 */ 172 @AutoEscape 173 @Override 174 public String getUserName(); 175 176 /** 177 * Sets the user name of this m d r action. 178 * 179 * @param userName the user name of this m d r action 180 */ 181 @Override 182 public void setUserName(String userName); 183 184 /** 185 * Returns the create date of this m d r action. 186 * 187 * @return the create date of this m d r action 188 */ 189 @Override 190 public Date getCreateDate(); 191 192 /** 193 * Sets the create date of this m d r action. 194 * 195 * @param createDate the create date of this m d r action 196 */ 197 @Override 198 public void setCreateDate(Date createDate); 199 200 /** 201 * Returns the modified date of this m d r action. 202 * 203 * @return the modified date of this m d r action 204 */ 205 @Override 206 public Date getModifiedDate(); 207 208 /** 209 * Sets the modified date of this m d r action. 210 * 211 * @param modifiedDate the modified date of this m d r action 212 */ 213 @Override 214 public void setModifiedDate(Date modifiedDate); 215 216 /** 217 * Returns the fully qualified class name of this m d r action. 218 * 219 * @return the fully qualified class name of this m d r action 220 */ 221 @Override 222 public String getClassName(); 223 224 public void setClassName(String className); 225 226 /** 227 * Returns the class name ID of this m d r action. 228 * 229 * @return the class name ID of this m d r action 230 */ 231 @Override 232 public long getClassNameId(); 233 234 /** 235 * Sets the class name ID of this m d r action. 236 * 237 * @param classNameId the class name ID of this m d r action 238 */ 239 @Override 240 public void setClassNameId(long classNameId); 241 242 /** 243 * Returns the class p k of this m d r action. 244 * 245 * @return the class p k of this m d r action 246 */ 247 @Override 248 public long getClassPK(); 249 250 /** 251 * Sets the class p k of this m d r action. 252 * 253 * @param classPK the class p k of this m d r action 254 */ 255 @Override 256 public void setClassPK(long classPK); 257 258 /** 259 * Returns the rule group instance ID of this m d r action. 260 * 261 * @return the rule group instance ID of this m d r action 262 */ 263 public long getRuleGroupInstanceId(); 264 265 /** 266 * Sets the rule group instance ID of this m d r action. 267 * 268 * @param ruleGroupInstanceId the rule group instance ID of this m d r action 269 */ 270 public void setRuleGroupInstanceId(long ruleGroupInstanceId); 271 272 /** 273 * Returns the name of this m d r action. 274 * 275 * @return the name of this m d r action 276 */ 277 public String getName(); 278 279 /** 280 * 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. 281 * 282 * @param locale the locale of the language 283 * @return the localized name of this m d r action 284 */ 285 @AutoEscape 286 public String getName(Locale locale); 287 288 /** 289 * 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. 290 * 291 * @param locale the local of the language 292 * @param useDefault whether to use the default language if no localization exists for the requested language 293 * @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. 294 */ 295 @AutoEscape 296 public String getName(Locale locale, boolean useDefault); 297 298 /** 299 * 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. 300 * 301 * @param languageId the ID of the language 302 * @return the localized name of this m d r action 303 */ 304 @AutoEscape 305 public String getName(String languageId); 306 307 /** 308 * 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. 309 * 310 * @param languageId the ID of the language 311 * @param useDefault whether to use the default language if no localization exists for the requested language 312 * @return the localized name of this m d r action 313 */ 314 @AutoEscape 315 public String getName(String languageId, boolean useDefault); 316 317 @AutoEscape 318 public String getNameCurrentLanguageId(); 319 320 @AutoEscape 321 public String getNameCurrentValue(); 322 323 /** 324 * Returns a map of the locales and localized names of this m d r action. 325 * 326 * @return the locales and localized names of this m d r action 327 */ 328 public Map<Locale, String> getNameMap(); 329 330 /** 331 * Sets the name of this m d r action. 332 * 333 * @param name the name of this m d r action 334 */ 335 public void setName(String name); 336 337 /** 338 * Sets the localized name of this m d r action in the language. 339 * 340 * @param name the localized name of this m d r action 341 * @param locale the locale of the language 342 */ 343 public void setName(String name, Locale locale); 344 345 /** 346 * Sets the localized name of this m d r action in the language, and sets the default locale. 347 * 348 * @param name the localized name of this m d r action 349 * @param locale the locale of the language 350 * @param defaultLocale the default locale 351 */ 352 public void setName(String name, Locale locale, Locale defaultLocale); 353 354 public void setNameCurrentLanguageId(String languageId); 355 356 /** 357 * Sets the localized names of this m d r action from the map of locales and localized names. 358 * 359 * @param nameMap the locales and localized names of this m d r action 360 */ 361 public void setNameMap(Map<Locale, String> nameMap); 362 363 /** 364 * Sets the localized names of this m d r action from the map of locales and localized names, and sets the default locale. 365 * 366 * @param nameMap the locales and localized names of this m d r action 367 * @param defaultLocale the default locale 368 */ 369 public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale); 370 371 /** 372 * Returns the description of this m d r action. 373 * 374 * @return the description of this m d r action 375 */ 376 public String getDescription(); 377 378 /** 379 * 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. 380 * 381 * @param locale the locale of the language 382 * @return the localized description of this m d r action 383 */ 384 @AutoEscape 385 public String getDescription(Locale locale); 386 387 /** 388 * 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. 389 * 390 * @param locale the local of the language 391 * @param useDefault whether to use the default language if no localization exists for the requested language 392 * @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. 393 */ 394 @AutoEscape 395 public String getDescription(Locale locale, boolean useDefault); 396 397 /** 398 * 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. 399 * 400 * @param languageId the ID of the language 401 * @return the localized description of this m d r action 402 */ 403 @AutoEscape 404 public String getDescription(String languageId); 405 406 /** 407 * 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. 408 * 409 * @param languageId the ID of the language 410 * @param useDefault whether to use the default language if no localization exists for the requested language 411 * @return the localized description of this m d r action 412 */ 413 @AutoEscape 414 public String getDescription(String languageId, boolean useDefault); 415 416 @AutoEscape 417 public String getDescriptionCurrentLanguageId(); 418 419 @AutoEscape 420 public String getDescriptionCurrentValue(); 421 422 /** 423 * Returns a map of the locales and localized descriptions of this m d r action. 424 * 425 * @return the locales and localized descriptions of this m d r action 426 */ 427 public Map<Locale, String> getDescriptionMap(); 428 429 /** 430 * Sets the description of this m d r action. 431 * 432 * @param description the description of this m d r action 433 */ 434 public void setDescription(String description); 435 436 /** 437 * Sets the localized description of this m d r action in the language. 438 * 439 * @param description the localized description of this m d r action 440 * @param locale the locale of the language 441 */ 442 public void setDescription(String description, Locale locale); 443 444 /** 445 * Sets the localized description of this m d r action in the language, and sets the default locale. 446 * 447 * @param description the localized description of this m d r action 448 * @param locale the locale of the language 449 * @param defaultLocale the default locale 450 */ 451 public void setDescription(String description, Locale locale, 452 Locale defaultLocale); 453 454 public void setDescriptionCurrentLanguageId(String languageId); 455 456 /** 457 * Sets the localized descriptions of this m d r action from the map of locales and localized descriptions. 458 * 459 * @param descriptionMap the locales and localized descriptions of this m d r action 460 */ 461 public void setDescriptionMap(Map<Locale, String> descriptionMap); 462 463 /** 464 * Sets the localized descriptions of this m d r action from the map of locales and localized descriptions, and sets the default locale. 465 * 466 * @param descriptionMap the locales and localized descriptions of this m d r action 467 * @param defaultLocale the default locale 468 */ 469 public void setDescriptionMap(Map<Locale, String> descriptionMap, 470 Locale defaultLocale); 471 472 /** 473 * Returns the type of this m d r action. 474 * 475 * @return the type of this m d r action 476 */ 477 @AutoEscape 478 public String getType(); 479 480 /** 481 * Sets the type of this m d r action. 482 * 483 * @param type the type of this m d r action 484 */ 485 public void setType(String type); 486 487 /** 488 * Returns the type settings of this m d r action. 489 * 490 * @return the type settings of this m d r action 491 */ 492 @AutoEscape 493 public String getTypeSettings(); 494 495 /** 496 * Sets the type settings of this m d r action. 497 * 498 * @param typeSettings the type settings of this m d r action 499 */ 500 public void setTypeSettings(String typeSettings); 501 502 @Override 503 public boolean isNew(); 504 505 @Override 506 public void setNew(boolean n); 507 508 @Override 509 public boolean isCachedModel(); 510 511 @Override 512 public void setCachedModel(boolean cachedModel); 513 514 @Override 515 public boolean isEscapedModel(); 516 517 @Override 518 public Serializable getPrimaryKeyObj(); 519 520 @Override 521 public void setPrimaryKeyObj(Serializable primaryKeyObj); 522 523 @Override 524 public ExpandoBridge getExpandoBridge(); 525 526 @Override 527 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 528 529 @Override 530 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 531 532 @Override 533 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 534 535 @Override 536 public String[] getAvailableLanguageIds(); 537 538 @Override 539 public String getDefaultLanguageId(); 540 541 @Override 542 public void prepareLocalizedFieldsForImport() throws LocaleException; 543 544 @Override 545 public void prepareLocalizedFieldsForImport(Locale defaultImportLocale) 546 throws LocaleException; 547 548 @Override 549 public Object clone(); 550 551 @Override 552 public int compareTo( 553 com.liferay.portlet.mobiledevicerules.model.MDRAction mdrAction); 554 555 @Override 556 public int hashCode(); 557 558 @Override 559 public CacheModel<com.liferay.portlet.mobiledevicerules.model.MDRAction> toCacheModel(); 560 561 @Override 562 public com.liferay.portlet.mobiledevicerules.model.MDRAction toEscapedModel(); 563 564 @Override 565 public com.liferay.portlet.mobiledevicerules.model.MDRAction toUnescapedModel(); 566 567 @Override 568 public String toString(); 569 570 @Override 571 public String toXmlString(); 572 }