001    /**
002     * Copyright (c) 2000-2012 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 parent structure ID of this d d m structure.
198             *
199             * @return the parent structure ID of this d d m structure
200             */
201            public long getParentStructureId();
202    
203            /**
204             * Sets the parent structure ID of this d d m structure.
205             *
206             * @param parentStructureId the parent structure ID of this d d m structure
207             */
208            public void setParentStructureId(long parentStructureId);
209    
210            /**
211             * Returns the fully qualified class name of this d d m structure.
212             *
213             * @return the fully qualified class name of this d d m structure
214             */
215            public String getClassName();
216    
217            public void setClassName(String className);
218    
219            /**
220             * Returns the class name ID of this d d m structure.
221             *
222             * @return the class name ID of this d d m structure
223             */
224            public long getClassNameId();
225    
226            /**
227             * Sets the class name ID of this d d m structure.
228             *
229             * @param classNameId the class name ID of this d d m structure
230             */
231            public void setClassNameId(long classNameId);
232    
233            /**
234             * Returns the structure key of this d d m structure.
235             *
236             * @return the structure key of this d d m structure
237             */
238            public String getStructureKey();
239    
240            /**
241             * Sets the structure key of this d d m structure.
242             *
243             * @param structureKey the structure key of this d d m structure
244             */
245            public void setStructureKey(String structureKey);
246    
247            /**
248             * Returns the name of this d d m structure.
249             *
250             * @return the name of this d d m structure
251             */
252            public String getName();
253    
254            /**
255             * 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.
256             *
257             * @param locale the locale of the language
258             * @return the localized name of this d d m structure
259             */
260            @AutoEscape
261            public String getName(Locale locale);
262    
263            /**
264             * 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.
265             *
266             * @param locale the local of the language
267             * @param useDefault whether to use the default language if no localization exists for the requested language
268             * @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.
269             */
270            @AutoEscape
271            public String getName(Locale locale, boolean useDefault);
272    
273            /**
274             * 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.
275             *
276             * @param languageId the ID of the language
277             * @return the localized name of this d d m structure
278             */
279            @AutoEscape
280            public String getName(String languageId);
281    
282            /**
283             * 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.
284             *
285             * @param languageId the ID of the language
286             * @param useDefault whether to use the default language if no localization exists for the requested language
287             * @return the localized name of this d d m structure
288             */
289            @AutoEscape
290            public String getName(String languageId, boolean useDefault);
291    
292            @AutoEscape
293            public String getNameCurrentLanguageId();
294    
295            @AutoEscape
296            public String getNameCurrentValue();
297    
298            /**
299             * Returns a map of the locales and localized names of this d d m structure.
300             *
301             * @return the locales and localized names of this d d m structure
302             */
303            public Map<Locale, String> getNameMap();
304    
305            /**
306             * Sets the name of this d d m structure.
307             *
308             * @param name the name of this d d m structure
309             */
310            public void setName(String name);
311    
312            /**
313             * Sets the localized name of this d d m structure in the language.
314             *
315             * @param name the localized name of this d d m structure
316             * @param locale the locale of the language
317             */
318            public void setName(String name, Locale locale);
319    
320            /**
321             * Sets the localized name of this d d m structure in the language, and sets the default locale.
322             *
323             * @param name the localized name of this d d m structure
324             * @param locale the locale of the language
325             * @param defaultLocale the default locale
326             */
327            public void setName(String name, Locale locale, Locale defaultLocale);
328    
329            public void setNameCurrentLanguageId(String languageId);
330    
331            /**
332             * Sets the localized names of this d d m structure from the map of locales and localized names.
333             *
334             * @param nameMap the locales and localized names of this d d m structure
335             */
336            public void setNameMap(Map<Locale, String> nameMap);
337    
338            /**
339             * Sets the localized names of this d d m structure from the map of locales and localized names, and sets the default locale.
340             *
341             * @param nameMap the locales and localized names of this d d m structure
342             * @param defaultLocale the default locale
343             */
344            public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale);
345    
346            /**
347             * Returns the description of this d d m structure.
348             *
349             * @return the description of this d d m structure
350             */
351            public String getDescription();
352    
353            /**
354             * 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.
355             *
356             * @param locale the locale of the language
357             * @return the localized description of this d d m structure
358             */
359            @AutoEscape
360            public String getDescription(Locale locale);
361    
362            /**
363             * 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.
364             *
365             * @param locale the local of the language
366             * @param useDefault whether to use the default language if no localization exists for the requested language
367             * @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.
368             */
369            @AutoEscape
370            public String getDescription(Locale locale, boolean useDefault);
371    
372            /**
373             * 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.
374             *
375             * @param languageId the ID of the language
376             * @return the localized description of this d d m structure
377             */
378            @AutoEscape
379            public String getDescription(String languageId);
380    
381            /**
382             * 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.
383             *
384             * @param languageId the ID of the language
385             * @param useDefault whether to use the default language if no localization exists for the requested language
386             * @return the localized description of this d d m structure
387             */
388            @AutoEscape
389            public String getDescription(String languageId, boolean useDefault);
390    
391            @AutoEscape
392            public String getDescriptionCurrentLanguageId();
393    
394            @AutoEscape
395            public String getDescriptionCurrentValue();
396    
397            /**
398             * Returns a map of the locales and localized descriptions of this d d m structure.
399             *
400             * @return the locales and localized descriptions of this d d m structure
401             */
402            public Map<Locale, String> getDescriptionMap();
403    
404            /**
405             * Sets the description of this d d m structure.
406             *
407             * @param description the description of this d d m structure
408             */
409            public void setDescription(String description);
410    
411            /**
412             * Sets the localized description of this d d m structure in the language.
413             *
414             * @param description the localized description of this d d m structure
415             * @param locale the locale of the language
416             */
417            public void setDescription(String description, Locale locale);
418    
419            /**
420             * Sets the localized description of this d d m structure in the language, and sets the default locale.
421             *
422             * @param description the localized description of this d d m structure
423             * @param locale the locale of the language
424             * @param defaultLocale the default locale
425             */
426            public void setDescription(String description, Locale locale,
427                    Locale defaultLocale);
428    
429            public void setDescriptionCurrentLanguageId(String languageId);
430    
431            /**
432             * Sets the localized descriptions of this d d m structure from the map of locales and localized descriptions.
433             *
434             * @param descriptionMap the locales and localized descriptions of this d d m structure
435             */
436            public void setDescriptionMap(Map<Locale, String> descriptionMap);
437    
438            /**
439             * Sets the localized descriptions of this d d m structure from the map of locales and localized descriptions, and sets the default locale.
440             *
441             * @param descriptionMap the locales and localized descriptions of this d d m structure
442             * @param defaultLocale the default locale
443             */
444            public void setDescriptionMap(Map<Locale, String> descriptionMap,
445                    Locale defaultLocale);
446    
447            /**
448             * Returns the xsd of this d d m structure.
449             *
450             * @return the xsd of this d d m structure
451             */
452            @AutoEscape
453            public String getXsd();
454    
455            /**
456             * Sets the xsd of this d d m structure.
457             *
458             * @param xsd the xsd of this d d m structure
459             */
460            public void setXsd(String xsd);
461    
462            /**
463             * Returns the storage type of this d d m structure.
464             *
465             * @return the storage type of this d d m structure
466             */
467            @AutoEscape
468            public String getStorageType();
469    
470            /**
471             * Sets the storage type of this d d m structure.
472             *
473             * @param storageType the storage type of this d d m structure
474             */
475            public void setStorageType(String storageType);
476    
477            /**
478             * Returns the type of this d d m structure.
479             *
480             * @return the type of this d d m structure
481             */
482            public int getType();
483    
484            /**
485             * Sets the type of this d d m structure.
486             *
487             * @param type the type of this d d m structure
488             */
489            public void setType(int type);
490    
491            public boolean isNew();
492    
493            public void setNew(boolean n);
494    
495            public boolean isCachedModel();
496    
497            public void setCachedModel(boolean cachedModel);
498    
499            public boolean isEscapedModel();
500    
501            public Serializable getPrimaryKeyObj();
502    
503            public void setPrimaryKeyObj(Serializable primaryKeyObj);
504    
505            public ExpandoBridge getExpandoBridge();
506    
507            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
508    
509            public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
510                    throws LocaleException;
511    
512            public Object clone();
513    
514            public int compareTo(DDMStructure ddmStructure);
515    
516            public int hashCode();
517    
518            public CacheModel<DDMStructure> toCacheModel();
519    
520            public DDMStructure toEscapedModel();
521    
522            public String toString();
523    
524            public String toXmlString();
525    }