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