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, ShardedModel { 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 @Override 113 public long getCompanyId(); 114 115 /** 116 * Sets the company ID of this user notification event. 117 * 118 * @param companyId the company ID of this user notification event 119 */ 120 @Override 121 public void setCompanyId(long companyId); 122 123 /** 124 * Returns the user ID of this user notification event. 125 * 126 * @return the user ID of this user notification event 127 */ 128 public long getUserId(); 129 130 /** 131 * Sets the user ID of this user notification event. 132 * 133 * @param userId the user ID of this user notification event 134 */ 135 public void setUserId(long userId); 136 137 /** 138 * Returns the user uuid of this user notification event. 139 * 140 * @return the user uuid of this user notification event 141 */ 142 public String getUserUuid(); 143 144 /** 145 * Sets the user uuid of this user notification event. 146 * 147 * @param userUuid the user uuid of this user notification event 148 */ 149 public void setUserUuid(String userUuid); 150 151 /** 152 * Returns the type of this user notification event. 153 * 154 * @return the type of this user notification event 155 */ 156 @AutoEscape 157 public String getType(); 158 159 /** 160 * Sets the type of this user notification event. 161 * 162 * @param type the type of this user notification event 163 */ 164 public void setType(String type); 165 166 /** 167 * Returns the timestamp of this user notification event. 168 * 169 * @return the timestamp of this user notification event 170 */ 171 public long getTimestamp(); 172 173 /** 174 * Sets the timestamp of this user notification event. 175 * 176 * @param timestamp the timestamp of this user notification event 177 */ 178 public void setTimestamp(long timestamp); 179 180 /** 181 * Returns the delivery type of this user notification event. 182 * 183 * @return the delivery type of this user notification event 184 */ 185 public int getDeliveryType(); 186 187 /** 188 * Sets the delivery type of this user notification event. 189 * 190 * @param deliveryType the delivery type of this user notification event 191 */ 192 public void setDeliveryType(int deliveryType); 193 194 /** 195 * Returns the deliver by of this user notification event. 196 * 197 * @return the deliver by of this user notification event 198 */ 199 public long getDeliverBy(); 200 201 /** 202 * Sets the deliver by of this user notification event. 203 * 204 * @param deliverBy the deliver by of this user notification event 205 */ 206 public void setDeliverBy(long deliverBy); 207 208 /** 209 * Returns the delivered of this user notification event. 210 * 211 * @return the delivered of this user notification event 212 */ 213 public boolean getDelivered(); 214 215 /** 216 * Returns <code>true</code> if this user notification event is delivered. 217 * 218 * @return <code>true</code> if this user notification event is delivered; <code>false</code> otherwise 219 */ 220 public boolean isDelivered(); 221 222 /** 223 * Sets whether this user notification event is delivered. 224 * 225 * @param delivered the delivered of this user notification event 226 */ 227 public void setDelivered(boolean delivered); 228 229 /** 230 * Returns the payload of this user notification event. 231 * 232 * @return the payload of this user notification event 233 */ 234 @AutoEscape 235 public String getPayload(); 236 237 /** 238 * Sets the payload of this user notification event. 239 * 240 * @param payload the payload of this user notification event 241 */ 242 public void setPayload(String payload); 243 244 /** 245 * Returns the action required of this user notification event. 246 * 247 * @return the action required of this user notification event 248 */ 249 public boolean getActionRequired(); 250 251 /** 252 * Returns <code>true</code> if this user notification event is action required. 253 * 254 * @return <code>true</code> if this user notification event is action required; <code>false</code> otherwise 255 */ 256 public boolean isActionRequired(); 257 258 /** 259 * Sets whether this user notification event is action required. 260 * 261 * @param actionRequired the action required of this user notification event 262 */ 263 public void setActionRequired(boolean actionRequired); 264 265 /** 266 * Returns the archived of this user notification event. 267 * 268 * @return the archived of this user notification event 269 */ 270 public boolean getArchived(); 271 272 /** 273 * Returns <code>true</code> if this user notification event is archived. 274 * 275 * @return <code>true</code> if this user notification event is archived; <code>false</code> otherwise 276 */ 277 public boolean isArchived(); 278 279 /** 280 * Sets whether this user notification event is archived. 281 * 282 * @param archived the archived of this user notification event 283 */ 284 public void setArchived(boolean archived); 285 286 @Override 287 public boolean isNew(); 288 289 @Override 290 public void setNew(boolean n); 291 292 @Override 293 public boolean isCachedModel(); 294 295 @Override 296 public void setCachedModel(boolean cachedModel); 297 298 @Override 299 public boolean isEscapedModel(); 300 301 @Override 302 public Serializable getPrimaryKeyObj(); 303 304 @Override 305 public void setPrimaryKeyObj(Serializable primaryKeyObj); 306 307 @Override 308 public ExpandoBridge getExpandoBridge(); 309 310 @Override 311 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 312 313 @Override 314 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 315 316 @Override 317 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 318 319 @Override 320 public Object clone(); 321 322 @Override 323 public int compareTo( 324 com.liferay.portal.model.UserNotificationEvent userNotificationEvent); 325 326 @Override 327 public int hashCode(); 328 329 @Override 330 public CacheModel<com.liferay.portal.model.UserNotificationEvent> toCacheModel(); 331 332 @Override 333 public com.liferay.portal.model.UserNotificationEvent toEscapedModel(); 334 335 @Override 336 public com.liferay.portal.model.UserNotificationEvent toUnescapedModel(); 337 338 @Override 339 public String toString(); 340 341 @Override 342 public String toXmlString(); 343 }