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 PortletPreferences service. Represents a row in the "PortletPreferences" 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.PortletPreferencesModelImpl} 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.PortletPreferencesImpl}. 031 * </p> 032 * 033 * @author Brian Wing Shun Chan 034 * @see PortletPreferences 035 * @see com.liferay.portal.model.impl.PortletPreferencesImpl 036 * @see com.liferay.portal.model.impl.PortletPreferencesModelImpl 037 * @generated 038 */ 039 @ProviderType 040 public interface PortletPreferencesModel extends BaseModel<PortletPreferences>, 041 MVCCModel, ShardedModel { 042 /* 043 * NOTE FOR DEVELOPERS: 044 * 045 * Never modify or reference this interface directly. All methods that expect a portlet preferences model instance should use the {@link PortletPreferences} interface instead. 046 */ 047 048 /** 049 * Returns the primary key of this portlet preferences. 050 * 051 * @return the primary key of this portlet preferences 052 */ 053 public long getPrimaryKey(); 054 055 /** 056 * Sets the primary key of this portlet preferences. 057 * 058 * @param primaryKey the primary key of this portlet preferences 059 */ 060 public void setPrimaryKey(long primaryKey); 061 062 /** 063 * Returns the mvcc version of this portlet preferences. 064 * 065 * @return the mvcc version of this portlet preferences 066 */ 067 @Override 068 public long getMvccVersion(); 069 070 /** 071 * Sets the mvcc version of this portlet preferences. 072 * 073 * @param mvccVersion the mvcc version of this portlet preferences 074 */ 075 @Override 076 public void setMvccVersion(long mvccVersion); 077 078 /** 079 * Returns the portlet preferences ID of this portlet preferences. 080 * 081 * @return the portlet preferences ID of this portlet preferences 082 */ 083 public long getPortletPreferencesId(); 084 085 /** 086 * Sets the portlet preferences ID of this portlet preferences. 087 * 088 * @param portletPreferencesId the portlet preferences ID of this portlet preferences 089 */ 090 public void setPortletPreferencesId(long portletPreferencesId); 091 092 /** 093 * Returns the company ID of this portlet preferences. 094 * 095 * @return the company ID of this portlet preferences 096 */ 097 @Override 098 public long getCompanyId(); 099 100 /** 101 * Sets the company ID of this portlet preferences. 102 * 103 * @param companyId the company ID of this portlet preferences 104 */ 105 @Override 106 public void setCompanyId(long companyId); 107 108 /** 109 * Returns the owner ID of this portlet preferences. 110 * 111 * @return the owner ID of this portlet preferences 112 */ 113 public long getOwnerId(); 114 115 /** 116 * Sets the owner ID of this portlet preferences. 117 * 118 * @param ownerId the owner ID of this portlet preferences 119 */ 120 public void setOwnerId(long ownerId); 121 122 /** 123 * Returns the owner type of this portlet preferences. 124 * 125 * @return the owner type of this portlet preferences 126 */ 127 public int getOwnerType(); 128 129 /** 130 * Sets the owner type of this portlet preferences. 131 * 132 * @param ownerType the owner type of this portlet preferences 133 */ 134 public void setOwnerType(int ownerType); 135 136 /** 137 * Returns the plid of this portlet preferences. 138 * 139 * @return the plid of this portlet preferences 140 */ 141 public long getPlid(); 142 143 /** 144 * Sets the plid of this portlet preferences. 145 * 146 * @param plid the plid of this portlet preferences 147 */ 148 public void setPlid(long plid); 149 150 /** 151 * Returns the portlet ID of this portlet preferences. 152 * 153 * @return the portlet ID of this portlet preferences 154 */ 155 @AutoEscape 156 public String getPortletId(); 157 158 /** 159 * Sets the portlet ID of this portlet preferences. 160 * 161 * @param portletId the portlet ID of this portlet preferences 162 */ 163 public void setPortletId(String portletId); 164 165 /** 166 * Returns the preferences of this portlet preferences. 167 * 168 * @return the preferences of this portlet preferences 169 */ 170 @AutoEscape 171 public String getPreferences(); 172 173 /** 174 * Sets the preferences of this portlet preferences. 175 * 176 * @param preferences the preferences of this portlet preferences 177 */ 178 public void setPreferences(String preferences); 179 180 @Override 181 public boolean isNew(); 182 183 @Override 184 public void setNew(boolean n); 185 186 @Override 187 public boolean isCachedModel(); 188 189 @Override 190 public void setCachedModel(boolean cachedModel); 191 192 @Override 193 public boolean isEscapedModel(); 194 195 @Override 196 public Serializable getPrimaryKeyObj(); 197 198 @Override 199 public void setPrimaryKeyObj(Serializable primaryKeyObj); 200 201 @Override 202 public ExpandoBridge getExpandoBridge(); 203 204 @Override 205 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 206 207 @Override 208 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 209 210 @Override 211 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 212 213 @Override 214 public Object clone(); 215 216 @Override 217 public int compareTo( 218 com.liferay.portal.model.PortletPreferences portletPreferences); 219 220 @Override 221 public int hashCode(); 222 223 @Override 224 public CacheModel<com.liferay.portal.model.PortletPreferences> toCacheModel(); 225 226 @Override 227 public com.liferay.portal.model.PortletPreferences toEscapedModel(); 228 229 @Override 230 public com.liferay.portal.model.PortletPreferences toUnescapedModel(); 231 232 @Override 233 public String toString(); 234 235 @Override 236 public String toXmlString(); 237 }