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    /**
028     * 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.
029     *
030     * <p>
031     * 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}.
032     * </p>
033     *
034     * @author Brian Wing Shun Chan
035     * @see UserNotificationEvent
036     * @see com.liferay.portal.model.impl.UserNotificationEventImpl
037     * @see com.liferay.portal.model.impl.UserNotificationEventModelImpl
038     * @generated
039     */
040    @ProviderType
041    public interface UserNotificationEventModel extends BaseModel<UserNotificationEvent> {
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 uuid of this user notification event.
064             *
065             * @return the uuid of this user notification event
066             */
067            @AutoEscape
068            public String getUuid();
069    
070            /**
071             * Sets the uuid of this user notification event.
072             *
073             * @param uuid the uuid of this user notification event
074             */
075            public void setUuid(String uuid);
076    
077            /**
078             * Returns the user notification event ID of this user notification event.
079             *
080             * @return the user notification event ID of this user notification event
081             */
082            public long getUserNotificationEventId();
083    
084            /**
085             * Sets the user notification event ID of this user notification event.
086             *
087             * @param userNotificationEventId the user notification event ID of this user notification event
088             */
089            public void setUserNotificationEventId(long userNotificationEventId);
090    
091            /**
092             * Returns the company ID of this user notification event.
093             *
094             * @return the company ID of this user notification event
095             */
096            public long getCompanyId();
097    
098            /**
099             * Sets the company ID of this user notification event.
100             *
101             * @param companyId the company ID of this user notification event
102             */
103            public void setCompanyId(long companyId);
104    
105            /**
106             * Returns the user ID of this user notification event.
107             *
108             * @return the user ID of this user notification event
109             */
110            public long getUserId();
111    
112            /**
113             * Sets the user ID of this user notification event.
114             *
115             * @param userId the user ID of this user notification event
116             */
117            public void setUserId(long userId);
118    
119            /**
120             * Returns the user uuid of this user notification event.
121             *
122             * @return the user uuid of this user notification event
123             * @throws SystemException if a system exception occurred
124             */
125            public String getUserUuid() throws SystemException;
126    
127            /**
128             * Sets the user uuid of this user notification event.
129             *
130             * @param userUuid the user uuid of this user notification event
131             */
132            public void setUserUuid(String userUuid);
133    
134            /**
135             * Returns the type of this user notification event.
136             *
137             * @return the type of this user notification event
138             */
139            @AutoEscape
140            public String getType();
141    
142            /**
143             * Sets the type of this user notification event.
144             *
145             * @param type the type of this user notification event
146             */
147            public void setType(String type);
148    
149            /**
150             * Returns the timestamp of this user notification event.
151             *
152             * @return the timestamp of this user notification event
153             */
154            public long getTimestamp();
155    
156            /**
157             * Sets the timestamp of this user notification event.
158             *
159             * @param timestamp the timestamp of this user notification event
160             */
161            public void setTimestamp(long timestamp);
162    
163            /**
164             * Returns the deliver by of this user notification event.
165             *
166             * @return the deliver by of this user notification event
167             */
168            public long getDeliverBy();
169    
170            /**
171             * Sets the deliver by of this user notification event.
172             *
173             * @param deliverBy the deliver by of this user notification event
174             */
175            public void setDeliverBy(long deliverBy);
176    
177            /**
178             * Returns the delivered of this user notification event.
179             *
180             * @return the delivered of this user notification event
181             */
182            public boolean getDelivered();
183    
184            /**
185             * Returns <code>true</code> if this user notification event is delivered.
186             *
187             * @return <code>true</code> if this user notification event is delivered; <code>false</code> otherwise
188             */
189            public boolean isDelivered();
190    
191            /**
192             * Sets whether this user notification event is delivered.
193             *
194             * @param delivered the delivered of this user notification event
195             */
196            public void setDelivered(boolean delivered);
197    
198            /**
199             * Returns the payload of this user notification event.
200             *
201             * @return the payload of this user notification event
202             */
203            @AutoEscape
204            public String getPayload();
205    
206            /**
207             * Sets the payload of this user notification event.
208             *
209             * @param payload the payload of this user notification event
210             */
211            public void setPayload(String payload);
212    
213            /**
214             * Returns the archived of this user notification event.
215             *
216             * @return the archived of this user notification event
217             */
218            public boolean getArchived();
219    
220            /**
221             * Returns <code>true</code> if this user notification event is archived.
222             *
223             * @return <code>true</code> if this user notification event is archived; <code>false</code> otherwise
224             */
225            public boolean isArchived();
226    
227            /**
228             * Sets whether this user notification event is archived.
229             *
230             * @param archived the archived of this user notification event
231             */
232            public void setArchived(boolean archived);
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(UserNotificationEvent userNotificationEvent);
272    
273            @Override
274            public int hashCode();
275    
276            @Override
277            public CacheModel<UserNotificationEvent> toCacheModel();
278    
279            @Override
280            public UserNotificationEvent toEscapedModel();
281    
282            @Override
283            public UserNotificationEvent toUnescapedModel();
284    
285            @Override
286            public String toString();
287    
288            @Override
289            public String toXmlString();
290    }