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