001    /**
002     * Copyright (c) 2000-2010 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.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 Portlet service. Represents a row in the "Portlet" 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.PortletModelImpl} 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.PortletImpl}.
029     * </p>
030     *
031     * <p>
032     * Never modify or reference this interface directly. All methods that expect a portlet model instance should use the {@link Portlet} interface instead.
033     * </p>
034     *
035     * @author Brian Wing Shun Chan
036     * @see Portlet
037     * @see com.liferay.portal.model.impl.PortletImpl
038     * @see com.liferay.portal.model.impl.PortletModelImpl
039     * @generated
040     */
041    public interface PortletModel extends BaseModel<Portlet> {
042            /**
043             * Gets the primary key of this portlet.
044             *
045             * @return the primary key of this portlet
046             */
047            public long getPrimaryKey();
048    
049            /**
050             * Sets the primary key of this portlet
051             *
052             * @param pk the primary key of this portlet
053             */
054            public void setPrimaryKey(long pk);
055    
056            /**
057             * Gets the id of this portlet.
058             *
059             * @return the id of this portlet
060             */
061            public long getId();
062    
063            /**
064             * Sets the id of this portlet.
065             *
066             * @param id the id of this portlet
067             */
068            public void setId(long id);
069    
070            /**
071             * Gets the company id of this portlet.
072             *
073             * @return the company id of this portlet
074             */
075            public long getCompanyId();
076    
077            /**
078             * Sets the company id of this portlet.
079             *
080             * @param companyId the company id of this portlet
081             */
082            public void setCompanyId(long companyId);
083    
084            /**
085             * Gets the portlet id of this portlet.
086             *
087             * @return the portlet id of this portlet
088             */
089            @AutoEscape
090            public String getPortletId();
091    
092            /**
093             * Sets the portlet id of this portlet.
094             *
095             * @param portletId the portlet id of this portlet
096             */
097            public void setPortletId(String portletId);
098    
099            /**
100             * Gets the roles of this portlet.
101             *
102             * @return the roles of this portlet
103             */
104            @AutoEscape
105            public String getRoles();
106    
107            /**
108             * Sets the roles of this portlet.
109             *
110             * @param roles the roles of this portlet
111             */
112            public void setRoles(String roles);
113    
114            /**
115             * Gets the active of this portlet.
116             *
117             * @return the active of this portlet
118             */
119            public boolean getActive();
120    
121            /**
122             * Determines whether this portlet is active.
123             *
124             * @return whether this portlet is active
125             */
126            public boolean isActive();
127    
128            /**
129             * Sets whether this {$entity.humanName} is active.
130             *
131             * @param active the active of this portlet
132             */
133            public void setActive(boolean active);
134    
135            /**
136             * Gets a copy of this portlet as an escaped model instance by wrapping it with an {@link com.liferay.portal.kernel.bean.AutoEscapeBeanHandler}.
137             *
138             * @return the escaped model instance
139             * @see com.liferay.portal.kernel.bean.AutoEscapeBeanHandler
140             */
141            public Portlet toEscapedModel();
142    
143            public boolean isNew();
144    
145            public void setNew(boolean n);
146    
147            public boolean isCachedModel();
148    
149            public void setCachedModel(boolean cachedModel);
150    
151            public boolean isEscapedModel();
152    
153            public void setEscapedModel(boolean escapedModel);
154    
155            public Serializable getPrimaryKeyObj();
156    
157            public ExpandoBridge getExpandoBridge();
158    
159            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
160    
161            public Object clone();
162    
163            public int compareTo(Portlet portlet);
164    
165            public int hashCode();
166    
167            public String toString();
168    
169            public String toXmlString();
170    }