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