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