001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portlet.journal.model;
016    
017    import com.liferay.portal.kernel.bean.AutoEscape;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.model.BaseModel;
020    import com.liferay.portal.model.CacheModel;
021    import com.liferay.portal.model.GroupedModel;
022    import com.liferay.portal.service.ServiceContext;
023    
024    import com.liferay.portlet.expando.model.ExpandoBridge;
025    
026    import java.io.Serializable;
027    
028    import java.util.Date;
029    
030    /**
031     * The base model interface for the JournalStructure service. Represents a row in the "JournalStructure" database table, with each column mapped to a property of this class.
032     *
033     * <p>
034     * This interface and its corresponding implementation {@link com.liferay.portlet.journal.model.impl.JournalStructureModelImpl} 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.journal.model.impl.JournalStructureImpl}.
035     * </p>
036     *
037     * @author Brian Wing Shun Chan
038     * @see JournalStructure
039     * @see com.liferay.portlet.journal.model.impl.JournalStructureImpl
040     * @see com.liferay.portlet.journal.model.impl.JournalStructureModelImpl
041     * @generated
042     */
043    public interface JournalStructureModel extends BaseModel<JournalStructure>,
044            GroupedModel {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. All methods that expect a journal structure model instance should use the {@link JournalStructure} interface instead.
049             */
050    
051            /**
052             * Gets the primary key of this journal structure.
053             *
054             * @return the primary key of this journal structure
055             */
056            public long getPrimaryKey();
057    
058            /**
059             * Sets the primary key of this journal structure
060             *
061             * @param primaryKey the primary key of this journal structure
062             */
063            public void setPrimaryKey(long primaryKey);
064    
065            /**
066             * Gets the uuid of this journal structure.
067             *
068             * @return the uuid of this journal structure
069             */
070            @AutoEscape
071            public String getUuid();
072    
073            /**
074             * Sets the uuid of this journal structure.
075             *
076             * @param uuid the uuid of this journal structure
077             */
078            public void setUuid(String uuid);
079    
080            /**
081             * Gets the ID of this journal structure.
082             *
083             * @return the ID of this journal structure
084             */
085            public long getId();
086    
087            /**
088             * Sets the ID of this journal structure.
089             *
090             * @param id the ID of this journal structure
091             */
092            public void setId(long id);
093    
094            /**
095             * Gets the group ID of this journal structure.
096             *
097             * @return the group ID of this journal structure
098             */
099            public long getGroupId();
100    
101            /**
102             * Sets the group ID of this journal structure.
103             *
104             * @param groupId the group ID of this journal structure
105             */
106            public void setGroupId(long groupId);
107    
108            /**
109             * Gets the company ID of this journal structure.
110             *
111             * @return the company ID of this journal structure
112             */
113            public long getCompanyId();
114    
115            /**
116             * Sets the company ID of this journal structure.
117             *
118             * @param companyId the company ID of this journal structure
119             */
120            public void setCompanyId(long companyId);
121    
122            /**
123             * Gets the user ID of this journal structure.
124             *
125             * @return the user ID of this journal structure
126             */
127            public long getUserId();
128    
129            /**
130             * Sets the user ID of this journal structure.
131             *
132             * @param userId the user ID of this journal structure
133             */
134            public void setUserId(long userId);
135    
136            /**
137             * Gets the user uuid of this journal structure.
138             *
139             * @return the user uuid of this journal structure
140             * @throws SystemException if a system exception occurred
141             */
142            public String getUserUuid() throws SystemException;
143    
144            /**
145             * Sets the user uuid of this journal structure.
146             *
147             * @param userUuid the user uuid of this journal structure
148             */
149            public void setUserUuid(String userUuid);
150    
151            /**
152             * Gets the user name of this journal structure.
153             *
154             * @return the user name of this journal structure
155             */
156            @AutoEscape
157            public String getUserName();
158    
159            /**
160             * Sets the user name of this journal structure.
161             *
162             * @param userName the user name of this journal structure
163             */
164            public void setUserName(String userName);
165    
166            /**
167             * Gets the create date of this journal structure.
168             *
169             * @return the create date of this journal structure
170             */
171            public Date getCreateDate();
172    
173            /**
174             * Sets the create date of this journal structure.
175             *
176             * @param createDate the create date of this journal structure
177             */
178            public void setCreateDate(Date createDate);
179    
180            /**
181             * Gets the modified date of this journal structure.
182             *
183             * @return the modified date of this journal structure
184             */
185            public Date getModifiedDate();
186    
187            /**
188             * Sets the modified date of this journal structure.
189             *
190             * @param modifiedDate the modified date of this journal structure
191             */
192            public void setModifiedDate(Date modifiedDate);
193    
194            /**
195             * Gets the structure ID of this journal structure.
196             *
197             * @return the structure ID of this journal structure
198             */
199            public String getStructureId();
200    
201            /**
202             * Sets the structure ID of this journal structure.
203             *
204             * @param structureId the structure ID of this journal structure
205             */
206            public void setStructureId(String structureId);
207    
208            /**
209             * Gets the parent structure ID of this journal structure.
210             *
211             * @return the parent structure ID of this journal structure
212             */
213            @AutoEscape
214            public String getParentStructureId();
215    
216            /**
217             * Sets the parent structure ID of this journal structure.
218             *
219             * @param parentStructureId the parent structure ID of this journal structure
220             */
221            public void setParentStructureId(String parentStructureId);
222    
223            /**
224             * Gets the name of this journal structure.
225             *
226             * @return the name of this journal structure
227             */
228            @AutoEscape
229            public String getName();
230    
231            /**
232             * Sets the name of this journal structure.
233             *
234             * @param name the name of this journal structure
235             */
236            public void setName(String name);
237    
238            /**
239             * Gets the description of this journal structure.
240             *
241             * @return the description of this journal structure
242             */
243            @AutoEscape
244            public String getDescription();
245    
246            /**
247             * Sets the description of this journal structure.
248             *
249             * @param description the description of this journal structure
250             */
251            public void setDescription(String description);
252    
253            /**
254             * Gets the xsd of this journal structure.
255             *
256             * @return the xsd of this journal structure
257             */
258            @AutoEscape
259            public String getXsd();
260    
261            /**
262             * Sets the xsd of this journal structure.
263             *
264             * @param xsd the xsd of this journal structure
265             */
266            public void setXsd(String xsd);
267    
268            public boolean isNew();
269    
270            public void setNew(boolean n);
271    
272            public boolean isCachedModel();
273    
274            public void setCachedModel(boolean cachedModel);
275    
276            public boolean isEscapedModel();
277    
278            public void setEscapedModel(boolean escapedModel);
279    
280            public Serializable getPrimaryKeyObj();
281    
282            public void setPrimaryKeyObj(Serializable primaryKeyObj);
283    
284            public ExpandoBridge getExpandoBridge();
285    
286            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
287    
288            public Object clone();
289    
290            public int compareTo(JournalStructure journalStructure);
291    
292            public int hashCode();
293    
294            public CacheModel<JournalStructure> toCacheModel();
295    
296            public JournalStructure toEscapedModel();
297    
298            public String toString();
299    
300            public String toXmlString();
301    }