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.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.BaseModel;
020    import com.liferay.portal.model.CacheModel;
021    import com.liferay.portal.service.ServiceContext;
022    
023    import com.liferay.portlet.expando.model.ExpandoBridge;
024    
025    import java.io.Serializable;
026    
027    /**
028     * The base model interface for the SocialActivityAchievement service. Represents a row in the "SocialActivityAchievement" 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.portlet.social.model.impl.SocialActivityAchievementModelImpl} 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.SocialActivityAchievementImpl}.
032     * </p>
033     *
034     * @author Brian Wing Shun Chan
035     * @see SocialActivityAchievement
036     * @see com.liferay.portlet.social.model.impl.SocialActivityAchievementImpl
037     * @see com.liferay.portlet.social.model.impl.SocialActivityAchievementModelImpl
038     * @generated
039     */
040    public interface SocialActivityAchievementModel extends BaseModel<SocialActivityAchievement> {
041            /*
042             * NOTE FOR DEVELOPERS:
043             *
044             * Never modify or reference this interface directly. All methods that expect a social activity achievement model instance should use the {@link SocialActivityAchievement} interface instead.
045             */
046    
047            /**
048             * Returns the primary key of this social activity achievement.
049             *
050             * @return the primary key of this social activity achievement
051             */
052            public long getPrimaryKey();
053    
054            /**
055             * Sets the primary key of this social activity achievement.
056             *
057             * @param primaryKey the primary key of this social activity achievement
058             */
059            public void setPrimaryKey(long primaryKey);
060    
061            /**
062             * Returns the activity achievement ID of this social activity achievement.
063             *
064             * @return the activity achievement ID of this social activity achievement
065             */
066            public long getActivityAchievementId();
067    
068            /**
069             * Sets the activity achievement ID of this social activity achievement.
070             *
071             * @param activityAchievementId the activity achievement ID of this social activity achievement
072             */
073            public void setActivityAchievementId(long activityAchievementId);
074    
075            /**
076             * Returns the group ID of this social activity achievement.
077             *
078             * @return the group ID of this social activity achievement
079             */
080            public long getGroupId();
081    
082            /**
083             * Sets the group ID of this social activity achievement.
084             *
085             * @param groupId the group ID of this social activity achievement
086             */
087            public void setGroupId(long groupId);
088    
089            /**
090             * Returns the company ID of this social activity achievement.
091             *
092             * @return the company ID of this social activity achievement
093             */
094            public long getCompanyId();
095    
096            /**
097             * Sets the company ID of this social activity achievement.
098             *
099             * @param companyId the company ID of this social activity achievement
100             */
101            public void setCompanyId(long companyId);
102    
103            /**
104             * Returns the user ID of this social activity achievement.
105             *
106             * @return the user ID of this social activity achievement
107             */
108            public long getUserId();
109    
110            /**
111             * Sets the user ID of this social activity achievement.
112             *
113             * @param userId the user ID of this social activity achievement
114             */
115            public void setUserId(long userId);
116    
117            /**
118             * Returns the user uuid of this social activity achievement.
119             *
120             * @return the user uuid of this social activity achievement
121             * @throws SystemException if a system exception occurred
122             */
123            public String getUserUuid() throws SystemException;
124    
125            /**
126             * Sets the user uuid of this social activity achievement.
127             *
128             * @param userUuid the user uuid of this social activity achievement
129             */
130            public void setUserUuid(String userUuid);
131    
132            /**
133             * Returns the create date of this social activity achievement.
134             *
135             * @return the create date of this social activity achievement
136             */
137            public long getCreateDate();
138    
139            /**
140             * Sets the create date of this social activity achievement.
141             *
142             * @param createDate the create date of this social activity achievement
143             */
144            public void setCreateDate(long createDate);
145    
146            /**
147             * Returns the name of this social activity achievement.
148             *
149             * @return the name of this social activity achievement
150             */
151            @AutoEscape
152            public String getName();
153    
154            /**
155             * Sets the name of this social activity achievement.
156             *
157             * @param name the name of this social activity achievement
158             */
159            public void setName(String name);
160    
161            /**
162             * Returns the first in group of this social activity achievement.
163             *
164             * @return the first in group of this social activity achievement
165             */
166            public boolean getFirstInGroup();
167    
168            /**
169             * Returns <code>true</code> if this social activity achievement is first in group.
170             *
171             * @return <code>true</code> if this social activity achievement is first in group; <code>false</code> otherwise
172             */
173            public boolean isFirstInGroup();
174    
175            /**
176             * Sets whether this social activity achievement is first in group.
177             *
178             * @param firstInGroup the first in group of this social activity achievement
179             */
180            public void setFirstInGroup(boolean firstInGroup);
181    
182            public boolean isNew();
183    
184            public void setNew(boolean n);
185    
186            public boolean isCachedModel();
187    
188            public void setCachedModel(boolean cachedModel);
189    
190            public boolean isEscapedModel();
191    
192            public Serializable getPrimaryKeyObj();
193    
194            public void setPrimaryKeyObj(Serializable primaryKeyObj);
195    
196            public ExpandoBridge getExpandoBridge();
197    
198            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
199    
200            public Object clone();
201    
202            public int compareTo(SocialActivityAchievement socialActivityAchievement);
203    
204            public int hashCode();
205    
206            public CacheModel<SocialActivityAchievement> toCacheModel();
207    
208            public SocialActivityAchievement toEscapedModel();
209    
210            public SocialActivityAchievement toUnescapedModel();
211    
212            public String toString();
213    
214            public String toXmlString();
215    }