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.polls.model;
016    
017    import com.liferay.portal.kernel.bean.AutoEscape;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.model.BaseModel;
020    import com.liferay.portal.model.CacheModel;
021    import com.liferay.portal.model.GroupedModel;
022    import com.liferay.portal.service.ServiceContext;
023    
024    import com.liferay.portlet.expando.model.ExpandoBridge;
025    
026    import java.io.Serializable;
027    
028    import java.util.Date;
029    import java.util.Locale;
030    import java.util.Map;
031    
032    /**
033     * The base model interface for the PollsQuestion service. Represents a row in the "PollsQuestion" database table, with each column mapped to a property of this class.
034     *
035     * <p>
036     * This interface and its corresponding implementation {@link com.liferay.portlet.polls.model.impl.PollsQuestionModelImpl} 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.polls.model.impl.PollsQuestionImpl}.
037     * </p>
038     *
039     * @author Brian Wing Shun Chan
040     * @see PollsQuestion
041     * @see com.liferay.portlet.polls.model.impl.PollsQuestionImpl
042     * @see com.liferay.portlet.polls.model.impl.PollsQuestionModelImpl
043     * @generated
044     */
045    public interface PollsQuestionModel extends BaseModel<PollsQuestion>,
046            GroupedModel {
047            /*
048             * NOTE FOR DEVELOPERS:
049             *
050             * Never modify or reference this interface directly. All methods that expect a polls question model instance should use the {@link PollsQuestion} interface instead.
051             */
052    
053            /**
054             * Returns the primary key of this polls question.
055             *
056             * @return the primary key of this polls question
057             */
058            public long getPrimaryKey();
059    
060            /**
061             * Sets the primary key of this polls question.
062             *
063             * @param primaryKey the primary key of this polls question
064             */
065            public void setPrimaryKey(long primaryKey);
066    
067            /**
068             * Returns the uuid of this polls question.
069             *
070             * @return the uuid of this polls question
071             */
072            @AutoEscape
073            public String getUuid();
074    
075            /**
076             * Sets the uuid of this polls question.
077             *
078             * @param uuid the uuid of this polls question
079             */
080            public void setUuid(String uuid);
081    
082            /**
083             * Returns the question ID of this polls question.
084             *
085             * @return the question ID of this polls question
086             */
087            public long getQuestionId();
088    
089            /**
090             * Sets the question ID of this polls question.
091             *
092             * @param questionId the question ID of this polls question
093             */
094            public void setQuestionId(long questionId);
095    
096            /**
097             * Returns the group ID of this polls question.
098             *
099             * @return the group ID of this polls question
100             */
101            public long getGroupId();
102    
103            /**
104             * Sets the group ID of this polls question.
105             *
106             * @param groupId the group ID of this polls question
107             */
108            public void setGroupId(long groupId);
109    
110            /**
111             * Returns the company ID of this polls question.
112             *
113             * @return the company ID of this polls question
114             */
115            public long getCompanyId();
116    
117            /**
118             * Sets the company ID of this polls question.
119             *
120             * @param companyId the company ID of this polls question
121             */
122            public void setCompanyId(long companyId);
123    
124            /**
125             * Returns the user ID of this polls question.
126             *
127             * @return the user ID of this polls question
128             */
129            public long getUserId();
130    
131            /**
132             * Sets the user ID of this polls question.
133             *
134             * @param userId the user ID of this polls question
135             */
136            public void setUserId(long userId);
137    
138            /**
139             * Returns the user uuid of this polls question.
140             *
141             * @return the user uuid of this polls question
142             * @throws SystemException if a system exception occurred
143             */
144            public String getUserUuid() throws SystemException;
145    
146            /**
147             * Sets the user uuid of this polls question.
148             *
149             * @param userUuid the user uuid of this polls question
150             */
151            public void setUserUuid(String userUuid);
152    
153            /**
154             * Returns the user name of this polls question.
155             *
156             * @return the user name of this polls question
157             */
158            @AutoEscape
159            public String getUserName();
160    
161            /**
162             * Sets the user name of this polls question.
163             *
164             * @param userName the user name of this polls question
165             */
166            public void setUserName(String userName);
167    
168            /**
169             * Returns the create date of this polls question.
170             *
171             * @return the create date of this polls question
172             */
173            public Date getCreateDate();
174    
175            /**
176             * Sets the create date of this polls question.
177             *
178             * @param createDate the create date of this polls question
179             */
180            public void setCreateDate(Date createDate);
181    
182            /**
183             * Returns the modified date of this polls question.
184             *
185             * @return the modified date of this polls question
186             */
187            public Date getModifiedDate();
188    
189            /**
190             * Sets the modified date of this polls question.
191             *
192             * @param modifiedDate the modified date of this polls question
193             */
194            public void setModifiedDate(Date modifiedDate);
195    
196            /**
197             * Returns the title of this polls question.
198             *
199             * @return the title of this polls question
200             */
201            public String getTitle();
202    
203            /**
204             * Returns the localized title of this polls question in the language. Uses the default language if no localization exists for the requested language.
205             *
206             * @param locale the locale of the language
207             * @return the localized title of this polls question
208             */
209            @AutoEscape
210            public String getTitle(Locale locale);
211    
212            /**
213             * Returns the localized title of this polls question in the language, optionally using the default language if no localization exists for the requested language.
214             *
215             * @param locale the local of the language
216             * @param useDefault whether to use the default language if no localization exists for the requested language
217             * @return the localized title of this polls question. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned.
218             */
219            @AutoEscape
220            public String getTitle(Locale locale, boolean useDefault);
221    
222            /**
223             * Returns the localized title of this polls question in the language. Uses the default language if no localization exists for the requested language.
224             *
225             * @param languageId the ID of the language
226             * @return the localized title of this polls question
227             */
228            @AutoEscape
229            public String getTitle(String languageId);
230    
231            /**
232             * Returns the localized title of this polls question in the language, optionally using the default language if no localization exists for the requested language.
233             *
234             * @param languageId the ID of the language
235             * @param useDefault whether to use the default language if no localization exists for the requested language
236             * @return the localized title of this polls question
237             */
238            @AutoEscape
239            public String getTitle(String languageId, boolean useDefault);
240    
241            @AutoEscape
242            public String getTitleCurrentLanguageId();
243    
244            @AutoEscape
245            public String getTitleCurrentValue();
246    
247            /**
248             * Returns a map of the locales and localized titles of this polls question.
249             *
250             * @return the locales and localized titles of this polls question
251             */
252            public Map<Locale, String> getTitleMap();
253    
254            /**
255             * Sets the title of this polls question.
256             *
257             * @param title the title of this polls question
258             */
259            public void setTitle(String title);
260    
261            /**
262             * Sets the localized title of this polls question in the language.
263             *
264             * @param title the localized title of this polls question
265             * @param locale the locale of the language
266             */
267            public void setTitle(String title, Locale locale);
268    
269            /**
270             * Sets the localized title of this polls question in the language, and sets the default locale.
271             *
272             * @param title the localized title of this polls question
273             * @param locale the locale of the language
274             * @param defaultLocale the default locale
275             */
276            public void setTitle(String title, Locale locale, Locale defaultLocale);
277    
278            public void setTitleCurrentLanguageId(String languageId);
279    
280            /**
281             * Sets the localized titles of this polls question from the map of locales and localized titles.
282             *
283             * @param titleMap the locales and localized titles of this polls question
284             */
285            public void setTitleMap(Map<Locale, String> titleMap);
286    
287            /**
288             * Sets the localized titles of this polls question from the map of locales and localized titles, and sets the default locale.
289             *
290             * @param titleMap the locales and localized titles of this polls question
291             * @param defaultLocale the default locale
292             */
293            public void setTitleMap(Map<Locale, String> titleMap, Locale defaultLocale);
294    
295            /**
296             * Returns the description of this polls question.
297             *
298             * @return the description of this polls question
299             */
300            public String getDescription();
301    
302            /**
303             * Returns the localized description of this polls question in the language. Uses the default language if no localization exists for the requested language.
304             *
305             * @param locale the locale of the language
306             * @return the localized description of this polls question
307             */
308            @AutoEscape
309            public String getDescription(Locale locale);
310    
311            /**
312             * Returns the localized description of this polls question in the language, optionally using the default language if no localization exists for the requested language.
313             *
314             * @param locale the local of the language
315             * @param useDefault whether to use the default language if no localization exists for the requested language
316             * @return the localized description of this polls question. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned.
317             */
318            @AutoEscape
319            public String getDescription(Locale locale, boolean useDefault);
320    
321            /**
322             * Returns the localized description of this polls question in the language. Uses the default language if no localization exists for the requested language.
323             *
324             * @param languageId the ID of the language
325             * @return the localized description of this polls question
326             */
327            @AutoEscape
328            public String getDescription(String languageId);
329    
330            /**
331             * Returns the localized description of this polls question in the language, optionally using the default language if no localization exists for the requested language.
332             *
333             * @param languageId the ID 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 polls question
336             */
337            @AutoEscape
338            public String getDescription(String languageId, boolean useDefault);
339    
340            @AutoEscape
341            public String getDescriptionCurrentLanguageId();
342    
343            @AutoEscape
344            public String getDescriptionCurrentValue();
345    
346            /**
347             * Returns a map of the locales and localized descriptions of this polls question.
348             *
349             * @return the locales and localized descriptions of this polls question
350             */
351            public Map<Locale, String> getDescriptionMap();
352    
353            /**
354             * Sets the description of this polls question.
355             *
356             * @param description the description of this polls question
357             */
358            public void setDescription(String description);
359    
360            /**
361             * Sets the localized description of this polls question in the language.
362             *
363             * @param description the localized description of this polls question
364             * @param locale the locale of the language
365             */
366            public void setDescription(String description, Locale locale);
367    
368            /**
369             * Sets the localized description of this polls question in the language, and sets the default locale.
370             *
371             * @param description the localized description of this polls question
372             * @param locale the locale of the language
373             * @param defaultLocale the default locale
374             */
375            public void setDescription(String description, Locale locale,
376                    Locale defaultLocale);
377    
378            public void setDescriptionCurrentLanguageId(String languageId);
379    
380            /**
381             * Sets the localized descriptions of this polls question from the map of locales and localized descriptions.
382             *
383             * @param descriptionMap the locales and localized descriptions of this polls question
384             */
385            public void setDescriptionMap(Map<Locale, String> descriptionMap);
386    
387            /**
388             * Sets the localized descriptions of this polls question from the map of locales and localized descriptions, and sets the default locale.
389             *
390             * @param descriptionMap the locales and localized descriptions of this polls question
391             * @param defaultLocale the default locale
392             */
393            public void setDescriptionMap(Map<Locale, String> descriptionMap,
394                    Locale defaultLocale);
395    
396            /**
397             * Returns the expiration date of this polls question.
398             *
399             * @return the expiration date of this polls question
400             */
401            public Date getExpirationDate();
402    
403            /**
404             * Sets the expiration date of this polls question.
405             *
406             * @param expirationDate the expiration date of this polls question
407             */
408            public void setExpirationDate(Date expirationDate);
409    
410            /**
411             * Returns the last vote date of this polls question.
412             *
413             * @return the last vote date of this polls question
414             */
415            public Date getLastVoteDate();
416    
417            /**
418             * Sets the last vote date of this polls question.
419             *
420             * @param lastVoteDate the last vote date of this polls question
421             */
422            public void setLastVoteDate(Date lastVoteDate);
423    
424            public boolean isNew();
425    
426            public void setNew(boolean n);
427    
428            public boolean isCachedModel();
429    
430            public void setCachedModel(boolean cachedModel);
431    
432            public boolean isEscapedModel();
433    
434            public Serializable getPrimaryKeyObj();
435    
436            public void setPrimaryKeyObj(Serializable primaryKeyObj);
437    
438            public ExpandoBridge getExpandoBridge();
439    
440            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
441    
442            public Object clone();
443    
444            public int compareTo(PollsQuestion pollsQuestion);
445    
446            public int hashCode();
447    
448            public CacheModel<PollsQuestion> toCacheModel();
449    
450            public PollsQuestion toEscapedModel();
451    
452            public String toString();
453    
454            public String toXmlString();
455    }