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