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.polls.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 PollsChoice service. Represents a row in the "PollsChoice" 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.polls.model.impl.PollsChoiceModelImpl} 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.PollsChoiceImpl}.
038     * </p>
039     *
040     * @author Brian Wing Shun Chan
041     * @see PollsChoice
042     * @see com.liferay.portlet.polls.model.impl.PollsChoiceImpl
043     * @see com.liferay.portlet.polls.model.impl.PollsChoiceModelImpl
044     * @generated
045     */
046    public interface PollsChoiceModel extends BaseModel<PollsChoice>,
047            StagedGroupedModel {
048            /*
049             * NOTE FOR DEVELOPERS:
050             *
051             * Never modify or reference this interface directly. All methods that expect a polls choice model instance should use the {@link PollsChoice} interface instead.
052             */
053    
054            /**
055             * Returns the primary key of this polls choice.
056             *
057             * @return the primary key of this polls choice
058             */
059            public long getPrimaryKey();
060    
061            /**
062             * Sets the primary key of this polls choice.
063             *
064             * @param primaryKey the primary key of this polls choice
065             */
066            public void setPrimaryKey(long primaryKey);
067    
068            /**
069             * Returns the uuid of this polls choice.
070             *
071             * @return the uuid of this polls choice
072             */
073            @AutoEscape
074            public String getUuid();
075    
076            /**
077             * Sets the uuid of this polls choice.
078             *
079             * @param uuid the uuid of this polls choice
080             */
081            public void setUuid(String uuid);
082    
083            /**
084             * Returns the choice ID of this polls choice.
085             *
086             * @return the choice ID of this polls choice
087             */
088            public long getChoiceId();
089    
090            /**
091             * Sets the choice ID of this polls choice.
092             *
093             * @param choiceId the choice ID of this polls choice
094             */
095            public void setChoiceId(long choiceId);
096    
097            /**
098             * Returns the group ID of this polls choice.
099             *
100             * @return the group ID of this polls choice
101             */
102            public long getGroupId();
103    
104            /**
105             * Sets the group ID of this polls choice.
106             *
107             * @param groupId the group ID of this polls choice
108             */
109            public void setGroupId(long groupId);
110    
111            /**
112             * Returns the company ID of this polls choice.
113             *
114             * @return the company ID of this polls choice
115             */
116            public long getCompanyId();
117    
118            /**
119             * Sets the company ID of this polls choice.
120             *
121             * @param companyId the company ID of this polls choice
122             */
123            public void setCompanyId(long companyId);
124    
125            /**
126             * Returns the user ID of this polls choice.
127             *
128             * @return the user ID of this polls choice
129             */
130            public long getUserId();
131    
132            /**
133             * Sets the user ID of this polls choice.
134             *
135             * @param userId the user ID of this polls choice
136             */
137            public void setUserId(long userId);
138    
139            /**
140             * Returns the user uuid of this polls choice.
141             *
142             * @return the user uuid of this polls choice
143             * @throws SystemException if a system exception occurred
144             */
145            public String getUserUuid() throws SystemException;
146    
147            /**
148             * Sets the user uuid of this polls choice.
149             *
150             * @param userUuid the user uuid of this polls choice
151             */
152            public void setUserUuid(String userUuid);
153    
154            /**
155             * Returns the user name of this polls choice.
156             *
157             * @return the user name of this polls choice
158             */
159            @AutoEscape
160            public String getUserName();
161    
162            /**
163             * Sets the user name of this polls choice.
164             *
165             * @param userName the user name of this polls choice
166             */
167            public void setUserName(String userName);
168    
169            /**
170             * Returns the create date of this polls choice.
171             *
172             * @return the create date of this polls choice
173             */
174            public Date getCreateDate();
175    
176            /**
177             * Sets the create date of this polls choice.
178             *
179             * @param createDate the create date of this polls choice
180             */
181            public void setCreateDate(Date createDate);
182    
183            /**
184             * Returns the modified date of this polls choice.
185             *
186             * @return the modified date of this polls choice
187             */
188            public Date getModifiedDate();
189    
190            /**
191             * Sets the modified date of this polls choice.
192             *
193             * @param modifiedDate the modified date of this polls choice
194             */
195            public void setModifiedDate(Date modifiedDate);
196    
197            /**
198             * Returns the question ID of this polls choice.
199             *
200             * @return the question ID of this polls choice
201             */
202            public long getQuestionId();
203    
204            /**
205             * Sets the question ID of this polls choice.
206             *
207             * @param questionId the question ID of this polls choice
208             */
209            public void setQuestionId(long questionId);
210    
211            /**
212             * Returns the name of this polls choice.
213             *
214             * @return the name of this polls choice
215             */
216            @AutoEscape
217            public String getName();
218    
219            /**
220             * Sets the name of this polls choice.
221             *
222             * @param name the name of this polls choice
223             */
224            public void setName(String name);
225    
226            /**
227             * Returns the description of this polls choice.
228             *
229             * @return the description of this polls choice
230             */
231            public String getDescription();
232    
233            /**
234             * Returns the localized description of this polls choice 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 description of this polls choice
238             */
239            @AutoEscape
240            public String getDescription(Locale locale);
241    
242            /**
243             * Returns the localized description of this polls choice 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 description of this polls choice. 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 getDescription(Locale locale, boolean useDefault);
251    
252            /**
253             * Returns the localized description of this polls choice 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 description of this polls choice
257             */
258            @AutoEscape
259            public String getDescription(String languageId);
260    
261            /**
262             * Returns the localized description of this polls choice 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 description of this polls choice
267             */
268            @AutoEscape
269            public String getDescription(String languageId, boolean useDefault);
270    
271            @AutoEscape
272            public String getDescriptionCurrentLanguageId();
273    
274            @AutoEscape
275            public String getDescriptionCurrentValue();
276    
277            /**
278             * Returns a map of the locales and localized descriptions of this polls choice.
279             *
280             * @return the locales and localized descriptions of this polls choice
281             */
282            public Map<Locale, String> getDescriptionMap();
283    
284            /**
285             * Sets the description of this polls choice.
286             *
287             * @param description the description of this polls choice
288             */
289            public void setDescription(String description);
290    
291            /**
292             * Sets the localized description of this polls choice in the language.
293             *
294             * @param description the localized description of this polls choice
295             * @param locale the locale of the language
296             */
297            public void setDescription(String description, Locale locale);
298    
299            /**
300             * Sets the localized description of this polls choice in the language, and sets the default locale.
301             *
302             * @param description the localized description of this polls choice
303             * @param locale the locale of the language
304             * @param defaultLocale the default locale
305             */
306            public void setDescription(String description, Locale locale,
307                    Locale defaultLocale);
308    
309            public void setDescriptionCurrentLanguageId(String languageId);
310    
311            /**
312             * Sets the localized descriptions of this polls choice from the map of locales and localized descriptions.
313             *
314             * @param descriptionMap the locales and localized descriptions of this polls choice
315             */
316            public void setDescriptionMap(Map<Locale, String> descriptionMap);
317    
318            /**
319             * Sets the localized descriptions of this polls choice from the map of locales and localized descriptions, and sets the default locale.
320             *
321             * @param descriptionMap the locales and localized descriptions of this polls choice
322             * @param defaultLocale the default locale
323             */
324            public void setDescriptionMap(Map<Locale, String> descriptionMap,
325                    Locale defaultLocale);
326    
327            public boolean isNew();
328    
329            public void setNew(boolean n);
330    
331            public boolean isCachedModel();
332    
333            public void setCachedModel(boolean cachedModel);
334    
335            public boolean isEscapedModel();
336    
337            public Serializable getPrimaryKeyObj();
338    
339            public void setPrimaryKeyObj(Serializable primaryKeyObj);
340    
341            public ExpandoBridge getExpandoBridge();
342    
343            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
344    
345            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
346    
347            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
348    
349            public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
350                    throws LocaleException;
351    
352            public Object clone();
353    
354            public int compareTo(PollsChoice pollsChoice);
355    
356            public int hashCode();
357    
358            public CacheModel<PollsChoice> toCacheModel();
359    
360            public PollsChoice toEscapedModel();
361    
362            public PollsChoice toUnescapedModel();
363    
364            public String toString();
365    
366            public String toXmlString();
367    }