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