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