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