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