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