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.dynamicdatamapping.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.StagedGroupedModel;
023    import com.liferay.portal.service.ServiceContext;
024    
025    import com.liferay.portlet.expando.model.ExpandoBridge;
026    
027    import java.io.Serializable;
028    
029    import java.util.Date;
030    import java.util.Locale;
031    import java.util.Map;
032    
033    /**
034     * The base model interface for the DDMContent service. Represents a row in the "DDMContent" database table, with each column mapped to a property of this class.
035     *
036     * <p>
037     * This interface and its corresponding implementation {@link com.liferay.portlet.dynamicdatamapping.model.impl.DDMContentModelImpl} 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.dynamicdatamapping.model.impl.DDMContentImpl}.
038     * </p>
039     *
040     * @author Brian Wing Shun Chan
041     * @see DDMContent
042     * @see com.liferay.portlet.dynamicdatamapping.model.impl.DDMContentImpl
043     * @see com.liferay.portlet.dynamicdatamapping.model.impl.DDMContentModelImpl
044     * @generated
045     */
046    public interface DDMContentModel extends BaseModel<DDMContent>,
047            StagedGroupedModel {
048            /*
049             * NOTE FOR DEVELOPERS:
050             *
051             * Never modify or reference this interface directly. All methods that expect a d d m content model instance should use the {@link DDMContent} interface instead.
052             */
053    
054            /**
055             * Returns the primary key of this d d m content.
056             *
057             * @return the primary key of this d d m content
058             */
059            public long getPrimaryKey();
060    
061            /**
062             * Sets the primary key of this d d m content.
063             *
064             * @param primaryKey the primary key of this d d m content
065             */
066            public void setPrimaryKey(long primaryKey);
067    
068            /**
069             * Returns the uuid of this d d m content.
070             *
071             * @return the uuid of this d d m content
072             */
073            @AutoEscape
074            public String getUuid();
075    
076            /**
077             * Sets the uuid of this d d m content.
078             *
079             * @param uuid the uuid of this d d m content
080             */
081            public void setUuid(String uuid);
082    
083            /**
084             * Returns the content ID of this d d m content.
085             *
086             * @return the content ID of this d d m content
087             */
088            public long getContentId();
089    
090            /**
091             * Sets the content ID of this d d m content.
092             *
093             * @param contentId the content ID of this d d m content
094             */
095            public void setContentId(long contentId);
096    
097            /**
098             * Returns the group ID of this d d m content.
099             *
100             * @return the group ID of this d d m content
101             */
102            public long getGroupId();
103    
104            /**
105             * Sets the group ID of this d d m content.
106             *
107             * @param groupId the group ID of this d d m content
108             */
109            public void setGroupId(long groupId);
110    
111            /**
112             * Returns the company ID of this d d m content.
113             *
114             * @return the company ID of this d d m content
115             */
116            public long getCompanyId();
117    
118            /**
119             * Sets the company ID of this d d m content.
120             *
121             * @param companyId the company ID of this d d m content
122             */
123            public void setCompanyId(long companyId);
124    
125            /**
126             * Returns the user ID of this d d m content.
127             *
128             * @return the user ID of this d d m content
129             */
130            public long getUserId();
131    
132            /**
133             * Sets the user ID of this d d m content.
134             *
135             * @param userId the user ID of this d d m content
136             */
137            public void setUserId(long userId);
138    
139            /**
140             * Returns the user uuid of this d d m content.
141             *
142             * @return the user uuid of this d d m content
143             * @throws SystemException if a system exception occurred
144             */
145            public String getUserUuid() throws SystemException;
146    
147            /**
148             * Sets the user uuid of this d d m content.
149             *
150             * @param userUuid the user uuid of this d d m content
151             */
152            public void setUserUuid(String userUuid);
153    
154            /**
155             * Returns the user name of this d d m content.
156             *
157             * @return the user name of this d d m content
158             */
159            @AutoEscape
160            public String getUserName();
161    
162            /**
163             * Sets the user name of this d d m content.
164             *
165             * @param userName the user name of this d d m content
166             */
167            public void setUserName(String userName);
168    
169            /**
170             * Returns the create date of this d d m content.
171             *
172             * @return the create date of this d d m content
173             */
174            public Date getCreateDate();
175    
176            /**
177             * Sets the create date of this d d m content.
178             *
179             * @param createDate the create date of this d d m content
180             */
181            public void setCreateDate(Date createDate);
182    
183            /**
184             * Returns the modified date of this d d m content.
185             *
186             * @return the modified date of this d d m content
187             */
188            public Date getModifiedDate();
189    
190            /**
191             * Sets the modified date of this d d m content.
192             *
193             * @param modifiedDate the modified date of this d d m content
194             */
195            public void setModifiedDate(Date modifiedDate);
196    
197            /**
198             * Returns the name of this d d m content.
199             *
200             * @return the name of this d d m content
201             */
202            public String getName();
203    
204            /**
205             * Returns the localized name of this d d m content in the language. Uses the default language if no localization exists for the requested language.
206             *
207             * @param locale the locale of the language
208             * @return the localized name of this d d m content
209             */
210            @AutoEscape
211            public String getName(Locale locale);
212    
213            /**
214             * Returns the localized name of this d d m content in the language, optionally using the default language if no localization exists for the requested language.
215             *
216             * @param locale the local of the language
217             * @param useDefault whether to use the default language if no localization exists for the requested language
218             * @return the localized name of this d d m content. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned.
219             */
220            @AutoEscape
221            public String getName(Locale locale, boolean useDefault);
222    
223            /**
224             * Returns the localized name of this d d m content in the language. Uses the default language if no localization exists for the requested language.
225             *
226             * @param languageId the ID of the language
227             * @return the localized name of this d d m content
228             */
229            @AutoEscape
230            public String getName(String languageId);
231    
232            /**
233             * Returns the localized name of this d d m content in the language, optionally using the default language if no localization exists for the requested language.
234             *
235             * @param languageId the ID of the language
236             * @param useDefault whether to use the default language if no localization exists for the requested language
237             * @return the localized name of this d d m content
238             */
239            @AutoEscape
240            public String getName(String languageId, boolean useDefault);
241    
242            @AutoEscape
243            public String getNameCurrentLanguageId();
244    
245            @AutoEscape
246            public String getNameCurrentValue();
247    
248            /**
249             * Returns a map of the locales and localized names of this d d m content.
250             *
251             * @return the locales and localized names of this d d m content
252             */
253            public Map<Locale, String> getNameMap();
254    
255            /**
256             * Sets the name of this d d m content.
257             *
258             * @param name the name of this d d m content
259             */
260            public void setName(String name);
261    
262            /**
263             * Sets the localized name of this d d m content in the language.
264             *
265             * @param name the localized name of this d d m content
266             * @param locale the locale of the language
267             */
268            public void setName(String name, Locale locale);
269    
270            /**
271             * Sets the localized name of this d d m content in the language, and sets the default locale.
272             *
273             * @param name the localized name of this d d m content
274             * @param locale the locale of the language
275             * @param defaultLocale the default locale
276             */
277            public void setName(String name, Locale locale, Locale defaultLocale);
278    
279            public void setNameCurrentLanguageId(String languageId);
280    
281            /**
282             * Sets the localized names of this d d m content from the map of locales and localized names.
283             *
284             * @param nameMap the locales and localized names of this d d m content
285             */
286            public void setNameMap(Map<Locale, String> nameMap);
287    
288            /**
289             * Sets the localized names of this d d m content from the map of locales and localized names, and sets the default locale.
290             *
291             * @param nameMap the locales and localized names of this d d m content
292             * @param defaultLocale the default locale
293             */
294            public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale);
295    
296            /**
297             * Returns the description of this d d m content.
298             *
299             * @return the description of this d d m content
300             */
301            @AutoEscape
302            public String getDescription();
303    
304            /**
305             * Sets the description of this d d m content.
306             *
307             * @param description the description of this d d m content
308             */
309            public void setDescription(String description);
310    
311            /**
312             * Returns the xml of this d d m content.
313             *
314             * @return the xml of this d d m content
315             */
316            @AutoEscape
317            public String getXml();
318    
319            /**
320             * Sets the xml of this d d m content.
321             *
322             * @param xml the xml of this d d m content
323             */
324            public void setXml(String xml);
325    
326            public boolean isNew();
327    
328            public void setNew(boolean n);
329    
330            public boolean isCachedModel();
331    
332            public void setCachedModel(boolean cachedModel);
333    
334            public boolean isEscapedModel();
335    
336            public Serializable getPrimaryKeyObj();
337    
338            public void setPrimaryKeyObj(Serializable primaryKeyObj);
339    
340            public ExpandoBridge getExpandoBridge();
341    
342            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
343    
344            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
345    
346            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
347    
348            public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
349                    throws LocaleException;
350    
351            public Object clone();
352    
353            public int compareTo(DDMContent ddmContent);
354    
355            public int hashCode();
356    
357            public CacheModel<DDMContent> toCacheModel();
358    
359            public DDMContent toEscapedModel();
360    
361            public DDMContent toUnescapedModel();
362    
363            public String toString();
364    
365            public String toXmlString();
366    }