001    /**
002     * Copyright (c) 2000-2012 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.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    import java.util.Locale;
030    import java.util.Map;
031    
032    /**
033     * 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.
034     *
035     * <p>
036     * 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}.
037     * </p>
038     *
039     * @author Brian Wing Shun Chan
040     * @see JournalStructure
041     * @see com.liferay.portlet.journal.model.impl.JournalStructureImpl
042     * @see com.liferay.portlet.journal.model.impl.JournalStructureModelImpl
043     * @generated
044     */
045    public interface JournalStructureModel extends BaseModel<JournalStructure>,
046            GroupedModel {
047            /*
048             * NOTE FOR DEVELOPERS:
049             *
050             * Never modify or reference this interface directly. All methods that expect a journal structure model instance should use the {@link JournalStructure} interface instead.
051             */
052    
053            /**
054             * Returns the primary key of this journal structure.
055             *
056             * @return the primary key of this journal structure
057             */
058            public long getPrimaryKey();
059    
060            /**
061             * Sets the primary key of this journal structure.
062             *
063             * @param primaryKey the primary key of this journal structure
064             */
065            public void setPrimaryKey(long primaryKey);
066    
067            /**
068             * Returns the uuid of this journal structure.
069             *
070             * @return the uuid of this journal structure
071             */
072            @AutoEscape
073            public String getUuid();
074    
075            /**
076             * Sets the uuid of this journal structure.
077             *
078             * @param uuid the uuid of this journal structure
079             */
080            public void setUuid(String uuid);
081    
082            /**
083             * Returns the ID of this journal structure.
084             *
085             * @return the ID of this journal structure
086             */
087            public long getId();
088    
089            /**
090             * Sets the ID of this journal structure.
091             *
092             * @param id the ID of this journal structure
093             */
094            public void setId(long id);
095    
096            /**
097             * Returns the group ID of this journal structure.
098             *
099             * @return the group ID of this journal structure
100             */
101            public long getGroupId();
102    
103            /**
104             * Sets the group ID of this journal structure.
105             *
106             * @param groupId the group ID of this journal structure
107             */
108            public void setGroupId(long groupId);
109    
110            /**
111             * Returns the company ID of this journal structure.
112             *
113             * @return the company ID of this journal structure
114             */
115            public long getCompanyId();
116    
117            /**
118             * Sets the company ID of this journal structure.
119             *
120             * @param companyId the company ID of this journal structure
121             */
122            public void setCompanyId(long companyId);
123    
124            /**
125             * Returns the user ID of this journal structure.
126             *
127             * @return the user ID of this journal structure
128             */
129            public long getUserId();
130    
131            /**
132             * Sets the user ID of this journal structure.
133             *
134             * @param userId the user ID of this journal structure
135             */
136            public void setUserId(long userId);
137    
138            /**
139             * Returns the user uuid of this journal structure.
140             *
141             * @return the user uuid of this journal structure
142             * @throws SystemException if a system exception occurred
143             */
144            public String getUserUuid() throws SystemException;
145    
146            /**
147             * Sets the user uuid of this journal structure.
148             *
149             * @param userUuid the user uuid of this journal structure
150             */
151            public void setUserUuid(String userUuid);
152    
153            /**
154             * Returns the user name of this journal structure.
155             *
156             * @return the user name of this journal structure
157             */
158            @AutoEscape
159            public String getUserName();
160    
161            /**
162             * Sets the user name of this journal structure.
163             *
164             * @param userName the user name of this journal structure
165             */
166            public void setUserName(String userName);
167    
168            /**
169             * Returns the create date of this journal structure.
170             *
171             * @return the create date of this journal structure
172             */
173            public Date getCreateDate();
174    
175            /**
176             * Sets the create date of this journal structure.
177             *
178             * @param createDate the create date of this journal structure
179             */
180            public void setCreateDate(Date createDate);
181    
182            /**
183             * Returns the modified date of this journal structure.
184             *
185             * @return the modified date of this journal structure
186             */
187            public Date getModifiedDate();
188    
189            /**
190             * Sets the modified date of this journal structure.
191             *
192             * @param modifiedDate the modified date of this journal structure
193             */
194            public void setModifiedDate(Date modifiedDate);
195    
196            /**
197             * Returns the structure ID of this journal structure.
198             *
199             * @return the structure ID of this journal structure
200             */
201            public String getStructureId();
202    
203            /**
204             * Sets the structure ID of this journal structure.
205             *
206             * @param structureId the structure ID of this journal structure
207             */
208            public void setStructureId(String structureId);
209    
210            /**
211             * Returns the parent structure ID of this journal structure.
212             *
213             * @return the parent structure ID of this journal structure
214             */
215            @AutoEscape
216            public String getParentStructureId();
217    
218            /**
219             * Sets the parent structure ID of this journal structure.
220             *
221             * @param parentStructureId the parent structure ID of this journal structure
222             */
223            public void setParentStructureId(String parentStructureId);
224    
225            /**
226             * Returns the name of this journal structure.
227             *
228             * @return the name of this journal structure
229             */
230            public String getName();
231    
232            /**
233             * Returns the localized name of this journal structure in the language. Uses the default language if no localization exists for the requested language.
234             *
235             * @param locale the locale of the language
236             * @return the localized name of this journal structure
237             */
238            @AutoEscape
239            public String getName(Locale locale);
240    
241            /**
242             * Returns the localized name of this journal structure in the language, optionally using the default language if no localization exists for the requested language.
243             *
244             * @param locale the local of the language
245             * @param useDefault whether to use the default language if no localization exists for the requested language
246             * @return the localized name of this journal structure. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned.
247             */
248            @AutoEscape
249            public String getName(Locale locale, boolean useDefault);
250    
251            /**
252             * Returns the localized name of this journal structure in the language. Uses the default language if no localization exists for the requested language.
253             *
254             * @param languageId the ID of the language
255             * @return the localized name of this journal structure
256             */
257            @AutoEscape
258            public String getName(String languageId);
259    
260            /**
261             * Returns the localized name of this journal structure in the language, optionally using the default language if no localization exists for the requested language.
262             *
263             * @param languageId the ID of the language
264             * @param useDefault whether to use the default language if no localization exists for the requested language
265             * @return the localized name of this journal structure
266             */
267            @AutoEscape
268            public String getName(String languageId, boolean useDefault);
269    
270            @AutoEscape
271            public String getNameCurrentLanguageId();
272    
273            @AutoEscape
274            public String getNameCurrentValue();
275    
276            /**
277             * Returns a map of the locales and localized names of this journal structure.
278             *
279             * @return the locales and localized names of this journal structure
280             */
281            public Map<Locale, String> getNameMap();
282    
283            /**
284             * Sets the name of this journal structure.
285             *
286             * @param name the name of this journal structure
287             */
288            public void setName(String name);
289    
290            /**
291             * Sets the localized name of this journal structure in the language.
292             *
293             * @param name the localized name of this journal structure
294             * @param locale the locale of the language
295             */
296            public void setName(String name, Locale locale);
297    
298            /**
299             * Sets the localized name of this journal structure in the language, and sets the default locale.
300             *
301             * @param name the localized name of this journal structure
302             * @param locale the locale of the language
303             * @param defaultLocale the default locale
304             */
305            public void setName(String name, Locale locale, Locale defaultLocale);
306    
307            public void setNameCurrentLanguageId(String languageId);
308    
309            /**
310             * Sets the localized names of this journal structure from the map of locales and localized names.
311             *
312             * @param nameMap the locales and localized names of this journal structure
313             */
314            public void setNameMap(Map<Locale, String> nameMap);
315    
316            /**
317             * Sets the localized names of this journal structure from the map of locales and localized names, and sets the default locale.
318             *
319             * @param nameMap the locales and localized names of this journal structure
320             * @param defaultLocale the default locale
321             */
322            public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale);
323    
324            /**
325             * Returns the description of this journal structure.
326             *
327             * @return the description of this journal structure
328             */
329            public String getDescription();
330    
331            /**
332             * Returns the localized description of this journal structure in the language. Uses the default language if no localization exists for the requested language.
333             *
334             * @param locale the locale of the language
335             * @return the localized description of this journal structure
336             */
337            @AutoEscape
338            public String getDescription(Locale locale);
339    
340            /**
341             * Returns the localized description of this journal structure in the language, optionally using the default language if no localization exists for the requested language.
342             *
343             * @param locale the local of the language
344             * @param useDefault whether to use the default language if no localization exists for the requested language
345             * @return the localized description of this journal structure. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned.
346             */
347            @AutoEscape
348            public String getDescription(Locale locale, boolean useDefault);
349    
350            /**
351             * Returns the localized description of this journal structure in the language. Uses the default language if no localization exists for the requested language.
352             *
353             * @param languageId the ID of the language
354             * @return the localized description of this journal structure
355             */
356            @AutoEscape
357            public String getDescription(String languageId);
358    
359            /**
360             * Returns the localized description of this journal structure in the language, optionally using the default language if no localization exists for the requested language.
361             *
362             * @param languageId the ID of the language
363             * @param useDefault whether to use the default language if no localization exists for the requested language
364             * @return the localized description of this journal structure
365             */
366            @AutoEscape
367            public String getDescription(String languageId, boolean useDefault);
368    
369            @AutoEscape
370            public String getDescriptionCurrentLanguageId();
371    
372            @AutoEscape
373            public String getDescriptionCurrentValue();
374    
375            /**
376             * Returns a map of the locales and localized descriptions of this journal structure.
377             *
378             * @return the locales and localized descriptions of this journal structure
379             */
380            public Map<Locale, String> getDescriptionMap();
381    
382            /**
383             * Sets the description of this journal structure.
384             *
385             * @param description the description of this journal structure
386             */
387            public void setDescription(String description);
388    
389            /**
390             * Sets the localized description of this journal structure in the language.
391             *
392             * @param description the localized description of this journal structure
393             * @param locale the locale of the language
394             */
395            public void setDescription(String description, Locale locale);
396    
397            /**
398             * Sets the localized description of this journal structure in the language, and sets the default locale.
399             *
400             * @param description the localized description of this journal structure
401             * @param locale the locale of the language
402             * @param defaultLocale the default locale
403             */
404            public void setDescription(String description, Locale locale,
405                    Locale defaultLocale);
406    
407            public void setDescriptionCurrentLanguageId(String languageId);
408    
409            /**
410             * Sets the localized descriptions of this journal structure from the map of locales and localized descriptions.
411             *
412             * @param descriptionMap the locales and localized descriptions of this journal structure
413             */
414            public void setDescriptionMap(Map<Locale, String> descriptionMap);
415    
416            /**
417             * Sets the localized descriptions of this journal structure from the map of locales and localized descriptions, and sets the default locale.
418             *
419             * @param descriptionMap the locales and localized descriptions of this journal structure
420             * @param defaultLocale the default locale
421             */
422            public void setDescriptionMap(Map<Locale, String> descriptionMap,
423                    Locale defaultLocale);
424    
425            /**
426             * Returns the xsd of this journal structure.
427             *
428             * @return the xsd of this journal structure
429             */
430            @AutoEscape
431            public String getXsd();
432    
433            /**
434             * Sets the xsd of this journal structure.
435             *
436             * @param xsd the xsd of this journal structure
437             */
438            public void setXsd(String xsd);
439    
440            public boolean isNew();
441    
442            public void setNew(boolean n);
443    
444            public boolean isCachedModel();
445    
446            public void setCachedModel(boolean cachedModel);
447    
448            public boolean isEscapedModel();
449    
450            public Serializable getPrimaryKeyObj();
451    
452            public void setPrimaryKeyObj(Serializable primaryKeyObj);
453    
454            public ExpandoBridge getExpandoBridge();
455    
456            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
457    
458            public Object clone();
459    
460            public int compareTo(JournalStructure journalStructure);
461    
462            public int hashCode();
463    
464            public CacheModel<JournalStructure> toCacheModel();
465    
466            public JournalStructure toEscapedModel();
467    
468            public String toString();
469    
470            public String toXmlString();
471    }