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