001 /** 002 * Copyright (c) 2000-2011 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.annotation.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 * <p> 035 * Never modify or reference this interface directly. All methods that expect a subscription model instance should use the {@link Subscription} interface instead. 036 * </p> 037 * 038 * @author Brian Wing Shun Chan 039 * @see Subscription 040 * @see com.liferay.portal.model.impl.SubscriptionImpl 041 * @see com.liferay.portal.model.impl.SubscriptionModelImpl 042 * @generated 043 */ 044 public interface SubscriptionModel extends BaseModel<Subscription> { 045 /** 046 * Gets the primary key of this subscription. 047 * 048 * @return the primary key of this subscription 049 */ 050 public long getPrimaryKey(); 051 052 /** 053 * Sets the primary key of this subscription 054 * 055 * @param pk the primary key of this subscription 056 */ 057 public void setPrimaryKey(long pk); 058 059 /** 060 * Gets the subscription id of this subscription. 061 * 062 * @return the subscription id of this subscription 063 */ 064 public long getSubscriptionId(); 065 066 /** 067 * Sets the subscription id of this subscription. 068 * 069 * @param subscriptionId the subscription id of this subscription 070 */ 071 public void setSubscriptionId(long subscriptionId); 072 073 /** 074 * Gets the company id of this subscription. 075 * 076 * @return the company id of this subscription 077 */ 078 public long getCompanyId(); 079 080 /** 081 * Sets the company id of this subscription. 082 * 083 * @param companyId the company id of this subscription 084 */ 085 public void setCompanyId(long companyId); 086 087 /** 088 * Gets the user id of this subscription. 089 * 090 * @return the user id of this subscription 091 */ 092 public long getUserId(); 093 094 /** 095 * Sets the user id of this subscription. 096 * 097 * @param userId the user id of this subscription 098 */ 099 public void setUserId(long userId); 100 101 /** 102 * Gets the user uuid of this subscription. 103 * 104 * @return the user uuid of this subscription 105 * @throws SystemException if a system exception occurred 106 */ 107 public String getUserUuid() throws SystemException; 108 109 /** 110 * Sets the user uuid of this subscription. 111 * 112 * @param userUuid the user uuid of this subscription 113 */ 114 public void setUserUuid(String userUuid); 115 116 /** 117 * Gets the user name of this subscription. 118 * 119 * @return the user name of this subscription 120 */ 121 @AutoEscape 122 public String getUserName(); 123 124 /** 125 * Sets the user name of this subscription. 126 * 127 * @param userName the user name of this subscription 128 */ 129 public void setUserName(String userName); 130 131 /** 132 * Gets the create date of this subscription. 133 * 134 * @return the create date of this subscription 135 */ 136 public Date getCreateDate(); 137 138 /** 139 * Sets the create date of this subscription. 140 * 141 * @param createDate the create date of this subscription 142 */ 143 public void setCreateDate(Date createDate); 144 145 /** 146 * Gets the modified date of this subscription. 147 * 148 * @return the modified date of this subscription 149 */ 150 public Date getModifiedDate(); 151 152 /** 153 * Sets the modified date of this subscription. 154 * 155 * @param modifiedDate the modified date of this subscription 156 */ 157 public void setModifiedDate(Date modifiedDate); 158 159 /** 160 * Gets the class name of the model instance this subscription is polymorphically associated with. 161 * 162 * @return the class name of the model instance this subscription is polymorphically associated with 163 */ 164 public String getClassName(); 165 166 /** 167 * Gets the class name id of this subscription. 168 * 169 * @return the class name id of this subscription 170 */ 171 public long getClassNameId(); 172 173 /** 174 * Sets the class name id of this subscription. 175 * 176 * @param classNameId the class name id of this subscription 177 */ 178 public void setClassNameId(long classNameId); 179 180 /** 181 * Gets the class p k of this subscription. 182 * 183 * @return the class p k of this subscription 184 */ 185 public long getClassPK(); 186 187 /** 188 * Sets the class p k of this subscription. 189 * 190 * @param classPK the class p k of this subscription 191 */ 192 public void setClassPK(long classPK); 193 194 /** 195 * Gets the frequency of this subscription. 196 * 197 * @return the frequency of this subscription 198 */ 199 @AutoEscape 200 public String getFrequency(); 201 202 /** 203 * Sets the frequency of this subscription. 204 * 205 * @param frequency the frequency of this subscription 206 */ 207 public void setFrequency(String frequency); 208 209 /** 210 * Gets a copy of this subscription as an escaped model instance by wrapping it with an {@link com.liferay.portal.kernel.bean.AutoEscapeBeanHandler}. 211 * 212 * @return the escaped model instance 213 * @see com.liferay.portal.kernel.bean.AutoEscapeBeanHandler 214 */ 215 public Subscription toEscapedModel(); 216 217 public boolean isNew(); 218 219 public void setNew(boolean n); 220 221 public boolean isCachedModel(); 222 223 public void setCachedModel(boolean cachedModel); 224 225 public boolean isEscapedModel(); 226 227 public void setEscapedModel(boolean escapedModel); 228 229 public Serializable getPrimaryKeyObj(); 230 231 public ExpandoBridge getExpandoBridge(); 232 233 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 234 235 public Object clone(); 236 237 public int compareTo(Subscription subscription); 238 239 public int hashCode(); 240 241 public String toString(); 242 243 public String toXmlString(); 244 }