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.journal.model;
016    
017    import com.liferay.portal.LocaleException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.service.ServiceContext;
020    import com.liferay.portlet.expando.model.ExpandoBridge;
021    
022    import java.io.Serializable;
023    
024    import java.util.Date;
025    import java.util.Locale;
026    import java.util.Map;
027    
028    /**
029     * @author Brian Wing Shun Chan
030     * @author Marcellus Tavares
031     */
032    public interface JournalStructure
033            extends Cloneable, Comparable<JournalStructure>, Serializable {
034    
035            public Object clone();
036    
037            @Override
038            public boolean equals(Object obj);
039    
040            public long getCompanyId();
041    
042            public Date getCreateDate();
043    
044            public String getDescription();
045    
046            public String getDescription(Locale locale);
047    
048            public String getDescription(Locale locale, boolean useDefault);
049    
050            public String getDescription(String languageId);
051    
052            public String getDescription(String languageId, boolean useDefault);
053    
054            public String getDescriptionCurrentLanguageId();
055    
056            public String getDescriptionCurrentValue();
057    
058            public Map<Locale, String> getDescriptionMap();
059    
060            public ExpandoBridge getExpandoBridge();
061    
062            public long getGroupId();
063    
064            public long getId();
065    
066            public String getMergedXsd();
067    
068            public Map<String, Object> getModelAttributes();
069    
070            public Class<?> getModelClass();
071    
072            public String getModelClassName();
073    
074            public Date getModifiedDate();
075    
076            public String getName();
077    
078            public String getName(Locale locale);
079    
080            public String getName(Locale locale, boolean useDefault);
081    
082            public String getName(String languageId);
083    
084            public String getName(String languageId, boolean useDefault);
085    
086            public String getNameCurrentLanguageId();
087    
088            public String getNameCurrentValue();
089    
090            public Map<Locale, String> getNameMap();
091    
092            public String getParentStructureId();
093    
094            public long getPrimaryKey();
095    
096            public Serializable getPrimaryKeyObj();
097    
098            public String getStructureId();
099    
100            public long getUserId();
101    
102            public String getUserName();
103    
104            public String getUserUuid() throws SystemException;
105    
106            public String getUuid();
107    
108            public String getXsd();
109    
110            @Override
111            public int hashCode();
112    
113            public boolean isNew();
114    
115            public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
116                    throws LocaleException;
117    
118            public void setCompanyId(long companyId);
119    
120            public void setCreateDate(Date createDate);
121    
122            public void setDescription(String description);
123    
124            public void setDescription(String description, Locale locale);
125    
126            public void setDescription(
127                    String description, Locale locale, Locale defaultLocale);
128    
129            public void setDescriptionCurrentLanguageId(String languageId);
130    
131            public void setDescriptionMap(Map<Locale, String> descriptionMap);
132    
133            public void setDescriptionMap(
134                    Map<Locale, String> descriptionMap, Locale defaultLocale);
135    
136            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
137    
138            public void setExpandoBridgeAttributes(JournalStructure journalStructure);
139    
140            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
141    
142            public void setGroupId(long groupId);
143    
144            public void setId(long id);
145    
146            public void setModelAttributes(Map<String, Object> attributes);
147    
148            public void setModifiedDate(Date modifiedDate);
149    
150            public void setName(String name);
151    
152            public void setName(String name, Locale locale);
153    
154            public void setName(String name, Locale locale, Locale defaultLocale);
155    
156            public void setNameCurrentLanguageId(String languageId);
157    
158            public void setNameMap(Map<Locale, String> nameMap);
159    
160            public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale);
161    
162            public void setNew(boolean n);
163    
164            public void setParentStructureId(String parentStructureId);
165    
166            public void setPrimaryKey(long primaryKey);
167    
168            public void setPrimaryKeyObj(Serializable primaryKeyObj);
169    
170            public void setStructureId(String structureId);
171    
172            public void setUserId(long userId);
173    
174            public void setUserName(String userName);
175    
176            public void setUserUuid(String userUuid);
177    
178            public void setUuid(String uuid);
179    
180            public void setXsd(String xsd);
181    
182    }