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 import java.util.Date; 026 027 /** 028 * 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. 029 * 030 * <p> 031 * 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}. 032 * </p> 033 * 034 * @author Brian Wing Shun Chan 035 * @see Subscription 036 * @see com.liferay.portal.model.impl.SubscriptionImpl 037 * @see com.liferay.portal.model.impl.SubscriptionModelImpl 038 * @generated 039 */ 040 public interface SubscriptionModel extends AttachedModel, AuditedModel, 041 BaseModel<Subscription> { 042 /* 043 * NOTE FOR DEVELOPERS: 044 * 045 * Never modify or reference this interface directly. All methods that expect a subscription model instance should use the {@link Subscription} interface instead. 046 */ 047 048 /** 049 * Returns the primary key of this subscription. 050 * 051 * @return the primary key of this subscription 052 */ 053 public long getPrimaryKey(); 054 055 /** 056 * Sets the primary key of this subscription. 057 * 058 * @param primaryKey the primary key of this subscription 059 */ 060 public void setPrimaryKey(long primaryKey); 061 062 /** 063 * Returns the subscription ID of this subscription. 064 * 065 * @return the subscription ID of this subscription 066 */ 067 public long getSubscriptionId(); 068 069 /** 070 * Sets the subscription ID of this subscription. 071 * 072 * @param subscriptionId the subscription ID of this subscription 073 */ 074 public void setSubscriptionId(long subscriptionId); 075 076 /** 077 * Returns the company ID of this subscription. 078 * 079 * @return the company ID of this subscription 080 */ 081 @Override 082 public long getCompanyId(); 083 084 /** 085 * Sets the company ID of this subscription. 086 * 087 * @param companyId the company ID of this subscription 088 */ 089 @Override 090 public void setCompanyId(long companyId); 091 092 /** 093 * Returns the user ID of this subscription. 094 * 095 * @return the user ID of this subscription 096 */ 097 @Override 098 public long getUserId(); 099 100 /** 101 * Sets the user ID of this subscription. 102 * 103 * @param userId the user ID of this subscription 104 */ 105 @Override 106 public void setUserId(long userId); 107 108 /** 109 * Returns the user uuid of this subscription. 110 * 111 * @return the user uuid of this subscription 112 * @throws SystemException if a system exception occurred 113 */ 114 @Override 115 public String getUserUuid() throws SystemException; 116 117 /** 118 * Sets the user uuid of this subscription. 119 * 120 * @param userUuid the user uuid of this subscription 121 */ 122 @Override 123 public void setUserUuid(String userUuid); 124 125 /** 126 * Returns the user name of this subscription. 127 * 128 * @return the user name of this subscription 129 */ 130 @AutoEscape 131 @Override 132 public String getUserName(); 133 134 /** 135 * Sets the user name of this subscription. 136 * 137 * @param userName the user name of this subscription 138 */ 139 @Override 140 public void setUserName(String userName); 141 142 /** 143 * Returns the create date of this subscription. 144 * 145 * @return the create date of this subscription 146 */ 147 @Override 148 public Date getCreateDate(); 149 150 /** 151 * Sets the create date of this subscription. 152 * 153 * @param createDate the create date of this subscription 154 */ 155 @Override 156 public void setCreateDate(Date createDate); 157 158 /** 159 * Returns the modified date of this subscription. 160 * 161 * @return the modified date of this subscription 162 */ 163 @Override 164 public Date getModifiedDate(); 165 166 /** 167 * Sets the modified date of this subscription. 168 * 169 * @param modifiedDate the modified date of this subscription 170 */ 171 @Override 172 public void setModifiedDate(Date modifiedDate); 173 174 /** 175 * Returns the fully qualified class name of this subscription. 176 * 177 * @return the fully qualified class name of this subscription 178 */ 179 @Override 180 public String getClassName(); 181 182 public void setClassName(String className); 183 184 /** 185 * Returns the class name ID of this subscription. 186 * 187 * @return the class name ID of this subscription 188 */ 189 @Override 190 public long getClassNameId(); 191 192 /** 193 * Sets the class name ID of this subscription. 194 * 195 * @param classNameId the class name ID of this subscription 196 */ 197 @Override 198 public void setClassNameId(long classNameId); 199 200 /** 201 * Returns the class p k of this subscription. 202 * 203 * @return the class p k of this subscription 204 */ 205 @Override 206 public long getClassPK(); 207 208 /** 209 * Sets the class p k of this subscription. 210 * 211 * @param classPK the class p k of this subscription 212 */ 213 @Override 214 public void setClassPK(long classPK); 215 216 /** 217 * Returns the frequency of this subscription. 218 * 219 * @return the frequency of this subscription 220 */ 221 @AutoEscape 222 public String getFrequency(); 223 224 /** 225 * Sets the frequency of this subscription. 226 * 227 * @param frequency the frequency of this subscription 228 */ 229 public void setFrequency(String frequency); 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(Subscription subscription); 269 270 @Override 271 public int hashCode(); 272 273 @Override 274 public CacheModel<Subscription> toCacheModel(); 275 276 @Override 277 public Subscription toEscapedModel(); 278 279 @Override 280 public Subscription toUnescapedModel(); 281 282 @Override 283 public String toString(); 284 285 @Override 286 public String toXmlString(); 287 }