001    /**
002     * Copyright (c) 2000-2010 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.portal.model;
016    
017    import com.liferay.portal.kernel.annotation.AutoEscape;
018    import com.liferay.portal.kernel.exception.SystemException;
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.Date;
026    
027    /**
028     * The base model interface for the Phone service. Represents a row in the "Phone" database table, with each column mapped to a property of this class.
029     *
030     * <p>
031     * This interface and its corresponding implementation {@link com.liferay.portal.model.impl.PhoneModelImpl} 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.portal.model.impl.PhoneImpl}.
032     * </p>
033     *
034     * <p>
035     * Never modify or reference this interface directly. All methods that expect a phone model instance should use the {@link Phone} interface instead.
036     * </p>
037     *
038     * @author Brian Wing Shun Chan
039     * @see Phone
040     * @see com.liferay.portal.model.impl.PhoneImpl
041     * @see com.liferay.portal.model.impl.PhoneModelImpl
042     * @generated
043     */
044    public interface PhoneModel extends BaseModel<Phone> {
045            /**
046             * Gets the primary key of this phone.
047             *
048             * @return the primary key of this phone
049             */
050            public long getPrimaryKey();
051    
052            /**
053             * Sets the primary key of this phone
054             *
055             * @param pk the primary key of this phone
056             */
057            public void setPrimaryKey(long pk);
058    
059            /**
060             * Gets the phone id of this phone.
061             *
062             * @return the phone id of this phone
063             */
064            public long getPhoneId();
065    
066            /**
067             * Sets the phone id of this phone.
068             *
069             * @param phoneId the phone id of this phone
070             */
071            public void setPhoneId(long phoneId);
072    
073            /**
074             * Gets the company id of this phone.
075             *
076             * @return the company id of this phone
077             */
078            public long getCompanyId();
079    
080            /**
081             * Sets the company id of this phone.
082             *
083             * @param companyId the company id of this phone
084             */
085            public void setCompanyId(long companyId);
086    
087            /**
088             * Gets the user id of this phone.
089             *
090             * @return the user id of this phone
091             */
092            public long getUserId();
093    
094            /**
095             * Sets the user id of this phone.
096             *
097             * @param userId the user id of this phone
098             */
099            public void setUserId(long userId);
100    
101            /**
102             * Gets the user uuid of this phone.
103             *
104             * @return the user uuid of this phone
105             * @throws SystemException if a system exception occurred
106             */
107            public String getUserUuid() throws SystemException;
108    
109            /**
110             * Sets the user uuid of this phone.
111             *
112             * @param userUuid the user uuid of this phone
113             */
114            public void setUserUuid(String userUuid);
115    
116            /**
117             * Gets the user name of this phone.
118             *
119             * @return the user name of this phone
120             */
121            @AutoEscape
122            public String getUserName();
123    
124            /**
125             * Sets the user name of this phone.
126             *
127             * @param userName the user name of this phone
128             */
129            public void setUserName(String userName);
130    
131            /**
132             * Gets the create date of this phone.
133             *
134             * @return the create date of this phone
135             */
136            public Date getCreateDate();
137    
138            /**
139             * Sets the create date of this phone.
140             *
141             * @param createDate the create date of this phone
142             */
143            public void setCreateDate(Date createDate);
144    
145            /**
146             * Gets the modified date of this phone.
147             *
148             * @return the modified date of this phone
149             */
150            public Date getModifiedDate();
151    
152            /**
153             * Sets the modified date of this phone.
154             *
155             * @param modifiedDate the modified date of this phone
156             */
157            public void setModifiedDate(Date modifiedDate);
158    
159            /**
160             * Gets the class name of the model instance this phone is polymorphically associated with.
161             *
162             * @return the class name of the model instance this phone is polymorphically associated with
163             */
164            public String getClassName();
165    
166            /**
167             * Gets the class name id of this phone.
168             *
169             * @return the class name id of this phone
170             */
171            public long getClassNameId();
172    
173            /**
174             * Sets the class name id of this phone.
175             *
176             * @param classNameId the class name id of this phone
177             */
178            public void setClassNameId(long classNameId);
179    
180            /**
181             * Gets the class p k of this phone.
182             *
183             * @return the class p k of this phone
184             */
185            public long getClassPK();
186    
187            /**
188             * Sets the class p k of this phone.
189             *
190             * @param classPK the class p k of this phone
191             */
192            public void setClassPK(long classPK);
193    
194            /**
195             * Gets the number of this phone.
196             *
197             * @return the number of this phone
198             */
199            @AutoEscape
200            public String getNumber();
201    
202            /**
203             * Sets the number of this phone.
204             *
205             * @param number the number of this phone
206             */
207            public void setNumber(String number);
208    
209            /**
210             * Gets the extension of this phone.
211             *
212             * @return the extension of this phone
213             */
214            @AutoEscape
215            public String getExtension();
216    
217            /**
218             * Sets the extension of this phone.
219             *
220             * @param extension the extension of this phone
221             */
222            public void setExtension(String extension);
223    
224            /**
225             * Gets the type id of this phone.
226             *
227             * @return the type id of this phone
228             */
229            public int getTypeId();
230    
231            /**
232             * Sets the type id of this phone.
233             *
234             * @param typeId the type id of this phone
235             */
236            public void setTypeId(int typeId);
237    
238            /**
239             * Gets the primary of this phone.
240             *
241             * @return the primary of this phone
242             */
243            public boolean getPrimary();
244    
245            /**
246             * Determines whether this phone is primary.
247             *
248             * @return whether this phone is primary
249             */
250            public boolean isPrimary();
251    
252            /**
253             * Sets whether this {$entity.humanName} is primary.
254             *
255             * @param primary the primary of this phone
256             */
257            public void setPrimary(boolean primary);
258    
259            /**
260             * Gets a copy of this phone as an escaped model instance by wrapping it with an {@link com.liferay.portal.kernel.bean.AutoEscapeBeanHandler}.
261             *
262             * @return the escaped model instance
263             * @see com.liferay.portal.kernel.bean.AutoEscapeBeanHandler
264             */
265            public Phone toEscapedModel();
266    
267            public boolean isNew();
268    
269            public void setNew(boolean n);
270    
271            public boolean isCachedModel();
272    
273            public void setCachedModel(boolean cachedModel);
274    
275            public boolean isEscapedModel();
276    
277            public void setEscapedModel(boolean escapedModel);
278    
279            public Serializable getPrimaryKeyObj();
280    
281            public ExpandoBridge getExpandoBridge();
282    
283            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
284    
285            public Object clone();
286    
287            public int compareTo(Phone phone);
288    
289            public int hashCode();
290    
291            public String toString();
292    
293            public String toXmlString();
294    }