001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portal.model;
016    
017    import com.liferay.portal.kernel.annotation.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     * <p>
032     * Never modify or reference this interface directly. All methods that expect a portlet preferences model instance should use the {@link PortletPreferences} interface instead.
033     * </p>
034     *
035     * @author Brian Wing Shun Chan
036     * @see PortletPreferences
037     * @see com.liferay.portal.model.impl.PortletPreferencesImpl
038     * @see com.liferay.portal.model.impl.PortletPreferencesModelImpl
039     * @generated
040     */
041    public interface PortletPreferencesModel extends BaseModel<PortletPreferences> {
042            /**
043             * Gets the primary key of this portlet preferences.
044             *
045             * @return the primary key of this portlet preferences
046             */
047            public long getPrimaryKey();
048    
049            /**
050             * Sets the primary key of this portlet preferences
051             *
052             * @param pk the primary key of this portlet preferences
053             */
054            public void setPrimaryKey(long pk);
055    
056            /**
057             * Gets the portlet preferences id of this portlet preferences.
058             *
059             * @return the portlet preferences id of this portlet preferences
060             */
061            public long getPortletPreferencesId();
062    
063            /**
064             * Sets the portlet preferences id of this portlet preferences.
065             *
066             * @param portletPreferencesId the portlet preferences id of this portlet preferences
067             */
068            public void setPortletPreferencesId(long portletPreferencesId);
069    
070            /**
071             * Gets the owner id of this portlet preferences.
072             *
073             * @return the owner id of this portlet preferences
074             */
075            public long getOwnerId();
076    
077            /**
078             * Sets the owner id of this portlet preferences.
079             *
080             * @param ownerId the owner id of this portlet preferences
081             */
082            public void setOwnerId(long ownerId);
083    
084            /**
085             * Gets the owner type of this portlet preferences.
086             *
087             * @return the owner type of this portlet preferences
088             */
089            public int getOwnerType();
090    
091            /**
092             * Sets the owner type of this portlet preferences.
093             *
094             * @param ownerType the owner type of this portlet preferences
095             */
096            public void setOwnerType(int ownerType);
097    
098            /**
099             * Gets the plid of this portlet preferences.
100             *
101             * @return the plid of this portlet preferences
102             */
103            public long getPlid();
104    
105            /**
106             * Sets the plid of this portlet preferences.
107             *
108             * @param plid the plid of this portlet preferences
109             */
110            public void setPlid(long plid);
111    
112            /**
113             * Gets the portlet id of this portlet preferences.
114             *
115             * @return the portlet id of this portlet preferences
116             */
117            @AutoEscape
118            public String getPortletId();
119    
120            /**
121             * Sets the portlet id of this portlet preferences.
122             *
123             * @param portletId the portlet id of this portlet preferences
124             */
125            public void setPortletId(String portletId);
126    
127            /**
128             * Gets the preferences of this portlet preferences.
129             *
130             * @return the preferences of this portlet preferences
131             */
132            @AutoEscape
133            public String getPreferences();
134    
135            /**
136             * Sets the preferences of this portlet preferences.
137             *
138             * @param preferences the preferences of this portlet preferences
139             */
140            public void setPreferences(String preferences);
141    
142            public boolean isNew();
143    
144            public void setNew(boolean n);
145    
146            public boolean isCachedModel();
147    
148            public void setCachedModel(boolean cachedModel);
149    
150            public boolean isEscapedModel();
151    
152            public void setEscapedModel(boolean escapedModel);
153    
154            public Serializable getPrimaryKeyObj();
155    
156            public ExpandoBridge getExpandoBridge();
157    
158            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
159    
160            public Object clone();
161    
162            public int compareTo(PortletPreferences portletPreferences);
163    
164            public int hashCode();
165    
166            public PortletPreferences toEscapedModel();
167    
168            public String toString();
169    
170            public String toXmlString();
171    }