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