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 { 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 public long getCompanyId(); 097 098 /** 099 * Sets the company ID of this portlet. 100 * 101 * @param companyId the company ID of this portlet 102 */ 103 public void setCompanyId(long companyId); 104 105 /** 106 * Returns the portlet ID of this portlet. 107 * 108 * @return the portlet ID of this portlet 109 */ 110 @AutoEscape 111 public String getPortletId(); 112 113 /** 114 * Sets the portlet ID of this portlet. 115 * 116 * @param portletId the portlet ID of this portlet 117 */ 118 public void setPortletId(String portletId); 119 120 /** 121 * Returns the roles of this portlet. 122 * 123 * @return the roles of this portlet 124 */ 125 @AutoEscape 126 public String getRoles(); 127 128 /** 129 * Sets the roles of this portlet. 130 * 131 * @param roles the roles of this portlet 132 */ 133 public void setRoles(String roles); 134 135 /** 136 * Returns the active of this portlet. 137 * 138 * @return the active of this portlet 139 */ 140 public boolean getActive(); 141 142 /** 143 * Returns <code>true</code> if this portlet is active. 144 * 145 * @return <code>true</code> if this portlet is active; <code>false</code> otherwise 146 */ 147 public boolean isActive(); 148 149 /** 150 * Sets whether this portlet is active. 151 * 152 * @param active the active of this portlet 153 */ 154 public void setActive(boolean active); 155 156 @Override 157 public boolean isNew(); 158 159 @Override 160 public void setNew(boolean n); 161 162 @Override 163 public boolean isCachedModel(); 164 165 @Override 166 public void setCachedModel(boolean cachedModel); 167 168 @Override 169 public boolean isEscapedModel(); 170 171 @Override 172 public Serializable getPrimaryKeyObj(); 173 174 @Override 175 public void setPrimaryKeyObj(Serializable primaryKeyObj); 176 177 @Override 178 public ExpandoBridge getExpandoBridge(); 179 180 @Override 181 public void setExpandoBridgeAttributes(BaseModel<?> baseModel); 182 183 @Override 184 public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge); 185 186 @Override 187 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 188 189 @Override 190 public Object clone(); 191 192 @Override 193 public int compareTo(com.liferay.portal.model.Portlet portlet); 194 195 @Override 196 public int hashCode(); 197 198 @Override 199 public CacheModel<com.liferay.portal.model.Portlet> toCacheModel(); 200 201 @Override 202 public com.liferay.portal.model.Portlet toEscapedModel(); 203 204 @Override 205 public com.liferay.portal.model.Portlet toUnescapedModel(); 206 207 @Override 208 public String toString(); 209 210 @Override 211 public String toXmlString(); 212 }