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 { 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 owner ID of this portlet preferences. 094 * 095 * @return the owner ID of this portlet preferences 096 */ 097 public long getOwnerId(); 098 099 /** 100 * Sets the owner ID of this portlet preferences. 101 * 102 * @param ownerId the owner ID of this portlet preferences 103 */ 104 public void setOwnerId(long ownerId); 105 106 /** 107 * Returns the owner type of this portlet preferences. 108 * 109 * @return the owner type of this portlet preferences 110 */ 111 public int getOwnerType(); 112 113 /** 114 * Sets the owner type of this portlet preferences. 115 * 116 * @param ownerType the owner type of this portlet preferences 117 */ 118 public void setOwnerType(int ownerType); 119 120 /** 121 * Returns the plid of this portlet preferences. 122 * 123 * @return the plid of this portlet preferences 124 */ 125 public long getPlid(); 126 127 /** 128 * Sets the plid of this portlet preferences. 129 * 130 * @param plid the plid of this portlet preferences 131 */ 132 public void setPlid(long plid); 133 134 /** 135 * Returns the portlet ID of this portlet preferences. 136 * 137 * @return the portlet ID of this portlet preferences 138 */ 139 @AutoEscape 140 public String getPortletId(); 141 142 /** 143 * Sets the portlet ID of this portlet preferences. 144 * 145 * @param portletId the portlet ID of this portlet preferences 146 */ 147 public void setPortletId(String portletId); 148 149 /** 150 * Returns the preferences of this portlet preferences. 151 * 152 * @return the preferences of this portlet preferences 153 */ 154 @AutoEscape 155 public String getPreferences(); 156 157 /** 158 * Sets the preferences of this portlet preferences. 159 * 160 * @param preferences the preferences of this portlet preferences 161 */ 162 public void setPreferences(String preferences); 163 164 @Override 165 public boolean isNew(); 166 167 @Override 168 public void setNew(boolean n); 169 170 @Override 171 public boolean isCachedModel(); 172 173 @Override 174 public void setCachedModel(boolean cachedModel); 175 176 @Override 177 public boolean isEscapedModel(); 178 179 @Override 180 public Serializable getPrimaryKeyObj(); 181 182 @Override 183 public void setPrimaryKeyObj(Serializable primaryKeyObj); 184 185 @Override 186 public ExpandoBridge getExpandoBridge(); 187 188 @Override 189 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 190 191 @Override 192 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 193 194 @Override 195 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 196 197 @Override 198 public Object clone(); 199 200 @Override 201 public int compareTo( 202 com.liferay.portal.model.PortletPreferences portletPreferences); 203 204 @Override 205 public int hashCode(); 206 207 @Override 208 public CacheModel<com.liferay.portal.model.PortletPreferences> toCacheModel(); 209 210 @Override 211 public com.liferay.portal.model.PortletPreferences toEscapedModel(); 212 213 @Override 214 public com.liferay.portal.model.PortletPreferences toUnescapedModel(); 215 216 @Override 217 public String toString(); 218 219 @Override 220 public String toXmlString(); 221 }