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 version user ID of this d d m structure.
186             *
187             * @return the version user ID of this d d m structure
188             */
189            public long getVersionUserId();
190    
191            /**
192             * Sets the version user ID of this d d m structure.
193             *
194             * @param versionUserId the version user ID of this d d m structure
195             */
196            public void setVersionUserId(long versionUserId);
197    
198            /**
199             * Returns the version user uuid of this d d m structure.
200             *
201             * @return the version user uuid of this d d m structure
202             */
203            public String getVersionUserUuid();
204    
205            /**
206             * Sets the version user uuid of this d d m structure.
207             *
208             * @param versionUserUuid the version user uuid of this d d m structure
209             */
210            public void setVersionUserUuid(String versionUserUuid);
211    
212            /**
213             * Returns the version user name of this d d m structure.
214             *
215             * @return the version user name of this d d m structure
216             */
217            @AutoEscape
218            public String getVersionUserName();
219    
220            /**
221             * Sets the version user name of this d d m structure.
222             *
223             * @param versionUserName the version user name of this d d m structure
224             */
225            public void setVersionUserName(String versionUserName);
226    
227            /**
228             * Returns the create date of this d d m structure.
229             *
230             * @return the create date of this d d m structure
231             */
232            @Override
233            public Date getCreateDate();
234    
235            /**
236             * Sets the create date of this d d m structure.
237             *
238             * @param createDate the create date of this d d m structure
239             */
240            @Override
241            public void setCreateDate(Date createDate);
242    
243            /**
244             * Returns the modified date of this d d m structure.
245             *
246             * @return the modified date of this d d m structure
247             */
248            @Override
249            public Date getModifiedDate();
250    
251            /**
252             * Sets the modified date of this d d m structure.
253             *
254             * @param modifiedDate the modified date of this d d m structure
255             */
256            @Override
257            public void setModifiedDate(Date modifiedDate);
258    
259            /**
260             * Returns the parent structure ID of this d d m structure.
261             *
262             * @return the parent structure ID of this d d m structure
263             */
264            public long getParentStructureId();
265    
266            /**
267             * Sets the parent structure ID of this d d m structure.
268             *
269             * @param parentStructureId the parent structure ID of this d d m structure
270             */
271            public void setParentStructureId(long parentStructureId);
272    
273            /**
274             * Returns the fully qualified class name of this d d m structure.
275             *
276             * @return the fully qualified class name of this d d m structure
277             */
278            @Override
279            public String getClassName();
280    
281            public void setClassName(String className);
282    
283            /**
284             * Returns the class name ID of this d d m structure.
285             *
286             * @return the class name ID of this d d m structure
287             */
288            @Override
289            public long getClassNameId();
290    
291            /**
292             * Sets the class name ID of this d d m structure.
293             *
294             * @param classNameId the class name ID of this d d m structure
295             */
296            @Override
297            public void setClassNameId(long classNameId);
298    
299            /**
300             * Returns the structure key of this d d m structure.
301             *
302             * @return the structure key of this d d m structure
303             */
304            public String getStructureKey();
305    
306            /**
307             * Sets the structure key of this d d m structure.
308             *
309             * @param structureKey the structure key of this d d m structure
310             */
311            public void setStructureKey(String structureKey);
312    
313            /**
314             * Returns the version of this d d m structure.
315             *
316             * @return the version of this d d m structure
317             */
318            @AutoEscape
319            public String getVersion();
320    
321            /**
322             * Sets the version of this d d m structure.
323             *
324             * @param version the version of this d d m structure
325             */
326            public void setVersion(String version);
327    
328            /**
329             * Returns the name of this d d m structure.
330             *
331             * @return the name of this d d m structure
332             */
333            public String getName();
334    
335            /**
336             * 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.
337             *
338             * @param locale the locale of the language
339             * @return the localized name of this d d m structure
340             */
341            @AutoEscape
342            public String getName(Locale locale);
343    
344            /**
345             * 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.
346             *
347             * @param locale the local of the language
348             * @param useDefault whether to use the default language if no localization exists for the requested language
349             * @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.
350             */
351            @AutoEscape
352            public String getName(Locale locale, boolean useDefault);
353    
354            /**
355             * 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.
356             *
357             * @param languageId the ID of the language
358             * @return the localized name of this d d m structure
359             */
360            @AutoEscape
361            public String getName(String languageId);
362    
363            /**
364             * 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.
365             *
366             * @param languageId the ID of the language
367             * @param useDefault whether to use the default language if no localization exists for the requested language
368             * @return the localized name of this d d m structure
369             */
370            @AutoEscape
371            public String getName(String languageId, boolean useDefault);
372    
373            @AutoEscape
374            public String getNameCurrentLanguageId();
375    
376            @AutoEscape
377            public String getNameCurrentValue();
378    
379            /**
380             * Returns a map of the locales and localized names of this d d m structure.
381             *
382             * @return the locales and localized names of this d d m structure
383             */
384            public Map<Locale, String> getNameMap();
385    
386            /**
387             * Sets the name of this d d m structure.
388             *
389             * @param name the name of this d d m structure
390             */
391            public void setName(String name);
392    
393            /**
394             * Sets the localized name of this d d m structure in the language.
395             *
396             * @param name the localized name of this d d m structure
397             * @param locale the locale of the language
398             */
399            public void setName(String name, Locale locale);
400    
401            /**
402             * Sets the localized name of this d d m structure in the language, and sets the default locale.
403             *
404             * @param name the localized name of this d d m structure
405             * @param locale the locale of the language
406             * @param defaultLocale the default locale
407             */
408            public void setName(String name, Locale locale, Locale defaultLocale);
409    
410            public void setNameCurrentLanguageId(String languageId);
411    
412            /**
413             * Sets the localized names of this d d m structure from the map of locales and localized names.
414             *
415             * @param nameMap the locales and localized names of this d d m structure
416             */
417            public void setNameMap(Map<Locale, String> nameMap);
418    
419            /**
420             * Sets the localized names of this d d m structure from the map of locales and localized names, and sets the default locale.
421             *
422             * @param nameMap the locales and localized names of this d d m structure
423             * @param defaultLocale the default locale
424             */
425            public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale);
426    
427            /**
428             * Returns the description of this d d m structure.
429             *
430             * @return the description of this d d m structure
431             */
432            public String getDescription();
433    
434            /**
435             * 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.
436             *
437             * @param locale the locale of the language
438             * @return the localized description of this d d m structure
439             */
440            @AutoEscape
441            public String getDescription(Locale locale);
442    
443            /**
444             * 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.
445             *
446             * @param locale the local of the language
447             * @param useDefault whether to use the default language if no localization exists for the requested language
448             * @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.
449             */
450            @AutoEscape
451            public String getDescription(Locale locale, boolean useDefault);
452    
453            /**
454             * 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.
455             *
456             * @param languageId the ID of the language
457             * @return the localized description of this d d m structure
458             */
459            @AutoEscape
460            public String getDescription(String languageId);
461    
462            /**
463             * 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.
464             *
465             * @param languageId the ID of the language
466             * @param useDefault whether to use the default language if no localization exists for the requested language
467             * @return the localized description of this d d m structure
468             */
469            @AutoEscape
470            public String getDescription(String languageId, boolean useDefault);
471    
472            @AutoEscape
473            public String getDescriptionCurrentLanguageId();
474    
475            @AutoEscape
476            public String getDescriptionCurrentValue();
477    
478            /**
479             * Returns a map of the locales and localized descriptions of this d d m structure.
480             *
481             * @return the locales and localized descriptions of this d d m structure
482             */
483            public Map<Locale, String> getDescriptionMap();
484    
485            /**
486             * Sets the description of this d d m structure.
487             *
488             * @param description the description of this d d m structure
489             */
490            public void setDescription(String description);
491    
492            /**
493             * Sets the localized description of this d d m structure in the language.
494             *
495             * @param description the localized description of this d d m structure
496             * @param locale the locale of the language
497             */
498            public void setDescription(String description, Locale locale);
499    
500            /**
501             * Sets the localized description of this d d m structure in the language, and sets the default locale.
502             *
503             * @param description the localized description of this d d m structure
504             * @param locale the locale of the language
505             * @param defaultLocale the default locale
506             */
507            public void setDescription(String description, Locale locale,
508                    Locale defaultLocale);
509    
510            public void setDescriptionCurrentLanguageId(String languageId);
511    
512            /**
513             * Sets the localized descriptions of this d d m structure from the map of locales and localized descriptions.
514             *
515             * @param descriptionMap the locales and localized descriptions of this d d m structure
516             */
517            public void setDescriptionMap(Map<Locale, String> descriptionMap);
518    
519            /**
520             * Sets the localized descriptions of this d d m structure from the map of locales and localized descriptions, and sets the default locale.
521             *
522             * @param descriptionMap the locales and localized descriptions of this d d m structure
523             * @param defaultLocale the default locale
524             */
525            public void setDescriptionMap(Map<Locale, String> descriptionMap,
526                    Locale defaultLocale);
527    
528            /**
529             * Returns the definition of this d d m structure.
530             *
531             * @return the definition of this d d m structure
532             */
533            @AutoEscape
534            public String getDefinition();
535    
536            /**
537             * Sets the definition of this d d m structure.
538             *
539             * @param definition the definition of this d d m structure
540             */
541            public void setDefinition(String definition);
542    
543            /**
544             * Returns the storage type of this d d m structure.
545             *
546             * @return the storage type of this d d m structure
547             */
548            @AutoEscape
549            public String getStorageType();
550    
551            /**
552             * Sets the storage type of this d d m structure.
553             *
554             * @param storageType the storage type of this d d m structure
555             */
556            public void setStorageType(String storageType);
557    
558            /**
559             * Returns the type of this d d m structure.
560             *
561             * @return the type of this d d m structure
562             */
563            public int getType();
564    
565            /**
566             * Sets the type of this d d m structure.
567             *
568             * @param type the type of this d d m structure
569             */
570            public void setType(int type);
571    
572            @Override
573            public boolean isNew();
574    
575            @Override
576            public void setNew(boolean n);
577    
578            @Override
579            public boolean isCachedModel();
580    
581            @Override
582            public void setCachedModel(boolean cachedModel);
583    
584            @Override
585            public boolean isEscapedModel();
586    
587            @Override
588            public Serializable getPrimaryKeyObj();
589    
590            @Override
591            public void setPrimaryKeyObj(Serializable primaryKeyObj);
592    
593            @Override
594            public ExpandoBridge getExpandoBridge();
595    
596            @Override
597            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
598    
599            @Override
600            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
601    
602            @Override
603            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
604    
605            @Override
606            public String[] getAvailableLanguageIds();
607    
608            @Override
609            public String getDefaultLanguageId();
610    
611            @Override
612            public void prepareLocalizedFieldsForImport() throws LocaleException;
613    
614            @Override
615            public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
616                    throws LocaleException;
617    
618            @Override
619            public Object clone();
620    
621            @Override
622            public int compareTo(
623                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure);
624    
625            @Override
626            public int hashCode();
627    
628            @Override
629            public CacheModel<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> toCacheModel();
630    
631            @Override
632            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure toEscapedModel();
633    
634            @Override
635            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure toUnescapedModel();
636    
637            @Override
638            public String toString();
639    
640            @Override
641            public String toXmlString();
642    }