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 com.liferay.portal.kernel.bean.AutoEscape; 018 import com.liferay.portal.kernel.exception.SystemException; 019 import com.liferay.portal.service.ServiceContext; 020 021 import com.liferay.portlet.expando.model.ExpandoBridge; 022 023 import java.io.Serializable; 024 025 /** 026 * 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. 027 * 028 * <p> 029 * 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}. 030 * </p> 031 * 032 * @author Brian Wing Shun Chan 033 * @see UserNotificationEvent 034 * @see com.liferay.portal.model.impl.UserNotificationEventImpl 035 * @see com.liferay.portal.model.impl.UserNotificationEventModelImpl 036 * @generated 037 */ 038 public interface UserNotificationEventModel extends BaseModel<UserNotificationEvent> { 039 /* 040 * NOTE FOR DEVELOPERS: 041 * 042 * Never modify or reference this interface directly. All methods that expect a user notification event model instance should use the {@link UserNotificationEvent} interface instead. 043 */ 044 045 /** 046 * Returns the primary key of this user notification event. 047 * 048 * @return the primary key of this user notification event 049 */ 050 public long getPrimaryKey(); 051 052 /** 053 * Sets the primary key of this user notification event. 054 * 055 * @param primaryKey the primary key of this user notification event 056 */ 057 public void setPrimaryKey(long primaryKey); 058 059 /** 060 * Returns the uuid of this user notification event. 061 * 062 * @return the uuid of this user notification event 063 */ 064 @AutoEscape 065 public String getUuid(); 066 067 /** 068 * Sets the uuid of this user notification event. 069 * 070 * @param uuid the uuid of this user notification event 071 */ 072 public void setUuid(String uuid); 073 074 /** 075 * Returns the user notification event ID of this user notification event. 076 * 077 * @return the user notification event ID of this user notification event 078 */ 079 public long getUserNotificationEventId(); 080 081 /** 082 * Sets the user notification event ID of this user notification event. 083 * 084 * @param userNotificationEventId the user notification event ID of this user notification event 085 */ 086 public void setUserNotificationEventId(long userNotificationEventId); 087 088 /** 089 * Returns the company ID of this user notification event. 090 * 091 * @return the company ID of this user notification event 092 */ 093 public long getCompanyId(); 094 095 /** 096 * Sets the company ID of this user notification event. 097 * 098 * @param companyId the company ID of this user notification event 099 */ 100 public void setCompanyId(long companyId); 101 102 /** 103 * Returns the user ID of this user notification event. 104 * 105 * @return the user ID of this user notification event 106 */ 107 public long getUserId(); 108 109 /** 110 * Sets the user ID of this user notification event. 111 * 112 * @param userId the user ID of this user notification event 113 */ 114 public void setUserId(long userId); 115 116 /** 117 * Returns the user uuid of this user notification event. 118 * 119 * @return the user uuid of this user notification event 120 * @throws SystemException if a system exception occurred 121 */ 122 public String getUserUuid() throws SystemException; 123 124 /** 125 * Sets the user uuid of this user notification event. 126 * 127 * @param userUuid the user uuid of this user notification event 128 */ 129 public void setUserUuid(String userUuid); 130 131 /** 132 * Returns the type of this user notification event. 133 * 134 * @return the type of this user notification event 135 */ 136 @AutoEscape 137 public String getType(); 138 139 /** 140 * Sets the type of this user notification event. 141 * 142 * @param type the type of this user notification event 143 */ 144 public void setType(String type); 145 146 /** 147 * Returns the timestamp of this user notification event. 148 * 149 * @return the timestamp of this user notification event 150 */ 151 public long getTimestamp(); 152 153 /** 154 * Sets the timestamp of this user notification event. 155 * 156 * @param timestamp the timestamp of this user notification event 157 */ 158 public void setTimestamp(long timestamp); 159 160 /** 161 * Returns the deliver by of this user notification event. 162 * 163 * @return the deliver by of this user notification event 164 */ 165 public long getDeliverBy(); 166 167 /** 168 * Sets the deliver by of this user notification event. 169 * 170 * @param deliverBy the deliver by of this user notification event 171 */ 172 public void setDeliverBy(long deliverBy); 173 174 /** 175 * Returns the delivered of this user notification event. 176 * 177 * @return the delivered of this user notification event 178 */ 179 public boolean getDelivered(); 180 181 /** 182 * Returns <code>true</code> if this user notification event is delivered. 183 * 184 * @return <code>true</code> if this user notification event is delivered; <code>false</code> otherwise 185 */ 186 public boolean isDelivered(); 187 188 /** 189 * Sets whether this user notification event is delivered. 190 * 191 * @param delivered the delivered of this user notification event 192 */ 193 public void setDelivered(boolean delivered); 194 195 /** 196 * Returns the payload of this user notification event. 197 * 198 * @return the payload of this user notification event 199 */ 200 @AutoEscape 201 public String getPayload(); 202 203 /** 204 * Sets the payload of this user notification event. 205 * 206 * @param payload the payload of this user notification event 207 */ 208 public void setPayload(String payload); 209 210 /** 211 * Returns the archived of this user notification event. 212 * 213 * @return the archived of this user notification event 214 */ 215 public boolean getArchived(); 216 217 /** 218 * Returns <code>true</code> if this user notification event is archived. 219 * 220 * @return <code>true</code> if this user notification event is archived; <code>false</code> otherwise 221 */ 222 public boolean isArchived(); 223 224 /** 225 * Sets whether this user notification event is archived. 226 * 227 * @param archived the archived of this user notification event 228 */ 229 public void setArchived(boolean archived); 230 231 @Override 232 public boolean isNew(); 233 234 @Override 235 public void setNew(boolean n); 236 237 @Override 238 public boolean isCachedModel(); 239 240 @Override 241 public void setCachedModel(boolean cachedModel); 242 243 @Override 244 public boolean isEscapedModel(); 245 246 @Override 247 public Serializable getPrimaryKeyObj(); 248 249 @Override 250 public void setPrimaryKeyObj(Serializable primaryKeyObj); 251 252 @Override 253 public ExpandoBridge getExpandoBridge(); 254 255 @Override 256 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 257 258 @Override 259 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 260 261 @Override 262 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 263 264 @Override 265 public Object clone(); 266 267 @Override 268 public int compareTo(UserNotificationEvent userNotificationEvent); 269 270 @Override 271 public int hashCode(); 272 273 @Override 274 public CacheModel<UserNotificationEvent> toCacheModel(); 275 276 @Override 277 public UserNotificationEvent toEscapedModel(); 278 279 @Override 280 public UserNotificationEvent toUnescapedModel(); 281 282 @Override 283 public String toString(); 284 285 @Override 286 public String toXmlString(); 287 }