001    /**
002     * Copyright (c) 2000-present 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 Portlet service. Represents a row in the "Portlet" 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.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}.
031     * </p>
032     *
033     * @author Brian Wing Shun Chan
034     * @see Portlet
035     * @see com.liferay.portal.model.impl.PortletImpl
036     * @see com.liferay.portal.model.impl.PortletModelImpl
037     * @generated
038     */
039    @ProviderType
040    public interface PortletModel extends BaseModel<Portlet>, MVCCModel, ShardedModel {
041            /*
042             * NOTE FOR DEVELOPERS:
043             *
044             * Never modify or reference this interface directly. All methods that expect a portlet model instance should use the {@link Portlet} interface instead.
045             */
046    
047            /**
048             * Returns the primary key of this portlet.
049             *
050             * @return the primary key of this portlet
051             */
052            public long getPrimaryKey();
053    
054            /**
055             * Sets the primary key of this portlet.
056             *
057             * @param primaryKey the primary key of this portlet
058             */
059            public void setPrimaryKey(long primaryKey);
060    
061            /**
062             * Returns the mvcc version of this portlet.
063             *
064             * @return the mvcc version of this portlet
065             */
066            @Override
067            public long getMvccVersion();
068    
069            /**
070             * Sets the mvcc version of this portlet.
071             *
072             * @param mvccVersion the mvcc version of this portlet
073             */
074            @Override
075            public void setMvccVersion(long mvccVersion);
076    
077            /**
078             * Returns the ID of this portlet.
079             *
080             * @return the ID of this portlet
081             */
082            public long getId();
083    
084            /**
085             * Sets the ID of this portlet.
086             *
087             * @param id the ID of this portlet
088             */
089            public void setId(long id);
090    
091            /**
092             * Returns the company ID of this portlet.
093             *
094             * @return the company ID of this portlet
095             */
096            @Override
097            public long getCompanyId();
098    
099            /**
100             * Sets the company ID of this portlet.
101             *
102             * @param companyId the company ID of this portlet
103             */
104            @Override
105            public void setCompanyId(long companyId);
106    
107            /**
108             * Returns the portlet ID of this portlet.
109             *
110             * @return the portlet ID of this portlet
111             */
112            @AutoEscape
113            public String getPortletId();
114    
115            /**
116             * Sets the portlet ID of this portlet.
117             *
118             * @param portletId the portlet ID of this portlet
119             */
120            public void setPortletId(String portletId);
121    
122            /**
123             * Returns the roles of this portlet.
124             *
125             * @return the roles of this portlet
126             */
127            @AutoEscape
128            public String getRoles();
129    
130            /**
131             * Sets the roles of this portlet.
132             *
133             * @param roles the roles of this portlet
134             */
135            public void setRoles(String roles);
136    
137            /**
138             * Returns the active of this portlet.
139             *
140             * @return the active of this portlet
141             */
142            public boolean getActive();
143    
144            /**
145             * Returns <code>true</code> if this portlet is active.
146             *
147             * @return <code>true</code> if this portlet is active; <code>false</code> otherwise
148             */
149            public boolean isActive();
150    
151            /**
152             * Sets whether this portlet is active.
153             *
154             * @param active the active of this portlet
155             */
156            public void setActive(boolean active);
157    
158            @Override
159            public boolean isNew();
160    
161            @Override
162            public void setNew(boolean n);
163    
164            @Override
165            public boolean isCachedModel();
166    
167            @Override
168            public void setCachedModel(boolean cachedModel);
169    
170            @Override
171            public boolean isEscapedModel();
172    
173            @Override
174            public Serializable getPrimaryKeyObj();
175    
176            @Override
177            public void setPrimaryKeyObj(Serializable primaryKeyObj);
178    
179            @Override
180            public ExpandoBridge getExpandoBridge();
181    
182            @Override
183            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
184    
185            @Override
186            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
187    
188            @Override
189            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
190    
191            @Override
192            public Object clone();
193    
194            @Override
195            public int compareTo(com.liferay.portal.model.Portlet portlet);
196    
197            @Override
198            public int hashCode();
199    
200            @Override
201            public CacheModel<com.liferay.portal.model.Portlet> toCacheModel();
202    
203            @Override
204            public com.liferay.portal.model.Portlet toEscapedModel();
205    
206            @Override
207            public com.liferay.portal.model.Portlet toUnescapedModel();
208    
209            @Override
210            public String toString();
211    
212            @Override
213            public String toXmlString();
214    }