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