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.portlet.messageboards.model;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.bean.AutoEscape;
020    import com.liferay.portal.kernel.exception.SystemException;
021    import com.liferay.portal.model.BaseModel;
022    import com.liferay.portal.model.CacheModel;
023    import com.liferay.portal.model.StagedGroupedModel;
024    import com.liferay.portal.service.ServiceContext;
025    
026    import com.liferay.portlet.expando.model.ExpandoBridge;
027    
028    import java.io.Serializable;
029    
030    import java.util.Date;
031    
032    /**
033     * The base model interface for the MBBan service. Represents a row in the "MBBan" database table, with each column mapped to a property of this class.
034     *
035     * <p>
036     * This interface and its corresponding implementation {@link com.liferay.portlet.messageboards.model.impl.MBBanModelImpl} 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.portlet.messageboards.model.impl.MBBanImpl}.
037     * </p>
038     *
039     * @author Brian Wing Shun Chan
040     * @see MBBan
041     * @see com.liferay.portlet.messageboards.model.impl.MBBanImpl
042     * @see com.liferay.portlet.messageboards.model.impl.MBBanModelImpl
043     * @generated
044     */
045    @ProviderType
046    public interface MBBanModel extends BaseModel<MBBan>, StagedGroupedModel {
047            /*
048             * NOTE FOR DEVELOPERS:
049             *
050             * Never modify or reference this interface directly. All methods that expect a message boards ban model instance should use the {@link MBBan} interface instead.
051             */
052    
053            /**
054             * Returns the primary key of this message boards ban.
055             *
056             * @return the primary key of this message boards ban
057             */
058            public long getPrimaryKey();
059    
060            /**
061             * Sets the primary key of this message boards ban.
062             *
063             * @param primaryKey the primary key of this message boards ban
064             */
065            public void setPrimaryKey(long primaryKey);
066    
067            /**
068             * Returns the uuid of this message boards ban.
069             *
070             * @return the uuid of this message boards ban
071             */
072            @AutoEscape
073            @Override
074            public String getUuid();
075    
076            /**
077             * Sets the uuid of this message boards ban.
078             *
079             * @param uuid the uuid of this message boards ban
080             */
081            @Override
082            public void setUuid(String uuid);
083    
084            /**
085             * Returns the ban ID of this message boards ban.
086             *
087             * @return the ban ID of this message boards ban
088             */
089            public long getBanId();
090    
091            /**
092             * Sets the ban ID of this message boards ban.
093             *
094             * @param banId the ban ID of this message boards ban
095             */
096            public void setBanId(long banId);
097    
098            /**
099             * Returns the group ID of this message boards ban.
100             *
101             * @return the group ID of this message boards ban
102             */
103            @Override
104            public long getGroupId();
105    
106            /**
107             * Sets the group ID of this message boards ban.
108             *
109             * @param groupId the group ID of this message boards ban
110             */
111            @Override
112            public void setGroupId(long groupId);
113    
114            /**
115             * Returns the company ID of this message boards ban.
116             *
117             * @return the company ID of this message boards ban
118             */
119            @Override
120            public long getCompanyId();
121    
122            /**
123             * Sets the company ID of this message boards ban.
124             *
125             * @param companyId the company ID of this message boards ban
126             */
127            @Override
128            public void setCompanyId(long companyId);
129    
130            /**
131             * Returns the user ID of this message boards ban.
132             *
133             * @return the user ID of this message boards ban
134             */
135            @Override
136            public long getUserId();
137    
138            /**
139             * Sets the user ID of this message boards ban.
140             *
141             * @param userId the user ID of this message boards ban
142             */
143            @Override
144            public void setUserId(long userId);
145    
146            /**
147             * Returns the user uuid of this message boards ban.
148             *
149             * @return the user uuid of this message boards ban
150             * @throws SystemException if a system exception occurred
151             */
152            @Override
153            public String getUserUuid() throws SystemException;
154    
155            /**
156             * Sets the user uuid of this message boards ban.
157             *
158             * @param userUuid the user uuid of this message boards ban
159             */
160            @Override
161            public void setUserUuid(String userUuid);
162    
163            /**
164             * Returns the user name of this message boards ban.
165             *
166             * @return the user name of this message boards ban
167             */
168            @AutoEscape
169            @Override
170            public String getUserName();
171    
172            /**
173             * Sets the user name of this message boards ban.
174             *
175             * @param userName the user name of this message boards ban
176             */
177            @Override
178            public void setUserName(String userName);
179    
180            /**
181             * Returns the create date of this message boards ban.
182             *
183             * @return the create date of this message boards ban
184             */
185            @Override
186            public Date getCreateDate();
187    
188            /**
189             * Sets the create date of this message boards ban.
190             *
191             * @param createDate the create date of this message boards ban
192             */
193            @Override
194            public void setCreateDate(Date createDate);
195    
196            /**
197             * Returns the modified date of this message boards ban.
198             *
199             * @return the modified date of this message boards ban
200             */
201            @Override
202            public Date getModifiedDate();
203    
204            /**
205             * Sets the modified date of this message boards ban.
206             *
207             * @param modifiedDate the modified date of this message boards ban
208             */
209            @Override
210            public void setModifiedDate(Date modifiedDate);
211    
212            /**
213             * Returns the ban user ID of this message boards ban.
214             *
215             * @return the ban user ID of this message boards ban
216             */
217            public long getBanUserId();
218    
219            /**
220             * Sets the ban user ID of this message boards ban.
221             *
222             * @param banUserId the ban user ID of this message boards ban
223             */
224            public void setBanUserId(long banUserId);
225    
226            /**
227             * Returns the ban user uuid of this message boards ban.
228             *
229             * @return the ban user uuid of this message boards ban
230             * @throws SystemException if a system exception occurred
231             */
232            public String getBanUserUuid() throws SystemException;
233    
234            /**
235             * Sets the ban user uuid of this message boards ban.
236             *
237             * @param banUserUuid the ban user uuid of this message boards ban
238             */
239            public void setBanUserUuid(String banUserUuid);
240    
241            @Override
242            public boolean isNew();
243    
244            @Override
245            public void setNew(boolean n);
246    
247            @Override
248            public boolean isCachedModel();
249    
250            @Override
251            public void setCachedModel(boolean cachedModel);
252    
253            @Override
254            public boolean isEscapedModel();
255    
256            @Override
257            public Serializable getPrimaryKeyObj();
258    
259            @Override
260            public void setPrimaryKeyObj(Serializable primaryKeyObj);
261    
262            @Override
263            public ExpandoBridge getExpandoBridge();
264    
265            @Override
266            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
267    
268            @Override
269            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
270    
271            @Override
272            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
273    
274            @Override
275            public Object clone();
276    
277            @Override
278            public int compareTo(MBBan mbBan);
279    
280            @Override
281            public int hashCode();
282    
283            @Override
284            public CacheModel<MBBan> toCacheModel();
285    
286            @Override
287            public MBBan toEscapedModel();
288    
289            @Override
290            public MBBan toUnescapedModel();
291    
292            @Override
293            public String toString();
294    
295            @Override
296            public String toXmlString();
297    }