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