001 /** 002 * Copyright (c) 2000-2011 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.bean.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 * @author Brian Wing Shun Chan 035 * @see LayoutPrototype 036 * @see com.liferay.portal.model.impl.LayoutPrototypeImpl 037 * @see com.liferay.portal.model.impl.LayoutPrototypeModelImpl 038 * @generated 039 */ 040 public interface LayoutPrototypeModel extends BaseModel<LayoutPrototype> { 041 /* 042 * NOTE FOR DEVELOPERS: 043 * 044 * Never modify or reference this interface directly. All methods that expect a layout prototype model instance should use the {@link LayoutPrototype} interface instead. 045 */ 046 047 /** 048 * Gets the primary key of this layout prototype. 049 * 050 * @return the primary key of this layout prototype 051 */ 052 public long getPrimaryKey(); 053 054 /** 055 * Sets the primary key of this layout prototype 056 * 057 * @param primaryKey the primary key of this layout prototype 058 */ 059 public void setPrimaryKey(long primaryKey); 060 061 /** 062 * Gets the layout prototype ID of this layout prototype. 063 * 064 * @return the layout prototype ID of this layout prototype 065 */ 066 public long getLayoutPrototypeId(); 067 068 /** 069 * Sets the layout prototype ID of this layout prototype. 070 * 071 * @param layoutPrototypeId the layout prototype ID of this layout prototype 072 */ 073 public void setLayoutPrototypeId(long layoutPrototypeId); 074 075 /** 076 * Gets the company ID of this layout prototype. 077 * 078 * @return the company ID of this layout prototype 079 */ 080 public long getCompanyId(); 081 082 /** 083 * Sets the company ID of this layout prototype. 084 * 085 * @param companyId the company ID of this layout prototype 086 */ 087 public void setCompanyId(long companyId); 088 089 /** 090 * Gets the name of this layout prototype. 091 * 092 * @return the name of this layout prototype 093 */ 094 public String getName(); 095 096 /** 097 * Gets the localized name of this layout prototype. Uses the default language if no localization exists for the requested language. 098 * 099 * @param locale the locale to get the localized name for 100 * @return the localized name of this layout prototype 101 */ 102 public String getName(Locale locale); 103 104 /** 105 * Gets the localized name of this layout prototype, optionally using the default language if no localization exists for the requested language. 106 * 107 * @param locale the local to get the localized name for 108 * @param useDefault whether to use the default language if no localization exists for the requested language 109 * @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. 110 */ 111 public String getName(Locale locale, boolean useDefault); 112 113 /** 114 * Gets the localized name of this layout prototype. Uses the default language if no localization exists for the requested language. 115 * 116 * @param languageId the id of the language to get the localized name for 117 * @return the localized name of this layout prototype 118 */ 119 public String getName(String languageId); 120 121 /** 122 * Gets the localized name of this layout prototype, optionally using the default language if no localization exists for the requested language. 123 * 124 * @param languageId the id of the language to get the localized name for 125 * @param useDefault whether to use the default language if no localization exists for the requested language 126 * @return the localized name of this layout prototype 127 */ 128 public String getName(String languageId, boolean useDefault); 129 130 /** 131 * Gets a map of the locales and localized name of this layout prototype. 132 * 133 * @return the locales and localized name 134 */ 135 public Map<Locale, String> getNameMap(); 136 137 /** 138 * Sets the name of this layout prototype. 139 * 140 * @param name the name of this layout prototype 141 */ 142 public void setName(String name); 143 144 /** 145 * Sets the localized name of this layout prototype. 146 * 147 * @param locale the locale to set the localized name for 148 * @param name the localized name of this layout prototype 149 */ 150 public void setName(Locale locale, String name); 151 152 /** 153 * Sets the localized names of this layout prototype from the map of locales and localized names. 154 * 155 * @param nameMap the locales and localized names of this layout prototype 156 */ 157 public void setNameMap(Map<Locale, String> nameMap); 158 159 /** 160 * Gets the description of this layout prototype. 161 * 162 * @return the description of this layout prototype 163 */ 164 @AutoEscape 165 public String getDescription(); 166 167 /** 168 * Sets the description of this layout prototype. 169 * 170 * @param description the description of this layout prototype 171 */ 172 public void setDescription(String description); 173 174 /** 175 * Gets the settings of this layout prototype. 176 * 177 * @return the settings of this layout prototype 178 */ 179 @AutoEscape 180 public String getSettings(); 181 182 /** 183 * Sets the settings of this layout prototype. 184 * 185 * @param settings the settings of this layout prototype 186 */ 187 public void setSettings(String settings); 188 189 /** 190 * Gets the active of this layout prototype. 191 * 192 * @return the active of this layout prototype 193 */ 194 public boolean getActive(); 195 196 /** 197 * Determines if this layout prototype is active. 198 * 199 * @return <code>true</code> if this layout prototype is active; <code>false</code> otherwise 200 */ 201 public boolean isActive(); 202 203 /** 204 * Sets whether this layout prototype is active. 205 * 206 * @param active the active of this layout prototype 207 */ 208 public void setActive(boolean active); 209 210 public boolean isNew(); 211 212 public void setNew(boolean n); 213 214 public boolean isCachedModel(); 215 216 public void setCachedModel(boolean cachedModel); 217 218 public boolean isEscapedModel(); 219 220 public void setEscapedModel(boolean escapedModel); 221 222 public Serializable getPrimaryKeyObj(); 223 224 public void setPrimaryKeyObj(Serializable primaryKeyObj); 225 226 public ExpandoBridge getExpandoBridge(); 227 228 public void setExpandoBridgeAttributes(ServiceContext serviceContext); 229 230 public Object clone(); 231 232 public int compareTo(LayoutPrototype layoutPrototype); 233 234 public int hashCode(); 235 236 public CacheModel<LayoutPrototype> toCacheModel(); 237 238 public LayoutPrototype toEscapedModel(); 239 240 public String toString(); 241 242 public String toXmlString(); 243 }