001 /** 002 * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved. 003 * 004 * The contents of this file are subject to the terms of the Liferay Enterprise 005 * Subscription License ("License"). You may not use this file except in 006 * compliance with the License. You can obtain a copy of the License by 007 * contacting Liferay, Inc. See the License for the specific language governing 008 * permissions and limitations under the License, including but not limited to 009 * distribution rights of the Software. 010 * 011 * 012 * 013 */ 014 015 package com.liferay.portlet.polls.model; 016 017 import com.liferay.portal.kernel.annotation.AutoEscape; 018 import com.liferay.portal.model.BaseModel; 019 import com.liferay.portal.service.ServiceContext; 020 021 import com.liferay.portlet.expando.model.ExpandoBridge; 022 023 import java.io.Serializable; 024 025 import java.util.Locale; 026 import java.util.Map; 027 028 /** 029 * 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. 030 * 031 * <p> 032 * 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}. 033 * </p> 034 * 035 * <p> 036 * Never modify or reference this interface directly. All methods that expect a polls choice model instance should use the {@link PollsChoice} interface instead. 037 * </p> 038 * 039 * @author Brian Wing Shun Chan 040 * @see PollsChoice 041 * @see com.liferay.portlet.polls.model.impl.PollsChoiceImpl 042 * @see com.liferay.portlet.polls.model.impl.PollsChoiceModelImpl 043 * @generated 044 */ 045 public interface PollsChoiceModel extends BaseModel<PollsChoice> { 046 /** 047 * Gets the primary key of this polls choice. 048 * 049 * @return the primary key of this polls choice 050 */ 051 public long getPrimaryKey(); 052 053 /** 054 * Sets the primary key of this polls choice 055 * 056 * @param pk the primary key of this polls choice 057 */ 058 public void setPrimaryKey(long pk); 059 060 /** 061 * Gets the uuid of this polls choice. 062 * 063 * @return the uuid of this polls choice 064 */ 065 @AutoEscape 066 public String getUuid(); 067 068 /** 069 * Sets the uuid of this polls choice. 070 * 071 * @param uuid the uuid of this polls choice 072 */ 073 public void setUuid(String uuid); 074 075 /** 076 * Gets the choice id of this polls choice. 077 * 078 * @return the choice id of this polls choice 079 */ 080 public long getChoiceId(); 081 082 /** 083 * Sets the choice id of this polls choice. 084 * 085 * @param choiceId the choice id of this polls choice 086 */ 087 public void setChoiceId(long choiceId); 088 089 /** 090 * Gets the question id of this polls choice. 091 * 092 * @return the question id of this polls choice 093 */ 094 public long getQuestionId(); 095 096 /** 097 * Sets the question id of this polls choice. 098 * 099 * @param questionId the question id of this polls choice 100 */ 101 public void setQuestionId(long questionId); 102 103 /** 104 * Gets the name of this polls choice. 105 * 106 * @return the name of this polls choice 107 */ 108 @AutoEscape 109 public String getName(); 110 111 /** 112 * Sets the name of this polls choice. 113 * 114 * @param name the name of this polls choice 115 */ 116 public void setName(String name); 117 118 /** 119 * Gets the description of this polls choice. 120 * 121 * @return the description of this polls choice 122 */ 123 public String getDescription(); 124 125 /** 126 * Gets the localized description of this polls choice. Uses the default language if no localization exists for the requested language. 127 * 128 * @param locale the locale to get the localized description for 129 * @return the localized description of this polls choice 130 */ 131 public String getDescription(Locale locale); 132 133 /** 134 * Gets the localized description of this polls choice, optionally using the default language if no localization exists for the requested language. 135 * 136 * @param locale the local to get the localized description for 137 * @param useDefault whether to use the default language if no localization exists for the requested language 138 * @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. 139 */ 140 public String getDescription(Locale locale, boolean useDefault); 141 142 /** 143 * Gets the localized description of this polls choice. Uses the default language if no localization exists for the requested language. 144 * 145 * @param languageId the id of the language to get the localized description for 146 * @return the localized description of this polls choice 147 */ 148 public String getDescription(String languageId); 149 150 /** 151 * Gets the localized description of this polls choice, optionally using the default language if no localization exists for the requested language. 152 * 153 * @param languageId the id of the language to get the localized description for 154 * @param useDefault whether to use the default language if no localization exists for the requested language 155 * @return the localized description of this polls choice 156 */ 157 public String getDescription(String languageId, boolean useDefault); 158 159 /** 160 * Gets a map of the locales and localized description of this polls choice. 161 * 162 * @return the locales and localized description 163 */ 164 public Map<Locale, String> getDescriptionMap(); 165 166 /** 167 * Sets the description of this polls choice. 168 * 169 * @param description the description of this polls choice 170 */ 171 public void setDescription(String description); 172 173 /** 174 * Sets the localized description of this polls choice. 175 * 176 * @param locale the locale to set the localized description for 177 * @param description the localized description of this polls choice 178 */ 179 public void setDescription(Locale locale, String description); 180 181 /** 182 * Sets the localized descriptions of this polls choice from the map of locales and localized descriptions. 183 * 184 * @param descriptionMap the locales and localized descriptions of this polls choice 185 */ 186 public void setDescriptionMap(Map<Locale, String> descriptionMap); 187 188 public boolean isNew(); 189 190 public void setNew(boolean n); 191 192 public boolean isCachedModel(); 193 194 public void setCachedModel(boolean cachedModel); 195 196 public boolean isEscapedModel(); 197 198 public void setEscapedModel(boolean escapedModel); 199 200 public Serializable getPrimaryKeyObj(); 201 202 public ExpandoBridge getExpandoBridge(); 203 204 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 205 206 public Object clone(); 207 208 public int compareTo(PollsChoice pollsChoice); 209 210 public int hashCode(); 211 212 public PollsChoice toEscapedModel(); 213 214 public String toString(); 215 216 public String toXmlString(); 217 }