com.liferay.portal.model.LayoutModel Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portal.model;
import com.liferay.portal.LocaleException;
import com.liferay.portal.kernel.bean.AutoEscape;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.service.ServiceContext;
import com.liferay.portlet.expando.model.ExpandoBridge;
import java.io.Serializable;
import java.util.Date;
import java.util.Locale;
import java.util.Map;
/**
* The base model interface for the Layout service. Represents a row in the "Layout" database table, with each column mapped to a property of this class.
*
*
* This interface and its corresponding implementation {@link com.liferay.portal.model.impl.LayoutModelImpl} 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.LayoutImpl}.
*
*
* @author Brian Wing Shun Chan
* @see Layout
* @see com.liferay.portal.model.impl.LayoutImpl
* @see com.liferay.portal.model.impl.LayoutModelImpl
* @generated
*/
public interface LayoutModel extends BaseModel, StagedGroupedModel {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. All methods that expect a layout model instance should use the {@link Layout} interface instead.
*/
/**
* Returns the primary key of this layout.
*
* @return the primary key of this layout
*/
public long getPrimaryKey();
/**
* Sets the primary key of this layout.
*
* @param primaryKey the primary key of this layout
*/
public void setPrimaryKey(long primaryKey);
/**
* Returns the uuid of this layout.
*
* @return the uuid of this layout
*/
@AutoEscape
@Override
public String getUuid();
/**
* Sets the uuid of this layout.
*
* @param uuid the uuid of this layout
*/
@Override
public void setUuid(String uuid);
/**
* Returns the plid of this layout.
*
* @return the plid of this layout
*/
public long getPlid();
/**
* Sets the plid of this layout.
*
* @param plid the plid of this layout
*/
public void setPlid(long plid);
/**
* Returns the group ID of this layout.
*
* @return the group ID of this layout
*/
@Override
public long getGroupId();
/**
* Sets the group ID of this layout.
*
* @param groupId the group ID of this layout
*/
@Override
public void setGroupId(long groupId);
/**
* Returns the company ID of this layout.
*
* @return the company ID of this layout
*/
@Override
public long getCompanyId();
/**
* Sets the company ID of this layout.
*
* @param companyId the company ID of this layout
*/
@Override
public void setCompanyId(long companyId);
/**
* Returns the user ID of this layout.
*
* @return the user ID of this layout
*/
@Override
public long getUserId();
/**
* Sets the user ID of this layout.
*
* @param userId the user ID of this layout
*/
@Override
public void setUserId(long userId);
/**
* Returns the user uuid of this layout.
*
* @return the user uuid of this layout
* @throws SystemException if a system exception occurred
*/
@Override
public String getUserUuid() throws SystemException;
/**
* Sets the user uuid of this layout.
*
* @param userUuid the user uuid of this layout
*/
@Override
public void setUserUuid(String userUuid);
/**
* Returns the user name of this layout.
*
* @return the user name of this layout
*/
@AutoEscape
@Override
public String getUserName();
/**
* Sets the user name of this layout.
*
* @param userName the user name of this layout
*/
@Override
public void setUserName(String userName);
/**
* Returns the create date of this layout.
*
* @return the create date of this layout
*/
@Override
public Date getCreateDate();
/**
* Sets the create date of this layout.
*
* @param createDate the create date of this layout
*/
@Override
public void setCreateDate(Date createDate);
/**
* Returns the modified date of this layout.
*
* @return the modified date of this layout
*/
@Override
public Date getModifiedDate();
/**
* Sets the modified date of this layout.
*
* @param modifiedDate the modified date of this layout
*/
@Override
public void setModifiedDate(Date modifiedDate);
/**
* Returns the private layout of this layout.
*
* @return the private layout of this layout
*/
public boolean getPrivateLayout();
/**
* Returns true if this layout is private layout.
*
* @return true if this layout is private layout; false otherwise
*/
public boolean isPrivateLayout();
/**
* Sets whether this layout is private layout.
*
* @param privateLayout the private layout of this layout
*/
public void setPrivateLayout(boolean privateLayout);
/**
* Returns the layout ID of this layout.
*
* @return the layout ID of this layout
*/
public long getLayoutId();
/**
* Sets the layout ID of this layout.
*
* @param layoutId the layout ID of this layout
*/
public void setLayoutId(long layoutId);
/**
* Returns the parent layout ID of this layout.
*
* @return the parent layout ID of this layout
*/
public long getParentLayoutId();
/**
* Sets the parent layout ID of this layout.
*
* @param parentLayoutId the parent layout ID of this layout
*/
public void setParentLayoutId(long parentLayoutId);
/**
* Returns the name of this layout.
*
* @return the name of this layout
*/
public String getName();
/**
* Returns the localized name of this layout in the language. Uses the default language if no localization exists for the requested language.
*
* @param locale the locale of the language
* @return the localized name of this layout
*/
@AutoEscape
public String getName(Locale locale);
/**
* Returns the localized name of this layout in the language, optionally using the default language if no localization exists for the requested language.
*
* @param locale the local of the language
* @param useDefault whether to use the default language if no localization exists for the requested language
* @return the localized name of this layout. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
*/
@AutoEscape
public String getName(Locale locale, boolean useDefault);
/**
* Returns the localized name of this layout in the language. Uses the default language if no localization exists for the requested language.
*
* @param languageId the ID of the language
* @return the localized name of this layout
*/
@AutoEscape
public String getName(String languageId);
/**
* Returns the localized name of this layout in the language, optionally using the default language if no localization exists for the requested language.
*
* @param languageId the ID of the language
* @param useDefault whether to use the default language if no localization exists for the requested language
* @return the localized name of this layout
*/
@AutoEscape
public String getName(String languageId, boolean useDefault);
@AutoEscape
public String getNameCurrentLanguageId();
@AutoEscape
public String getNameCurrentValue();
/**
* Returns a map of the locales and localized names of this layout.
*
* @return the locales and localized names of this layout
*/
public Map getNameMap();
/**
* Sets the name of this layout.
*
* @param name the name of this layout
*/
public void setName(String name);
/**
* Sets the localized name of this layout in the language.
*
* @param name the localized name of this layout
* @param locale the locale of the language
*/
public void setName(String name, Locale locale);
/**
* Sets the localized name of this layout in the language, and sets the default locale.
*
* @param name the localized name of this layout
* @param locale the locale of the language
* @param defaultLocale the default locale
*/
public void setName(String name, Locale locale, Locale defaultLocale);
public void setNameCurrentLanguageId(String languageId);
/**
* Sets the localized names of this layout from the map of locales and localized names.
*
* @param nameMap the locales and localized names of this layout
*/
public void setNameMap(Map nameMap);
/**
* Sets the localized names of this layout from the map of locales and localized names, and sets the default locale.
*
* @param nameMap the locales and localized names of this layout
* @param defaultLocale the default locale
*/
public void setNameMap(Map nameMap, Locale defaultLocale);
/**
* Returns the title of this layout.
*
* @return the title of this layout
*/
public String getTitle();
/**
* Returns the localized title of this layout in the language. Uses the default language if no localization exists for the requested language.
*
* @param locale the locale of the language
* @return the localized title of this layout
*/
@AutoEscape
public String getTitle(Locale locale);
/**
* Returns the localized title of this layout in the language, optionally using the default language if no localization exists for the requested language.
*
* @param locale the local of the language
* @param useDefault whether to use the default language if no localization exists for the requested language
* @return the localized title of this layout. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
*/
@AutoEscape
public String getTitle(Locale locale, boolean useDefault);
/**
* Returns the localized title of this layout in the language. Uses the default language if no localization exists for the requested language.
*
* @param languageId the ID of the language
* @return the localized title of this layout
*/
@AutoEscape
public String getTitle(String languageId);
/**
* Returns the localized title of this layout in the language, optionally using the default language if no localization exists for the requested language.
*
* @param languageId the ID of the language
* @param useDefault whether to use the default language if no localization exists for the requested language
* @return the localized title of this layout
*/
@AutoEscape
public String getTitle(String languageId, boolean useDefault);
@AutoEscape
public String getTitleCurrentLanguageId();
@AutoEscape
public String getTitleCurrentValue();
/**
* Returns a map of the locales and localized titles of this layout.
*
* @return the locales and localized titles of this layout
*/
public Map getTitleMap();
/**
* Sets the title of this layout.
*
* @param title the title of this layout
*/
public void setTitle(String title);
/**
* Sets the localized title of this layout in the language.
*
* @param title the localized title of this layout
* @param locale the locale of the language
*/
public void setTitle(String title, Locale locale);
/**
* Sets the localized title of this layout in the language, and sets the default locale.
*
* @param title the localized title of this layout
* @param locale the locale of the language
* @param defaultLocale the default locale
*/
public void setTitle(String title, Locale locale, Locale defaultLocale);
public void setTitleCurrentLanguageId(String languageId);
/**
* Sets the localized titles of this layout from the map of locales and localized titles.
*
* @param titleMap the locales and localized titles of this layout
*/
public void setTitleMap(Map titleMap);
/**
* Sets the localized titles of this layout from the map of locales and localized titles, and sets the default locale.
*
* @param titleMap the locales and localized titles of this layout
* @param defaultLocale the default locale
*/
public void setTitleMap(Map titleMap, Locale defaultLocale);
/**
* Returns the description of this layout.
*
* @return the description of this layout
*/
public String getDescription();
/**
* Returns the localized description of this layout in the language. Uses the default language if no localization exists for the requested language.
*
* @param locale the locale of the language
* @return the localized description of this layout
*/
@AutoEscape
public String getDescription(Locale locale);
/**
* Returns the localized description of this layout in the language, optionally using the default language if no localization exists for the requested language.
*
* @param locale the local of the language
* @param useDefault whether to use the default language if no localization exists for the requested language
* @return the localized description of this layout. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
*/
@AutoEscape
public String getDescription(Locale locale, boolean useDefault);
/**
* Returns the localized description of this layout in the language. Uses the default language if no localization exists for the requested language.
*
* @param languageId the ID of the language
* @return the localized description of this layout
*/
@AutoEscape
public String getDescription(String languageId);
/**
* Returns the localized description of this layout in the language, optionally using the default language if no localization exists for the requested language.
*
* @param languageId the ID of the language
* @param useDefault whether to use the default language if no localization exists for the requested language
* @return the localized description of this layout
*/
@AutoEscape
public String getDescription(String languageId, boolean useDefault);
@AutoEscape
public String getDescriptionCurrentLanguageId();
@AutoEscape
public String getDescriptionCurrentValue();
/**
* Returns a map of the locales and localized descriptions of this layout.
*
* @return the locales and localized descriptions of this layout
*/
public Map getDescriptionMap();
/**
* Sets the description of this layout.
*
* @param description the description of this layout
*/
public void setDescription(String description);
/**
* Sets the localized description of this layout in the language.
*
* @param description the localized description of this layout
* @param locale the locale of the language
*/
public void setDescription(String description, Locale locale);
/**
* Sets the localized description of this layout in the language, and sets the default locale.
*
* @param description the localized description of this layout
* @param locale the locale of the language
* @param defaultLocale the default locale
*/
public void setDescription(String description, Locale locale,
Locale defaultLocale);
public void setDescriptionCurrentLanguageId(String languageId);
/**
* Sets the localized descriptions of this layout from the map of locales and localized descriptions.
*
* @param descriptionMap the locales and localized descriptions of this layout
*/
public void setDescriptionMap(Map descriptionMap);
/**
* Sets the localized descriptions of this layout from the map of locales and localized descriptions, and sets the default locale.
*
* @param descriptionMap the locales and localized descriptions of this layout
* @param defaultLocale the default locale
*/
public void setDescriptionMap(Map descriptionMap,
Locale defaultLocale);
/**
* Returns the keywords of this layout.
*
* @return the keywords of this layout
*/
public String getKeywords();
/**
* Returns the localized keywords of this layout in the language. Uses the default language if no localization exists for the requested language.
*
* @param locale the locale of the language
* @return the localized keywords of this layout
*/
@AutoEscape
public String getKeywords(Locale locale);
/**
* Returns the localized keywords of this layout in the language, optionally using the default language if no localization exists for the requested language.
*
* @param locale the local of the language
* @param useDefault whether to use the default language if no localization exists for the requested language
* @return the localized keywords of this layout. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
*/
@AutoEscape
public String getKeywords(Locale locale, boolean useDefault);
/**
* Returns the localized keywords of this layout in the language. Uses the default language if no localization exists for the requested language.
*
* @param languageId the ID of the language
* @return the localized keywords of this layout
*/
@AutoEscape
public String getKeywords(String languageId);
/**
* Returns the localized keywords of this layout in the language, optionally using the default language if no localization exists for the requested language.
*
* @param languageId the ID of the language
* @param useDefault whether to use the default language if no localization exists for the requested language
* @return the localized keywords of this layout
*/
@AutoEscape
public String getKeywords(String languageId, boolean useDefault);
@AutoEscape
public String getKeywordsCurrentLanguageId();
@AutoEscape
public String getKeywordsCurrentValue();
/**
* Returns a map of the locales and localized keywordses of this layout.
*
* @return the locales and localized keywordses of this layout
*/
public Map getKeywordsMap();
/**
* Sets the keywords of this layout.
*
* @param keywords the keywords of this layout
*/
public void setKeywords(String keywords);
/**
* Sets the localized keywords of this layout in the language.
*
* @param keywords the localized keywords of this layout
* @param locale the locale of the language
*/
public void setKeywords(String keywords, Locale locale);
/**
* Sets the localized keywords of this layout in the language, and sets the default locale.
*
* @param keywords the localized keywords of this layout
* @param locale the locale of the language
* @param defaultLocale the default locale
*/
public void setKeywords(String keywords, Locale locale, Locale defaultLocale);
public void setKeywordsCurrentLanguageId(String languageId);
/**
* Sets the localized keywordses of this layout from the map of locales and localized keywordses.
*
* @param keywordsMap the locales and localized keywordses of this layout
*/
public void setKeywordsMap(Map keywordsMap);
/**
* Sets the localized keywordses of this layout from the map of locales and localized keywordses, and sets the default locale.
*
* @param keywordsMap the locales and localized keywordses of this layout
* @param defaultLocale the default locale
*/
public void setKeywordsMap(Map keywordsMap,
Locale defaultLocale);
/**
* Returns the robots of this layout.
*
* @return the robots of this layout
*/
public String getRobots();
/**
* Returns the localized robots of this layout in the language. Uses the default language if no localization exists for the requested language.
*
* @param locale the locale of the language
* @return the localized robots of this layout
*/
@AutoEscape
public String getRobots(Locale locale);
/**
* Returns the localized robots of this layout in the language, optionally using the default language if no localization exists for the requested language.
*
* @param locale the local of the language
* @param useDefault whether to use the default language if no localization exists for the requested language
* @return the localized robots of this layout. If useDefault is false and no localization exists for the requested language, an empty string will be returned.
*/
@AutoEscape
public String getRobots(Locale locale, boolean useDefault);
/**
* Returns the localized robots of this layout in the language. Uses the default language if no localization exists for the requested language.
*
* @param languageId the ID of the language
* @return the localized robots of this layout
*/
@AutoEscape
public String getRobots(String languageId);
/**
* Returns the localized robots of this layout in the language, optionally using the default language if no localization exists for the requested language.
*
* @param languageId the ID of the language
* @param useDefault whether to use the default language if no localization exists for the requested language
* @return the localized robots of this layout
*/
@AutoEscape
public String getRobots(String languageId, boolean useDefault);
@AutoEscape
public String getRobotsCurrentLanguageId();
@AutoEscape
public String getRobotsCurrentValue();
/**
* Returns a map of the locales and localized robotses of this layout.
*
* @return the locales and localized robotses of this layout
*/
public Map getRobotsMap();
/**
* Sets the robots of this layout.
*
* @param robots the robots of this layout
*/
public void setRobots(String robots);
/**
* Sets the localized robots of this layout in the language.
*
* @param robots the localized robots of this layout
* @param locale the locale of the language
*/
public void setRobots(String robots, Locale locale);
/**
* Sets the localized robots of this layout in the language, and sets the default locale.
*
* @param robots the localized robots of this layout
* @param locale the locale of the language
* @param defaultLocale the default locale
*/
public void setRobots(String robots, Locale locale, Locale defaultLocale);
public void setRobotsCurrentLanguageId(String languageId);
/**
* Sets the localized robotses of this layout from the map of locales and localized robotses.
*
* @param robotsMap the locales and localized robotses of this layout
*/
public void setRobotsMap(Map robotsMap);
/**
* Sets the localized robotses of this layout from the map of locales and localized robotses, and sets the default locale.
*
* @param robotsMap the locales and localized robotses of this layout
* @param defaultLocale the default locale
*/
public void setRobotsMap(Map robotsMap, Locale defaultLocale);
/**
* Returns the type of this layout.
*
* @return the type of this layout
*/
@AutoEscape
public String getType();
/**
* Sets the type of this layout.
*
* @param type the type of this layout
*/
public void setType(String type);
/**
* Returns the type settings of this layout.
*
* @return the type settings of this layout
*/
@AutoEscape
public String getTypeSettings();
/**
* Sets the type settings of this layout.
*
* @param typeSettings the type settings of this layout
*/
public void setTypeSettings(String typeSettings);
/**
* Returns the hidden of this layout.
*
* @return the hidden of this layout
*/
public boolean getHidden();
/**
* Returns true if this layout is hidden.
*
* @return true if this layout is hidden; false otherwise
*/
public boolean isHidden();
/**
* Sets whether this layout is hidden.
*
* @param hidden the hidden of this layout
*/
public void setHidden(boolean hidden);
/**
* Returns the friendly u r l of this layout.
*
* @return the friendly u r l of this layout
*/
@AutoEscape
public String getFriendlyURL();
/**
* Sets the friendly u r l of this layout.
*
* @param friendlyURL the friendly u r l of this layout
*/
public void setFriendlyURL(String friendlyURL);
/**
* Returns the icon image of this layout.
*
* @return the icon image of this layout
*/
public boolean getIconImage();
/**
* Returns true if this layout is icon image.
*
* @return true if this layout is icon image; false otherwise
*/
public boolean isIconImage();
/**
* Sets whether this layout is icon image.
*
* @param iconImage the icon image of this layout
*/
public void setIconImage(boolean iconImage);
/**
* Returns the icon image ID of this layout.
*
* @return the icon image ID of this layout
*/
public long getIconImageId();
/**
* Sets the icon image ID of this layout.
*
* @param iconImageId the icon image ID of this layout
*/
public void setIconImageId(long iconImageId);
/**
* Returns the theme ID of this layout.
*
* @return the theme ID of this layout
*/
@AutoEscape
public String getThemeId();
/**
* Sets the theme ID of this layout.
*
* @param themeId the theme ID of this layout
*/
public void setThemeId(String themeId);
/**
* Returns the color scheme ID of this layout.
*
* @return the color scheme ID of this layout
*/
@AutoEscape
public String getColorSchemeId();
/**
* Sets the color scheme ID of this layout.
*
* @param colorSchemeId the color scheme ID of this layout
*/
public void setColorSchemeId(String colorSchemeId);
/**
* Returns the wap theme ID of this layout.
*
* @return the wap theme ID of this layout
*/
@AutoEscape
public String getWapThemeId();
/**
* Sets the wap theme ID of this layout.
*
* @param wapThemeId the wap theme ID of this layout
*/
public void setWapThemeId(String wapThemeId);
/**
* Returns the wap color scheme ID of this layout.
*
* @return the wap color scheme ID of this layout
*/
@AutoEscape
public String getWapColorSchemeId();
/**
* Sets the wap color scheme ID of this layout.
*
* @param wapColorSchemeId the wap color scheme ID of this layout
*/
public void setWapColorSchemeId(String wapColorSchemeId);
/**
* Returns the css of this layout.
*
* @return the css of this layout
*/
@AutoEscape
public String getCss();
/**
* Sets the css of this layout.
*
* @param css the css of this layout
*/
public void setCss(String css);
/**
* Returns the priority of this layout.
*
* @return the priority of this layout
*/
public int getPriority();
/**
* Sets the priority of this layout.
*
* @param priority the priority of this layout
*/
public void setPriority(int priority);
/**
* Returns the layout prototype uuid of this layout.
*
* @return the layout prototype uuid of this layout
*/
@AutoEscape
public String getLayoutPrototypeUuid();
/**
* Sets the layout prototype uuid of this layout.
*
* @param layoutPrototypeUuid the layout prototype uuid of this layout
*/
public void setLayoutPrototypeUuid(String layoutPrototypeUuid);
/**
* Returns the layout prototype link enabled of this layout.
*
* @return the layout prototype link enabled of this layout
*/
public boolean getLayoutPrototypeLinkEnabled();
/**
* Returns true if this layout is layout prototype link enabled.
*
* @return true if this layout is layout prototype link enabled; false otherwise
*/
public boolean isLayoutPrototypeLinkEnabled();
/**
* Sets whether this layout is layout prototype link enabled.
*
* @param layoutPrototypeLinkEnabled the layout prototype link enabled of this layout
*/
public void setLayoutPrototypeLinkEnabled(
boolean layoutPrototypeLinkEnabled);
/**
* Returns the source prototype layout uuid of this layout.
*
* @return the source prototype layout uuid of this layout
*/
@AutoEscape
public String getSourcePrototypeLayoutUuid();
/**
* Sets the source prototype layout uuid of this layout.
*
* @param sourcePrototypeLayoutUuid the source prototype layout uuid of this layout
*/
public void setSourcePrototypeLayoutUuid(String sourcePrototypeLayoutUuid);
@Override
public boolean isNew();
@Override
public void setNew(boolean n);
@Override
public boolean isCachedModel();
@Override
public void setCachedModel(boolean cachedModel);
@Override
public boolean isEscapedModel();
@Override
public Serializable getPrimaryKeyObj();
@Override
public void setPrimaryKeyObj(Serializable primaryKeyObj);
@Override
public ExpandoBridge getExpandoBridge();
@Override
public void setExpandoBridgeAttributes(BaseModel baseModel);
@Override
public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
@Override
public void setExpandoBridgeAttributes(ServiceContext serviceContext);
public String[] getAvailableLanguageIds();
public String getDefaultLanguageId();
public void prepareLocalizedFieldsForImport() throws LocaleException;
public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
throws LocaleException;
@Override
public Object clone();
@Override
public int compareTo(Layout layout);
@Override
public int hashCode();
@Override
public CacheModel toCacheModel();
@Override
public Layout toEscapedModel();
@Override
public Layout toUnescapedModel();
@Override
public String toString();
@Override
public String toXmlString();
}