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