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 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 /* 042 * NOTE FOR DEVELOPERS: 043 * 044 * Never modify or reference this interface directly. All methods that expect a portlet preferences model instance should use the {@link PortletPreferences} interface instead. 045 */ 046 047 /** 048 * Returns the primary key of this portlet preferences. 049 * 050 * @return the primary key of this portlet preferences 051 */ 052 public long getPrimaryKey(); 053 054 /** 055 * Sets the primary key of this portlet preferences. 056 * 057 * @param primaryKey the primary key of this portlet preferences 058 */ 059 public void setPrimaryKey(long primaryKey); 060 061 /** 062 * Returns the portlet preferences ID of this portlet preferences. 063 * 064 * @return the portlet preferences ID of this portlet preferences 065 */ 066 public long getPortletPreferencesId(); 067 068 /** 069 * Sets the portlet preferences ID of this portlet preferences. 070 * 071 * @param portletPreferencesId the portlet preferences ID of this portlet preferences 072 */ 073 public void setPortletPreferencesId(long portletPreferencesId); 074 075 /** 076 * Returns the owner ID of this portlet preferences. 077 * 078 * @return the owner ID of this portlet preferences 079 */ 080 public long getOwnerId(); 081 082 /** 083 * Sets the owner ID of this portlet preferences. 084 * 085 * @param ownerId the owner ID of this portlet preferences 086 */ 087 public void setOwnerId(long ownerId); 088 089 /** 090 * Returns the owner type of this portlet preferences. 091 * 092 * @return the owner type of this portlet preferences 093 */ 094 public int getOwnerType(); 095 096 /** 097 * Sets the owner type of this portlet preferences. 098 * 099 * @param ownerType the owner type of this portlet preferences 100 */ 101 public void setOwnerType(int ownerType); 102 103 /** 104 * Returns the plid of this portlet preferences. 105 * 106 * @return the plid of this portlet preferences 107 */ 108 public long getPlid(); 109 110 /** 111 * Sets the plid of this portlet preferences. 112 * 113 * @param plid the plid of this portlet preferences 114 */ 115 public void setPlid(long plid); 116 117 /** 118 * Returns the portlet ID of this portlet preferences. 119 * 120 * @return the portlet ID of this portlet preferences 121 */ 122 @AutoEscape 123 public String getPortletId(); 124 125 /** 126 * Sets the portlet ID of this portlet preferences. 127 * 128 * @param portletId the portlet ID of this portlet preferences 129 */ 130 public void setPortletId(String portletId); 131 132 /** 133 * Returns the preferences of this portlet preferences. 134 * 135 * @return the preferences of this portlet preferences 136 */ 137 @AutoEscape 138 public String getPreferences(); 139 140 /** 141 * Sets the preferences of this portlet preferences. 142 * 143 * @param preferences the preferences of this portlet preferences 144 */ 145 public void setPreferences(String preferences); 146 147 @Override 148 public boolean isNew(); 149 150 @Override 151 public void setNew(boolean n); 152 153 @Override 154 public boolean isCachedModel(); 155 156 @Override 157 public void setCachedModel(boolean cachedModel); 158 159 @Override 160 public boolean isEscapedModel(); 161 162 @Override 163 public Serializable getPrimaryKeyObj(); 164 165 @Override 166 public void setPrimaryKeyObj(Serializable primaryKeyObj); 167 168 @Override 169 public ExpandoBridge getExpandoBridge(); 170 171 @Override 172 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 173 174 @Override 175 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 176 177 @Override 178 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 179 180 @Override 181 public Object clone(); 182 183 @Override 184 public int compareTo(PortletPreferences portletPreferences); 185 186 @Override 187 public int hashCode(); 188 189 @Override 190 public CacheModel<PortletPreferences> toCacheModel(); 191 192 @Override 193 public PortletPreferences toEscapedModel(); 194 195 @Override 196 public PortletPreferences toUnescapedModel(); 197 198 @Override 199 public String toString(); 200 201 @Override 202 public String toXmlString(); 203 }