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.portlet.messageboards.model;
016    
017    import com.liferay.portal.kernel.annotation.AutoEscape;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.model.BaseModel;
020    import com.liferay.portal.service.ServiceContext;
021    
022    import com.liferay.portlet.expando.model.ExpandoBridge;
023    
024    import java.io.Serializable;
025    
026    import java.util.Date;
027    
028    /**
029     * 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.
030     *
031     * <p>
032     * 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}.
033     * </p>
034     *
035     * <p>
036     * Never modify or reference this interface directly. All methods that expect a message boards ban model instance should use the {@link MBBan} interface instead.
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    public interface MBBanModel extends BaseModel<MBBan> {
046            /**
047             * Gets the primary key of this message boards ban.
048             *
049             * @return the primary key of this message boards ban
050             */
051            public long getPrimaryKey();
052    
053            /**
054             * Sets the primary key of this message boards ban
055             *
056             * @param pk the primary key of this message boards ban
057             */
058            public void setPrimaryKey(long pk);
059    
060            /**
061             * Gets the ban id of this message boards ban.
062             *
063             * @return the ban id of this message boards ban
064             */
065            public long getBanId();
066    
067            /**
068             * Sets the ban id of this message boards ban.
069             *
070             * @param banId the ban id of this message boards ban
071             */
072            public void setBanId(long banId);
073    
074            /**
075             * Gets the group id of this message boards ban.
076             *
077             * @return the group id of this message boards ban
078             */
079            public long getGroupId();
080    
081            /**
082             * Sets the group id of this message boards ban.
083             *
084             * @param groupId the group id of this message boards ban
085             */
086            public void setGroupId(long groupId);
087    
088            /**
089             * Gets the company id of this message boards ban.
090             *
091             * @return the company id of this message boards ban
092             */
093            public long getCompanyId();
094    
095            /**
096             * Sets the company id of this message boards ban.
097             *
098             * @param companyId the company id of this message boards ban
099             */
100            public void setCompanyId(long companyId);
101    
102            /**
103             * Gets the user id of this message boards ban.
104             *
105             * @return the user id of this message boards ban
106             */
107            public long getUserId();
108    
109            /**
110             * Sets the user id of this message boards ban.
111             *
112             * @param userId the user id of this message boards ban
113             */
114            public void setUserId(long userId);
115    
116            /**
117             * Gets the user uuid of this message boards ban.
118             *
119             * @return the user uuid of this message boards ban
120             * @throws SystemException if a system exception occurred
121             */
122            public String getUserUuid() throws SystemException;
123    
124            /**
125             * Sets the user uuid of this message boards ban.
126             *
127             * @param userUuid the user uuid of this message boards ban
128             */
129            public void setUserUuid(String userUuid);
130    
131            /**
132             * Gets the user name of this message boards ban.
133             *
134             * @return the user name of this message boards ban
135             */
136            @AutoEscape
137            public String getUserName();
138    
139            /**
140             * Sets the user name of this message boards ban.
141             *
142             * @param userName the user name of this message boards ban
143             */
144            public void setUserName(String userName);
145    
146            /**
147             * Gets the create date of this message boards ban.
148             *
149             * @return the create date of this message boards ban
150             */
151            public Date getCreateDate();
152    
153            /**
154             * Sets the create date of this message boards ban.
155             *
156             * @param createDate the create date of this message boards ban
157             */
158            public void setCreateDate(Date createDate);
159    
160            /**
161             * Gets the modified date of this message boards ban.
162             *
163             * @return the modified date of this message boards ban
164             */
165            public Date getModifiedDate();
166    
167            /**
168             * Sets the modified date of this message boards ban.
169             *
170             * @param modifiedDate the modified date of this message boards ban
171             */
172            public void setModifiedDate(Date modifiedDate);
173    
174            /**
175             * Gets the ban user id of this message boards ban.
176             *
177             * @return the ban user id of this message boards ban
178             */
179            public long getBanUserId();
180    
181            /**
182             * Sets the ban user id of this message boards ban.
183             *
184             * @param banUserId the ban user id of this message boards ban
185             */
186            public void setBanUserId(long banUserId);
187    
188            /**
189             * Gets the ban user uuid of this message boards ban.
190             *
191             * @return the ban user uuid of this message boards ban
192             * @throws SystemException if a system exception occurred
193             */
194            public String getBanUserUuid() throws SystemException;
195    
196            /**
197             * Sets the ban user uuid of this message boards ban.
198             *
199             * @param banUserUuid the ban user uuid of this message boards ban
200             */
201            public void setBanUserUuid(String banUserUuid);
202    
203            /**
204             * Gets a copy of this message boards ban as an escaped model instance by wrapping it with an {@link com.liferay.portal.kernel.bean.AutoEscapeBeanHandler}.
205             *
206             * @return the escaped model instance
207             * @see com.liferay.portal.kernel.bean.AutoEscapeBeanHandler
208             */
209            public MBBan toEscapedModel();
210    
211            public boolean isNew();
212    
213            public void setNew(boolean n);
214    
215            public boolean isCachedModel();
216    
217            public void setCachedModel(boolean cachedModel);
218    
219            public boolean isEscapedModel();
220    
221            public void setEscapedModel(boolean escapedModel);
222    
223            public Serializable getPrimaryKeyObj();
224    
225            public ExpandoBridge getExpandoBridge();
226    
227            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
228    
229            public Object clone();
230    
231            public int compareTo(MBBan mbBan);
232    
233            public int hashCode();
234    
235            public String toString();
236    
237            public String toXmlString();
238    }