001    /**
002     * Copyright (c) 2000-present 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.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 UserNotificationEvent service. Represents a row in the "UserNotificationEvent" 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.portal.model.impl.UserNotificationEventModelImpl} 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.UserNotificationEventImpl}.
031     * </p>
032     *
033     * @author Brian Wing Shun Chan
034     * @see UserNotificationEvent
035     * @see com.liferay.portal.model.impl.UserNotificationEventImpl
036     * @see com.liferay.portal.model.impl.UserNotificationEventModelImpl
037     * @generated
038     */
039    @ProviderType
040    public interface UserNotificationEventModel extends BaseModel<UserNotificationEvent>,
041            MVCCModel {
042            /*
043             * NOTE FOR DEVELOPERS:
044             *
045             * Never modify or reference this interface directly. All methods that expect a user notification event model instance should use the {@link UserNotificationEvent} interface instead.
046             */
047    
048            /**
049             * Returns the primary key of this user notification event.
050             *
051             * @return the primary key of this user notification event
052             */
053            public long getPrimaryKey();
054    
055            /**
056             * Sets the primary key of this user notification event.
057             *
058             * @param primaryKey the primary key of this user notification event
059             */
060            public void setPrimaryKey(long primaryKey);
061    
062            /**
063             * Returns the mvcc version of this user notification event.
064             *
065             * @return the mvcc version of this user notification event
066             */
067            @Override
068            public long getMvccVersion();
069    
070            /**
071             * Sets the mvcc version of this user notification event.
072             *
073             * @param mvccVersion the mvcc version of this user notification event
074             */
075            @Override
076            public void setMvccVersion(long mvccVersion);
077    
078            /**
079             * Returns the uuid of this user notification event.
080             *
081             * @return the uuid of this user notification event
082             */
083            @AutoEscape
084            public String getUuid();
085    
086            /**
087             * Sets the uuid of this user notification event.
088             *
089             * @param uuid the uuid of this user notification event
090             */
091            public void setUuid(String uuid);
092    
093            /**
094             * Returns the user notification event ID of this user notification event.
095             *
096             * @return the user notification event ID of this user notification event
097             */
098            public long getUserNotificationEventId();
099    
100            /**
101             * Sets the user notification event ID of this user notification event.
102             *
103             * @param userNotificationEventId the user notification event ID of this user notification event
104             */
105            public void setUserNotificationEventId(long userNotificationEventId);
106    
107            /**
108             * Returns the company ID of this user notification event.
109             *
110             * @return the company ID of this user notification event
111             */
112            public long getCompanyId();
113    
114            /**
115             * Sets the company ID of this user notification event.
116             *
117             * @param companyId the company ID of this user notification event
118             */
119            public void setCompanyId(long companyId);
120    
121            /**
122             * Returns the user ID of this user notification event.
123             *
124             * @return the user ID of this user notification event
125             */
126            public long getUserId();
127    
128            /**
129             * Sets the user ID of this user notification event.
130             *
131             * @param userId the user ID of this user notification event
132             */
133            public void setUserId(long userId);
134    
135            /**
136             * Returns the user uuid of this user notification event.
137             *
138             * @return the user uuid of this user notification event
139             */
140            public String getUserUuid();
141    
142            /**
143             * Sets the user uuid of this user notification event.
144             *
145             * @param userUuid the user uuid of this user notification event
146             */
147            public void setUserUuid(String userUuid);
148    
149            /**
150             * Returns the type of this user notification event.
151             *
152             * @return the type of this user notification event
153             */
154            @AutoEscape
155            public String getType();
156    
157            /**
158             * Sets the type of this user notification event.
159             *
160             * @param type the type of this user notification event
161             */
162            public void setType(String type);
163    
164            /**
165             * Returns the timestamp of this user notification event.
166             *
167             * @return the timestamp of this user notification event
168             */
169            public long getTimestamp();
170    
171            /**
172             * Sets the timestamp of this user notification event.
173             *
174             * @param timestamp the timestamp of this user notification event
175             */
176            public void setTimestamp(long timestamp);
177    
178            /**
179             * Returns the delivery type of this user notification event.
180             *
181             * @return the delivery type of this user notification event
182             */
183            public int getDeliveryType();
184    
185            /**
186             * Sets the delivery type of this user notification event.
187             *
188             * @param deliveryType the delivery type of this user notification event
189             */
190            public void setDeliveryType(int deliveryType);
191    
192            /**
193             * Returns the deliver by of this user notification event.
194             *
195             * @return the deliver by of this user notification event
196             */
197            public long getDeliverBy();
198    
199            /**
200             * Sets the deliver by of this user notification event.
201             *
202             * @param deliverBy the deliver by of this user notification event
203             */
204            public void setDeliverBy(long deliverBy);
205    
206            /**
207             * Returns the delivered of this user notification event.
208             *
209             * @return the delivered of this user notification event
210             */
211            public boolean getDelivered();
212    
213            /**
214             * Returns <code>true</code> if this user notification event is delivered.
215             *
216             * @return <code>true</code> if this user notification event is delivered; <code>false</code> otherwise
217             */
218            public boolean isDelivered();
219    
220            /**
221             * Sets whether this user notification event is delivered.
222             *
223             * @param delivered the delivered of this user notification event
224             */
225            public void setDelivered(boolean delivered);
226    
227            /**
228             * Returns the payload of this user notification event.
229             *
230             * @return the payload of this user notification event
231             */
232            @AutoEscape
233            public String getPayload();
234    
235            /**
236             * Sets the payload of this user notification event.
237             *
238             * @param payload the payload of this user notification event
239             */
240            public void setPayload(String payload);
241    
242            /**
243             * Returns the action required of this user notification event.
244             *
245             * @return the action required of this user notification event
246             */
247            public boolean getActionRequired();
248    
249            /**
250             * Returns <code>true</code> if this user notification event is action required.
251             *
252             * @return <code>true</code> if this user notification event is action required; <code>false</code> otherwise
253             */
254            public boolean isActionRequired();
255    
256            /**
257             * Sets whether this user notification event is action required.
258             *
259             * @param actionRequired the action required of this user notification event
260             */
261            public void setActionRequired(boolean actionRequired);
262    
263            /**
264             * Returns the archived of this user notification event.
265             *
266             * @return the archived of this user notification event
267             */
268            public boolean getArchived();
269    
270            /**
271             * Returns <code>true</code> if this user notification event is archived.
272             *
273             * @return <code>true</code> if this user notification event is archived; <code>false</code> otherwise
274             */
275            public boolean isArchived();
276    
277            /**
278             * Sets whether this user notification event is archived.
279             *
280             * @param archived the archived of this user notification event
281             */
282            public void setArchived(boolean archived);
283    
284            @Override
285            public boolean isNew();
286    
287            @Override
288            public void setNew(boolean n);
289    
290            @Override
291            public boolean isCachedModel();
292    
293            @Override
294            public void setCachedModel(boolean cachedModel);
295    
296            @Override
297            public boolean isEscapedModel();
298    
299            @Override
300            public Serializable getPrimaryKeyObj();
301    
302            @Override
303            public void setPrimaryKeyObj(Serializable primaryKeyObj);
304    
305            @Override
306            public ExpandoBridge getExpandoBridge();
307    
308            @Override
309            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
310    
311            @Override
312            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
313    
314            @Override
315            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
316    
317            @Override
318            public Object clone();
319    
320            @Override
321            public int compareTo(
322                    com.liferay.portal.model.UserNotificationEvent userNotificationEvent);
323    
324            @Override
325            public int hashCode();
326    
327            @Override
328            public CacheModel<com.liferay.portal.model.UserNotificationEvent> toCacheModel();
329    
330            @Override
331            public com.liferay.portal.model.UserNotificationEvent toEscapedModel();
332    
333            @Override
334            public com.liferay.portal.model.UserNotificationEvent toUnescapedModel();
335    
336            @Override
337            public String toString();
338    
339            @Override
340            public String toXmlString();
341    }