001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.dynamicdatamapping.model;
016    
017    import com.liferay.portal.LocaleException;
018    import com.liferay.portal.kernel.bean.AutoEscape;
019    import com.liferay.portal.kernel.exception.SystemException;
020    import com.liferay.portal.model.BaseModel;
021    import com.liferay.portal.model.CacheModel;
022    import com.liferay.portal.model.GroupedModel;
023    import com.liferay.portal.service.ServiceContext;
024    
025    import com.liferay.portlet.expando.model.ExpandoBridge;
026    
027    import java.io.Serializable;
028    
029    import java.util.Date;
030    import java.util.Locale;
031    import java.util.Map;
032    
033    /**
034     * The base model interface for the DDMStructure service. Represents a row in the "DDMStructure" database table, with each column mapped to a property of this class.
035     *
036     * <p>
037     * This interface and its corresponding implementation {@link com.liferay.portlet.dynamicdatamapping.model.impl.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}.
038     * </p>
039     *
040     * @author Brian Wing Shun Chan
041     * @see DDMStructure
042     * @see com.liferay.portlet.dynamicdatamapping.model.impl.DDMStructureImpl
043     * @see com.liferay.portlet.dynamicdatamapping.model.impl.DDMStructureModelImpl
044     * @generated
045     */
046    public interface DDMStructureModel extends BaseModel<DDMStructure>, GroupedModel {
047            /*
048             * NOTE FOR DEVELOPERS:
049             *
050             * 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.
051             */
052    
053            /**
054             * Returns the primary key of this d d m structure.
055             *
056             * @return the primary key of this d d m structure
057             */
058            public long getPrimaryKey();
059    
060            /**
061             * Sets the primary key of this d d m structure.
062             *
063             * @param primaryKey the primary key of this d d m structure
064             */
065            public void setPrimaryKey(long primaryKey);
066    
067            /**
068             * Returns the uuid of this d d m structure.
069             *
070             * @return the uuid of this d d m structure
071             */
072            @AutoEscape
073            public String getUuid();
074    
075            /**
076             * Sets the uuid of this d d m structure.
077             *
078             * @param uuid the uuid of this d d m structure
079             */
080            public void setUuid(String uuid);
081    
082            /**
083             * Returns the structure ID of this d d m structure.
084             *
085             * @return the structure ID of this d d m structure
086             */
087            public long getStructureId();
088    
089            /**
090             * Sets the structure ID of this d d m structure.
091             *
092             * @param structureId the structure ID of this d d m structure
093             */
094            public void setStructureId(long structureId);
095    
096            /**
097             * Returns the group ID of this d d m structure.
098             *
099             * @return the group ID of this d d m structure
100             */
101            public long getGroupId();
102    
103            /**
104             * Sets the group ID of this d d m structure.
105             *
106             * @param groupId the group ID of this d d m structure
107             */
108            public void setGroupId(long groupId);
109    
110            /**
111             * Returns the company ID of this d d m structure.
112             *
113             * @return the company ID of this d d m structure
114             */
115            public long getCompanyId();
116    
117            /**
118             * Sets the company ID of this d d m structure.
119             *
120             * @param companyId the company ID of this d d m structure
121             */
122            public void setCompanyId(long companyId);
123    
124            /**
125             * Returns the user ID of this d d m structure.
126             *
127             * @return the user ID of this d d m structure
128             */
129            public long getUserId();
130    
131            /**
132             * Sets the user ID of this d d m structure.
133             *
134             * @param userId the user ID of this d d m structure
135             */
136            public void setUserId(long userId);
137    
138            /**
139             * Returns the user uuid of this d d m structure.
140             *
141             * @return the user uuid of this d d m structure
142             * @throws SystemException if a system exception occurred
143             */
144            public String getUserUuid() throws SystemException;
145    
146            /**
147             * Sets the user uuid of this d d m structure.
148             *
149             * @param userUuid the user uuid of this d d m structure
150             */
151            public void setUserUuid(String userUuid);
152    
153            /**
154             * Returns the user name of this d d m structure.
155             *
156             * @return the user name of this d d m structure
157             */
158            @AutoEscape
159            public String getUserName();
160    
161            /**
162             * Sets the user name of this d d m structure.
163             *
164             * @param userName the user name of this d d m structure
165             */
166            public void setUserName(String userName);
167    
168            /**
169             * Returns the create date of this d d m structure.
170             *
171             * @return the create date of this d d m structure
172             */
173            public Date getCreateDate();
174    
175            /**
176             * Sets the create date of this d d m structure.
177             *
178             * @param createDate the create date of this d d m structure
179             */
180            public void setCreateDate(Date createDate);
181    
182            /**
183             * Returns the modified date of this d d m structure.
184             *
185             * @return the modified date of this d d m structure
186             */
187            public Date getModifiedDate();
188    
189            /**
190             * Sets the modified date of this d d m structure.
191             *
192             * @param modifiedDate the modified date of this d d m structure
193             */
194            public void setModifiedDate(Date modifiedDate);
195    
196            /**
197             * Returns the fully qualified class name of this d d m structure.
198             *
199             * @return the fully qualified class name of this d d m structure
200             */
201            public String getClassName();
202    
203            public void setClassName(String className);
204    
205            /**
206             * Returns the class name ID of this d d m structure.
207             *
208             * @return the class name ID of this d d m structure
209             */
210            public long getClassNameId();
211    
212            /**
213             * Sets the class name ID of this d d m structure.
214             *
215             * @param classNameId the class name ID of this d d m structure
216             */
217            public void setClassNameId(long classNameId);
218    
219            /**
220             * Returns the structure key of this d d m structure.
221             *
222             * @return the structure key of this d d m structure
223             */
224            public String getStructureKey();
225    
226            /**
227             * Sets the structure key of this d d m structure.
228             *
229             * @param structureKey the structure key of this d d m structure
230             */
231            public void setStructureKey(String structureKey);
232    
233            /**
234             * Returns the name of this d d m structure.
235             *
236             * @return the name of this d d m structure
237             */
238            public String getName();
239    
240            /**
241             * 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.
242             *
243             * @param locale the locale of the language
244             * @return the localized name of this d d m structure
245             */
246            @AutoEscape
247            public String getName(Locale locale);
248    
249            /**
250             * 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.
251             *
252             * @param locale the local of the language
253             * @param useDefault whether to use the default language if no localization exists for the requested language
254             * @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.
255             */
256            @AutoEscape
257            public String getName(Locale locale, boolean useDefault);
258    
259            /**
260             * 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.
261             *
262             * @param languageId the ID of the language
263             * @return the localized name of this d d m structure
264             */
265            @AutoEscape
266            public String getName(String languageId);
267    
268            /**
269             * 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.
270             *
271             * @param languageId the ID of the language
272             * @param useDefault whether to use the default language if no localization exists for the requested language
273             * @return the localized name of this d d m structure
274             */
275            @AutoEscape
276            public String getName(String languageId, boolean useDefault);
277    
278            @AutoEscape
279            public String getNameCurrentLanguageId();
280    
281            @AutoEscape
282            public String getNameCurrentValue();
283    
284            /**
285             * Returns a map of the locales and localized names of this d d m structure.
286             *
287             * @return the locales and localized names of this d d m structure
288             */
289            public Map<Locale, String> getNameMap();
290    
291            /**
292             * Sets the name of this d d m structure.
293             *
294             * @param name the name of this d d m structure
295             */
296            public void setName(String name);
297    
298            /**
299             * Sets the localized name of this d d m structure in the language.
300             *
301             * @param name the localized name of this d d m structure
302             * @param locale the locale of the language
303             */
304            public void setName(String name, Locale locale);
305    
306            /**
307             * Sets the localized name of this d d m structure in the language, and sets the default locale.
308             *
309             * @param name the localized name of this d d m structure
310             * @param locale the locale of the language
311             * @param defaultLocale the default locale
312             */
313            public void setName(String name, Locale locale, Locale defaultLocale);
314    
315            public void setNameCurrentLanguageId(String languageId);
316    
317            /**
318             * Sets the localized names of this d d m structure from the map of locales and localized names.
319             *
320             * @param nameMap the locales and localized names of this d d m structure
321             */
322            public void setNameMap(Map<Locale, String> nameMap);
323    
324            /**
325             * Sets the localized names of this d d m structure from the map of locales and localized names, and sets the default locale.
326             *
327             * @param nameMap the locales and localized names of this d d m structure
328             * @param defaultLocale the default locale
329             */
330            public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale);
331    
332            /**
333             * Returns the description of this d d m structure.
334             *
335             * @return the description of this d d m structure
336             */
337            public String getDescription();
338    
339            /**
340             * 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.
341             *
342             * @param locale the locale of the language
343             * @return the localized description of this d d m structure
344             */
345            @AutoEscape
346            public String getDescription(Locale locale);
347    
348            /**
349             * 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.
350             *
351             * @param locale the local of the language
352             * @param useDefault whether to use the default language if no localization exists for the requested language
353             * @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.
354             */
355            @AutoEscape
356            public String getDescription(Locale locale, boolean useDefault);
357    
358            /**
359             * 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.
360             *
361             * @param languageId the ID of the language
362             * @return the localized description of this d d m structure
363             */
364            @AutoEscape
365            public String getDescription(String languageId);
366    
367            /**
368             * 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.
369             *
370             * @param languageId the ID of the language
371             * @param useDefault whether to use the default language if no localization exists for the requested language
372             * @return the localized description of this d d m structure
373             */
374            @AutoEscape
375            public String getDescription(String languageId, boolean useDefault);
376    
377            @AutoEscape
378            public String getDescriptionCurrentLanguageId();
379    
380            @AutoEscape
381            public String getDescriptionCurrentValue();
382    
383            /**
384             * Returns a map of the locales and localized descriptions of this d d m structure.
385             *
386             * @return the locales and localized descriptions of this d d m structure
387             */
388            public Map<Locale, String> getDescriptionMap();
389    
390            /**
391             * Sets the description of this d d m structure.
392             *
393             * @param description the description of this d d m structure
394             */
395            public void setDescription(String description);
396    
397            /**
398             * Sets the localized description of this d d m structure in the language.
399             *
400             * @param description the localized description of this d d m structure
401             * @param locale the locale of the language
402             */
403            public void setDescription(String description, Locale locale);
404    
405            /**
406             * Sets the localized description of this d d m structure in the language, and sets the default locale.
407             *
408             * @param description the localized description of this d d m structure
409             * @param locale the locale of the language
410             * @param defaultLocale the default locale
411             */
412            public void setDescription(String description, Locale locale,
413                    Locale defaultLocale);
414    
415            public void setDescriptionCurrentLanguageId(String languageId);
416    
417            /**
418             * Sets the localized descriptions of this d d m structure from the map of locales and localized descriptions.
419             *
420             * @param descriptionMap the locales and localized descriptions of this d d m structure
421             */
422            public void setDescriptionMap(Map<Locale, String> descriptionMap);
423    
424            /**
425             * Sets the localized descriptions of this d d m structure from the map of locales and localized descriptions, and sets the default locale.
426             *
427             * @param descriptionMap the locales and localized descriptions of this d d m structure
428             * @param defaultLocale the default locale
429             */
430            public void setDescriptionMap(Map<Locale, String> descriptionMap,
431                    Locale defaultLocale);
432    
433            /**
434             * Returns the xsd of this d d m structure.
435             *
436             * @return the xsd of this d d m structure
437             */
438            @AutoEscape
439            public String getXsd();
440    
441            /**
442             * Sets the xsd of this d d m structure.
443             *
444             * @param xsd the xsd of this d d m structure
445             */
446            public void setXsd(String xsd);
447    
448            /**
449             * Returns the storage type of this d d m structure.
450             *
451             * @return the storage type of this d d m structure
452             */
453            @AutoEscape
454            public String getStorageType();
455    
456            /**
457             * Sets the storage type of this d d m structure.
458             *
459             * @param storageType the storage type of this d d m structure
460             */
461            public void setStorageType(String storageType);
462    
463            /**
464             * Returns the type of this d d m structure.
465             *
466             * @return the type of this d d m structure
467             */
468            public int getType();
469    
470            /**
471             * Sets the type of this d d m structure.
472             *
473             * @param type the type of this d d m structure
474             */
475            public void setType(int type);
476    
477            public boolean isNew();
478    
479            public void setNew(boolean n);
480    
481            public boolean isCachedModel();
482    
483            public void setCachedModel(boolean cachedModel);
484    
485            public boolean isEscapedModel();
486    
487            public Serializable getPrimaryKeyObj();
488    
489            public void setPrimaryKeyObj(Serializable primaryKeyObj);
490    
491            public ExpandoBridge getExpandoBridge();
492    
493            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
494    
495            public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
496                    throws LocaleException;
497    
498            public Object clone();
499    
500            public int compareTo(DDMStructure ddmStructure);
501    
502            public int hashCode();
503    
504            public CacheModel<DDMStructure> toCacheModel();
505    
506            public DDMStructure toEscapedModel();
507    
508            public DDMStructure toUnescapedModel();
509    
510            public String toString();
511    
512            public String toXmlString();
513    }