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