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