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