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