001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portal.model;
016    
017    import com.liferay.portal.kernel.annotation.AutoEscape;
018    import com.liferay.portal.service.ServiceContext;
019    
020    import com.liferay.portlet.expando.model.ExpandoBridge;
021    
022    import java.io.Serializable;
023    
024    import java.util.Locale;
025    import java.util.Map;
026    
027    /**
028     * The base model interface for the LayoutPrototype service. Represents a row in the "LayoutPrototype" database table, with each column mapped to a property of this class.
029     *
030     * <p>
031     * This interface and its corresponding implementation {@link com.liferay.portal.model.impl.LayoutPrototypeModelImpl} 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.portal.model.impl.LayoutPrototypeImpl}.
032     * </p>
033     *
034     * <p>
035     * Never modify or reference this interface directly. All methods that expect a layout prototype model instance should use the {@link LayoutPrototype} interface instead.
036     * </p>
037     *
038     * @author Brian Wing Shun Chan
039     * @see LayoutPrototype
040     * @see com.liferay.portal.model.impl.LayoutPrototypeImpl
041     * @see com.liferay.portal.model.impl.LayoutPrototypeModelImpl
042     * @generated
043     */
044    public interface LayoutPrototypeModel extends BaseModel<LayoutPrototype> {
045            /**
046             * Gets the primary key of this layout prototype.
047             *
048             * @return the primary key of this layout prototype
049             */
050            public long getPrimaryKey();
051    
052            /**
053             * Sets the primary key of this layout prototype
054             *
055             * @param pk the primary key of this layout prototype
056             */
057            public void setPrimaryKey(long pk);
058    
059            /**
060             * Gets the layout prototype id of this layout prototype.
061             *
062             * @return the layout prototype id of this layout prototype
063             */
064            public long getLayoutPrototypeId();
065    
066            /**
067             * Sets the layout prototype id of this layout prototype.
068             *
069             * @param layoutPrototypeId the layout prototype id of this layout prototype
070             */
071            public void setLayoutPrototypeId(long layoutPrototypeId);
072    
073            /**
074             * Gets the company id of this layout prototype.
075             *
076             * @return the company id of this layout prototype
077             */
078            public long getCompanyId();
079    
080            /**
081             * Sets the company id of this layout prototype.
082             *
083             * @param companyId the company id of this layout prototype
084             */
085            public void setCompanyId(long companyId);
086    
087            /**
088             * Gets the name of this layout prototype.
089             *
090             * @return the name of this layout prototype
091             */
092            public String getName();
093    
094            /**
095             * Gets the localized name of this layout prototype. Uses the default language if no localization exists for the requested language.
096             *
097             * @param locale the locale to get the localized name for
098             * @return the localized name of this layout prototype
099             */
100            public String getName(Locale locale);
101    
102            /**
103             * Gets the localized name of this layout prototype, optionally using the default language if no localization exists for the requested language.
104             *
105             * @param locale the local to get the localized name for
106             * @param useDefault whether to use the default language if no localization exists for the requested language
107             * @return the localized name of this layout prototype. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned.
108             */
109            public String getName(Locale locale, boolean useDefault);
110    
111            /**
112             * Gets the localized name of this layout prototype. Uses the default language if no localization exists for the requested language.
113             *
114             * @param languageId the id of the language to get the localized name for
115             * @return the localized name of this layout prototype
116             */
117            public String getName(String languageId);
118    
119            /**
120             * Gets the localized name of this layout prototype, optionally using the default language if no localization exists for the requested language.
121             *
122             * @param languageId the id of the language to get the localized name for
123             * @param useDefault whether to use the default language if no localization exists for the requested language
124             * @return the localized name of this layout prototype
125             */
126            public String getName(String languageId, boolean useDefault);
127    
128            /**
129             * Gets a map of the locales and localized name of this layout prototype.
130             *
131             * @return the locales and localized name
132             */
133            public Map<Locale, String> getNameMap();
134    
135            /**
136             * Sets the name of this layout prototype.
137             *
138             * @param name the name of this layout prototype
139             */
140            public void setName(String name);
141    
142            /**
143             * Sets the localized name of this layout prototype.
144             *
145             * @param locale the locale to set the localized name for
146             * @param name the localized name of this layout prototype
147             */
148            public void setName(Locale locale, String name);
149    
150            /**
151             * Sets the localized names of this layout prototype from the map of locales and localized names.
152             *
153             * @param nameMap the locales and localized names of this layout prototype
154             */
155            public void setNameMap(Map<Locale, String> nameMap);
156    
157            /**
158             * Gets the description of this layout prototype.
159             *
160             * @return the description of this layout prototype
161             */
162            @AutoEscape
163            public String getDescription();
164    
165            /**
166             * Sets the description of this layout prototype.
167             *
168             * @param description the description of this layout prototype
169             */
170            public void setDescription(String description);
171    
172            /**
173             * Gets the settings of this layout prototype.
174             *
175             * @return the settings of this layout prototype
176             */
177            @AutoEscape
178            public String getSettings();
179    
180            /**
181             * Sets the settings of this layout prototype.
182             *
183             * @param settings the settings of this layout prototype
184             */
185            public void setSettings(String settings);
186    
187            /**
188             * Gets the active of this layout prototype.
189             *
190             * @return the active of this layout prototype
191             */
192            public boolean getActive();
193    
194            /**
195             * Determines whether this layout prototype is active.
196             *
197             * @return whether this layout prototype is active
198             */
199            public boolean isActive();
200    
201            /**
202             * Sets whether this {$entity.humanName} is active.
203             *
204             * @param active the active of this layout prototype
205             */
206            public void setActive(boolean active);
207    
208            public boolean isNew();
209    
210            public void setNew(boolean n);
211    
212            public boolean isCachedModel();
213    
214            public void setCachedModel(boolean cachedModel);
215    
216            public boolean isEscapedModel();
217    
218            public void setEscapedModel(boolean escapedModel);
219    
220            public Serializable getPrimaryKeyObj();
221    
222            public ExpandoBridge getExpandoBridge();
223    
224            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
225    
226            public Object clone();
227    
228            public int compareTo(LayoutPrototype layoutPrototype);
229    
230            public int hashCode();
231    
232            public LayoutPrototype toEscapedModel();
233    
234            public String toString();
235    
236            public String toXmlString();
237    }