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 aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.bean.AutoEscape;
020    import com.liferay.portal.model.AttachedModel;
021    import com.liferay.portal.model.BaseModel;
022    import com.liferay.portal.model.CacheModel;
023    import com.liferay.portal.service.ServiceContext;
024    
025    import com.liferay.portlet.expando.model.ExpandoBridge;
026    
027    import java.io.Serializable;
028    
029    /**
030     * The base model interface for the SocialActivityCounter service. Represents a row in the "SocialActivityCounter" database table, with each column mapped to a property of this class.
031     *
032     * <p>
033     * This interface and its corresponding implementation {@link com.liferay.portlet.social.model.impl.SocialActivityCounterModelImpl} 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.SocialActivityCounterImpl}.
034     * </p>
035     *
036     * @author Brian Wing Shun Chan
037     * @see SocialActivityCounter
038     * @see com.liferay.portlet.social.model.impl.SocialActivityCounterImpl
039     * @see com.liferay.portlet.social.model.impl.SocialActivityCounterModelImpl
040     * @generated
041     */
042    @ProviderType
043    public interface SocialActivityCounterModel extends AttachedModel,
044            BaseModel<SocialActivityCounter> {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. All methods that expect a social activity counter model instance should use the {@link SocialActivityCounter} interface instead.
049             */
050    
051            /**
052             * Returns the primary key of this social activity counter.
053             *
054             * @return the primary key of this social activity counter
055             */
056            public long getPrimaryKey();
057    
058            /**
059             * Sets the primary key of this social activity counter.
060             *
061             * @param primaryKey the primary key of this social activity counter
062             */
063            public void setPrimaryKey(long primaryKey);
064    
065            /**
066             * Returns the activity counter ID of this social activity counter.
067             *
068             * @return the activity counter ID of this social activity counter
069             */
070            public long getActivityCounterId();
071    
072            /**
073             * Sets the activity counter ID of this social activity counter.
074             *
075             * @param activityCounterId the activity counter ID of this social activity counter
076             */
077            public void setActivityCounterId(long activityCounterId);
078    
079            /**
080             * Returns the group ID of this social activity counter.
081             *
082             * @return the group ID of this social activity counter
083             */
084            public long getGroupId();
085    
086            /**
087             * Sets the group ID of this social activity counter.
088             *
089             * @param groupId the group ID of this social activity counter
090             */
091            public void setGroupId(long groupId);
092    
093            /**
094             * Returns the company ID of this social activity counter.
095             *
096             * @return the company ID of this social activity counter
097             */
098            public long getCompanyId();
099    
100            /**
101             * Sets the company ID of this social activity counter.
102             *
103             * @param companyId the company ID of this social activity counter
104             */
105            public void setCompanyId(long companyId);
106    
107            /**
108             * Returns the fully qualified class name of this social activity counter.
109             *
110             * @return the fully qualified class name of this social activity counter
111             */
112            @Override
113            public String getClassName();
114    
115            public void setClassName(String className);
116    
117            /**
118             * Returns the class name ID of this social activity counter.
119             *
120             * @return the class name ID of this social activity counter
121             */
122            @Override
123            public long getClassNameId();
124    
125            /**
126             * Sets the class name ID of this social activity counter.
127             *
128             * @param classNameId the class name ID of this social activity counter
129             */
130            @Override
131            public void setClassNameId(long classNameId);
132    
133            /**
134             * Returns the class p k of this social activity counter.
135             *
136             * @return the class p k of this social activity counter
137             */
138            @Override
139            public long getClassPK();
140    
141            /**
142             * Sets the class p k of this social activity counter.
143             *
144             * @param classPK the class p k of this social activity counter
145             */
146            @Override
147            public void setClassPK(long classPK);
148    
149            /**
150             * Returns the name of this social activity counter.
151             *
152             * @return the name of this social activity counter
153             */
154            @AutoEscape
155            public String getName();
156    
157            /**
158             * Sets the name of this social activity counter.
159             *
160             * @param name the name of this social activity counter
161             */
162            public void setName(String name);
163    
164            /**
165             * Returns the owner type of this social activity counter.
166             *
167             * @return the owner type of this social activity counter
168             */
169            public int getOwnerType();
170    
171            /**
172             * Sets the owner type of this social activity counter.
173             *
174             * @param ownerType the owner type of this social activity counter
175             */
176            public void setOwnerType(int ownerType);
177    
178            /**
179             * Returns the current value of this social activity counter.
180             *
181             * @return the current value of this social activity counter
182             */
183            public int getCurrentValue();
184    
185            /**
186             * Sets the current value of this social activity counter.
187             *
188             * @param currentValue the current value of this social activity counter
189             */
190            public void setCurrentValue(int currentValue);
191    
192            /**
193             * Returns the total value of this social activity counter.
194             *
195             * @return the total value of this social activity counter
196             */
197            public int getTotalValue();
198    
199            /**
200             * Sets the total value of this social activity counter.
201             *
202             * @param totalValue the total value of this social activity counter
203             */
204            public void setTotalValue(int totalValue);
205    
206            /**
207             * Returns the grace value of this social activity counter.
208             *
209             * @return the grace value of this social activity counter
210             */
211            public int getGraceValue();
212    
213            /**
214             * Sets the grace value of this social activity counter.
215             *
216             * @param graceValue the grace value of this social activity counter
217             */
218            public void setGraceValue(int graceValue);
219    
220            /**
221             * Returns the start period of this social activity counter.
222             *
223             * @return the start period of this social activity counter
224             */
225            public int getStartPeriod();
226    
227            /**
228             * Sets the start period of this social activity counter.
229             *
230             * @param startPeriod the start period of this social activity counter
231             */
232            public void setStartPeriod(int startPeriod);
233    
234            /**
235             * Returns the end period of this social activity counter.
236             *
237             * @return the end period of this social activity counter
238             */
239            public int getEndPeriod();
240    
241            /**
242             * Sets the end period of this social activity counter.
243             *
244             * @param endPeriod the end period of this social activity counter
245             */
246            public void setEndPeriod(int endPeriod);
247    
248            /**
249             * Returns the active of this social activity counter.
250             *
251             * @return the active of this social activity counter
252             */
253            public boolean getActive();
254    
255            /**
256             * Returns <code>true</code> if this social activity counter is active.
257             *
258             * @return <code>true</code> if this social activity counter is active; <code>false</code> otherwise
259             */
260            public boolean isActive();
261    
262            /**
263             * Sets whether this social activity counter is active.
264             *
265             * @param active the active of this social activity counter
266             */
267            public void setActive(boolean active);
268    
269            @Override
270            public boolean isNew();
271    
272            @Override
273            public void setNew(boolean n);
274    
275            @Override
276            public boolean isCachedModel();
277    
278            @Override
279            public void setCachedModel(boolean cachedModel);
280    
281            @Override
282            public boolean isEscapedModel();
283    
284            @Override
285            public Serializable getPrimaryKeyObj();
286    
287            @Override
288            public void setPrimaryKeyObj(Serializable primaryKeyObj);
289    
290            @Override
291            public ExpandoBridge getExpandoBridge();
292    
293            @Override
294            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
295    
296            @Override
297            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
298    
299            @Override
300            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
301    
302            @Override
303            public Object clone();
304    
305            @Override
306            public int compareTo(SocialActivityCounter socialActivityCounter);
307    
308            @Override
309            public int hashCode();
310    
311            @Override
312            public CacheModel<SocialActivityCounter> toCacheModel();
313    
314            @Override
315            public SocialActivityCounter toEscapedModel();
316    
317            @Override
318            public SocialActivityCounter toUnescapedModel();
319    
320            @Override
321            public String toString();
322    
323            @Override
324            public String toXmlString();
325    }