001 /** 002 * Copyright (c) 2000-2012 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 public long getCompanyId(); 082 083 /** 084 * Sets the company ID of this subscription. 085 * 086 * @param companyId the company ID of this subscription 087 */ 088 public void setCompanyId(long companyId); 089 090 /** 091 * Returns the user ID of this subscription. 092 * 093 * @return the user ID of this subscription 094 */ 095 public long getUserId(); 096 097 /** 098 * Sets the user ID of this subscription. 099 * 100 * @param userId the user ID of this subscription 101 */ 102 public void setUserId(long userId); 103 104 /** 105 * Returns the user uuid of this subscription. 106 * 107 * @return the user uuid of this subscription 108 * @throws SystemException if a system exception occurred 109 */ 110 public String getUserUuid() throws SystemException; 111 112 /** 113 * Sets the user uuid of this subscription. 114 * 115 * @param userUuid the user uuid of this subscription 116 */ 117 public void setUserUuid(String userUuid); 118 119 /** 120 * Returns the user name of this subscription. 121 * 122 * @return the user name of this subscription 123 */ 124 @AutoEscape 125 public String getUserName(); 126 127 /** 128 * Sets the user name of this subscription. 129 * 130 * @param userName the user name of this subscription 131 */ 132 public void setUserName(String userName); 133 134 /** 135 * Returns the create date of this subscription. 136 * 137 * @return the create date of this subscription 138 */ 139 public Date getCreateDate(); 140 141 /** 142 * Sets the create date of this subscription. 143 * 144 * @param createDate the create date of this subscription 145 */ 146 public void setCreateDate(Date createDate); 147 148 /** 149 * Returns the modified date of this subscription. 150 * 151 * @return the modified date of this subscription 152 */ 153 public Date getModifiedDate(); 154 155 /** 156 * Sets the modified date of this subscription. 157 * 158 * @param modifiedDate the modified date of this subscription 159 */ 160 public void setModifiedDate(Date modifiedDate); 161 162 /** 163 * Returns the fully qualified class name of this subscription. 164 * 165 * @return the fully qualified class name of this subscription 166 */ 167 public String getClassName(); 168 169 /** 170 * Returns the class name ID of this subscription. 171 * 172 * @return the class name ID of this subscription 173 */ 174 public long getClassNameId(); 175 176 /** 177 * Sets the class name ID of this subscription. 178 * 179 * @param classNameId the class name ID of this subscription 180 */ 181 public void setClassNameId(long classNameId); 182 183 /** 184 * Returns the class p k of this subscription. 185 * 186 * @return the class p k of this subscription 187 */ 188 public long getClassPK(); 189 190 /** 191 * Sets the class p k of this subscription. 192 * 193 * @param classPK the class p k of this subscription 194 */ 195 public void setClassPK(long classPK); 196 197 /** 198 * Returns the frequency of this subscription. 199 * 200 * @return the frequency of this subscription 201 */ 202 @AutoEscape 203 public String getFrequency(); 204 205 /** 206 * Sets the frequency of this subscription. 207 * 208 * @param frequency the frequency of this subscription 209 */ 210 public void setFrequency(String frequency); 211 212 public boolean isNew(); 213 214 public void setNew(boolean n); 215 216 public boolean isCachedModel(); 217 218 public void setCachedModel(boolean cachedModel); 219 220 public boolean isEscapedModel(); 221 222 public Serializable getPrimaryKeyObj(); 223 224 public void setPrimaryKeyObj(Serializable primaryKeyObj); 225 226 public ExpandoBridge getExpandoBridge(); 227 228 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 229 230 public Object clone(); 231 232 public int compareTo(Subscription subscription); 233 234 public int hashCode(); 235 236 public CacheModel<Subscription> toCacheModel(); 237 238 public Subscription toEscapedModel(); 239 240 public String toString(); 241 242 public String toXmlString(); 243 }