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 com.liferay.portal.kernel.bean.AutoEscape; 018 import com.liferay.portal.service.ServiceContext; 019 020 import com.liferay.portlet.expando.model.ExpandoBridge; 021 022 import java.io.Serializable; 023 024 /** 025 * 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. 026 * 027 * <p> 028 * 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}. 029 * </p> 030 * 031 * @author Brian Wing Shun Chan 032 * @see PortletPreferences 033 * @see com.liferay.portal.model.impl.PortletPreferencesImpl 034 * @see com.liferay.portal.model.impl.PortletPreferencesModelImpl 035 * @generated 036 */ 037 public interface PortletPreferencesModel extends BaseModel<PortletPreferences> { 038 /* 039 * NOTE FOR DEVELOPERS: 040 * 041 * Never modify or reference this interface directly. All methods that expect a portlet preferences model instance should use the {@link PortletPreferences} interface instead. 042 */ 043 044 /** 045 * Returns the primary key of this portlet preferences. 046 * 047 * @return the primary key of this portlet preferences 048 */ 049 public long getPrimaryKey(); 050 051 /** 052 * Sets the primary key of this portlet preferences. 053 * 054 * @param primaryKey the primary key of this portlet preferences 055 */ 056 public void setPrimaryKey(long primaryKey); 057 058 /** 059 * Returns the portlet preferences ID of this portlet preferences. 060 * 061 * @return the portlet preferences ID of this portlet preferences 062 */ 063 public long getPortletPreferencesId(); 064 065 /** 066 * Sets the portlet preferences ID of this portlet preferences. 067 * 068 * @param portletPreferencesId the portlet preferences ID of this portlet preferences 069 */ 070 public void setPortletPreferencesId(long portletPreferencesId); 071 072 /** 073 * Returns the owner ID of this portlet preferences. 074 * 075 * @return the owner ID of this portlet preferences 076 */ 077 public long getOwnerId(); 078 079 /** 080 * Sets the owner ID of this portlet preferences. 081 * 082 * @param ownerId the owner ID of this portlet preferences 083 */ 084 public void setOwnerId(long ownerId); 085 086 /** 087 * Returns the owner type of this portlet preferences. 088 * 089 * @return the owner type of this portlet preferences 090 */ 091 public int getOwnerType(); 092 093 /** 094 * Sets the owner type of this portlet preferences. 095 * 096 * @param ownerType the owner type of this portlet preferences 097 */ 098 public void setOwnerType(int ownerType); 099 100 /** 101 * Returns the plid of this portlet preferences. 102 * 103 * @return the plid of this portlet preferences 104 */ 105 public long getPlid(); 106 107 /** 108 * Sets the plid of this portlet preferences. 109 * 110 * @param plid the plid of this portlet preferences 111 */ 112 public void setPlid(long plid); 113 114 /** 115 * Returns the portlet ID of this portlet preferences. 116 * 117 * @return the portlet ID of this portlet preferences 118 */ 119 @AutoEscape 120 public String getPortletId(); 121 122 /** 123 * Sets the portlet ID of this portlet preferences. 124 * 125 * @param portletId the portlet ID of this portlet preferences 126 */ 127 public void setPortletId(String portletId); 128 129 /** 130 * Returns the preferences of this portlet preferences. 131 * 132 * @return the preferences of this portlet preferences 133 */ 134 @AutoEscape 135 public String getPreferences(); 136 137 /** 138 * Sets the preferences of this portlet preferences. 139 * 140 * @param preferences the preferences of this portlet preferences 141 */ 142 public void setPreferences(String preferences); 143 144 public boolean isNew(); 145 146 public void setNew(boolean n); 147 148 public boolean isCachedModel(); 149 150 public void setCachedModel(boolean cachedModel); 151 152 public boolean isEscapedModel(); 153 154 public Serializable getPrimaryKeyObj(); 155 156 public void setPrimaryKeyObj(Serializable primaryKeyObj); 157 158 public ExpandoBridge getExpandoBridge(); 159 160 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 161 162 public Object clone(); 163 164 public int compareTo(PortletPreferences portletPreferences); 165 166 public int hashCode(); 167 168 public CacheModel<PortletPreferences> toCacheModel(); 169 170 public PortletPreferences toEscapedModel(); 171 172 public PortletPreferences toUnescapedModel(); 173 174 public String toString(); 175 176 public String toXmlString(); 177 }