com.liferay.calendar.model.CalendarModel Maven / Gradle / Ivy
The newest version!
/**
* SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
* SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
*/
package com.liferay.calendar.model;
import com.liferay.portal.kernel.bean.AutoEscape;
import com.liferay.portal.kernel.exception.LocaleException;
import com.liferay.portal.kernel.model.BaseModel;
import com.liferay.portal.kernel.model.LocalizedModel;
import com.liferay.portal.kernel.model.MVCCModel;
import com.liferay.portal.kernel.model.ShardedModel;
import com.liferay.portal.kernel.model.StagedGroupedModel;
import com.liferay.portal.kernel.model.change.tracking.CTModel;
import java.util.Date;
import java.util.Locale;
import java.util.Map;
import org.osgi.annotation.versioning.ProviderType;
/**
* The base model interface for the Calendar service. Represents a row in the "Calendar" database table, with each column mapped to a property of this class.
*
*
* This interface and its corresponding implementation com.liferay.calendar.model.impl.CalendarModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in com.liferay.calendar.model.impl.CalendarImpl.
*
*
* @author Eduardo Lundgren
* @see Calendar
* @generated
*/
@ProviderType
public interface CalendarModel
extends BaseModel, CTModel, LocalizedModel, MVCCModel,
ShardedModel, StagedGroupedModel {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. All methods that expect a calendar model instance should use the {@link Calendar} interface instead.
*/
/**
* Returns the primary key of this calendar.
*
* @return the primary key of this calendar
*/
@Override
public long getPrimaryKey();
/**
* Sets the primary key of this calendar.
*
* @param primaryKey the primary key of this calendar
*/
@Override
public void setPrimaryKey(long primaryKey);
/**
* Returns the mvcc version of this calendar.
*
* @return the mvcc version of this calendar
*/
@Override
public long getMvccVersion();
/**
* Sets the mvcc version of this calendar.
*
* @param mvccVersion the mvcc version of this calendar
*/
@Override
public void setMvccVersion(long mvccVersion);
/**
* Returns the ct collection ID of this calendar.
*
* @return the ct collection ID of this calendar
*/
@Override
public long getCtCollectionId();
/**
* Sets the ct collection ID of this calendar.
*
* @param ctCollectionId the ct collection ID of this calendar
*/
@Override
public void setCtCollectionId(long ctCollectionId);
/**
* Returns the uuid of this calendar.
*
* @return the uuid of this calendar
*/
@AutoEscape
@Override
public String getUuid();
/**
* Sets the uuid of this calendar.
*
* @param uuid the uuid of this calendar
*/
@Override
public void setUuid(String uuid);
/**
* Returns the calendar ID of this calendar.
*
* @return the calendar ID of this calendar
*/
public long getCalendarId();
/**
* Sets the calendar ID of this calendar.
*
* @param calendarId the calendar ID of this calendar
*/
public void setCalendarId(long calendarId);
/**
* Returns the group ID of this calendar.
*
* @return the group ID of this calendar
*/
@Override
public long getGroupId();
/**
* Sets the group ID of this calendar.
*
* @param groupId the group ID of this calendar
*/
@Override
public void setGroupId(long groupId);
/**
* Returns the company ID of this calendar.
*
* @return the company ID of this calendar
*/
@Override
public long getCompanyId();
/**
* Sets the company ID of this calendar.
*
* @param companyId the company ID of this calendar
*/
@Override
public void setCompanyId(long companyId);
/**
* Returns the user ID of this calendar.
*
* @return the user ID of this calendar
*/
@Override
public long getUserId();
/**
* Sets the user ID of this calendar.
*
* @param userId the user ID of this calendar
*/
@Override
public void setUserId(long userId);
/**
* Returns the user uuid of this calendar.
*
* @return the user uuid of this calendar
*/
@Override
public String getUserUuid();
/**
* Sets the user uuid of this calendar.
*
* @param userUuid the user uuid of this calendar
*/
@Override
public void setUserUuid(String userUuid);
/**
* Returns the user name of this calendar.
*
* @return the user name of this calendar
*/
@AutoEscape
@Override
public String getUserName();
/**
* Sets the user name of this calendar.
*
* @param userName the user name of this calendar
*/
@Override
public void setUserName(String userName);
/**
* Returns the create date of this calendar.
*
* @return the create date of this calendar
*/
@Override
public Date getCreateDate();
/**
* Sets the create date of this calendar.
*
* @param createDate the create date of this calendar
*/
@Override
public void setCreateDate(Date createDate);
/**
* Returns the modified date of this calendar.
*
* @return the modified date of this calendar
*/
@Override
public Date getModifiedDate();
/**
* Sets the modified date of this calendar.
*
* @param modifiedDate the modified date of this calendar
*/
@Override
public void setModifiedDate(Date modifiedDate);
/**
* Returns the calendar resource ID of this calendar.
*
* @return the calendar resource ID of this calendar
*/
public long getCalendarResourceId();
/**
* Sets the calendar resource ID of this calendar.
*
* @param calendarResourceId the calendar resource ID of this calendar
*/
public void setCalendarResourceId(long calendarResourceId);
/**
* Returns the name of this calendar.
*
* @return the name of this calendar
*/
public String getName();
/**
* Returns the localized name of this calendar 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 calendar
*/
@AutoEscape
public String getName(Locale locale);
/**
* Returns the localized name of this calendar 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 calendar. 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 calendar 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 calendar
*/
@AutoEscape
public String getName(String languageId);
/**
* Returns the localized name of this calendar 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 calendar
*/
@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 calendar.
*
* @return the locales and localized names of this calendar
*/
public Map getNameMap();
/**
* Sets the name of this calendar.
*
* @param name the name of this calendar
*/
public void setName(String name);
/**
* Sets the localized name of this calendar in the language.
*
* @param name the localized name of this calendar
* @param locale the locale of the language
*/
public void setName(String name, Locale locale);
/**
* Sets the localized name of this calendar in the language, and sets the default locale.
*
* @param name the localized name of this calendar
* @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 calendar from the map of locales and localized names.
*
* @param nameMap the locales and localized names of this calendar
*/
public void setNameMap(Map nameMap);
/**
* Sets the localized names of this calendar from the map of locales and localized names, and sets the default locale.
*
* @param nameMap the locales and localized names of this calendar
* @param defaultLocale the default locale
*/
public void setNameMap(Map nameMap, Locale defaultLocale);
/**
* Returns the description of this calendar.
*
* @return the description of this calendar
*/
public String getDescription();
/**
* Returns the localized description of this calendar 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 calendar
*/
@AutoEscape
public String getDescription(Locale locale);
/**
* Returns the localized description of this calendar 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 calendar. 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 calendar 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 calendar
*/
@AutoEscape
public String getDescription(String languageId);
/**
* Returns the localized description of this calendar 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 calendar
*/
@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 calendar.
*
* @return the locales and localized descriptions of this calendar
*/
public Map getDescriptionMap();
/**
* Sets the description of this calendar.
*
* @param description the description of this calendar
*/
public void setDescription(String description);
/**
* Sets the localized description of this calendar in the language.
*
* @param description the localized description of this calendar
* @param locale the locale of the language
*/
public void setDescription(String description, Locale locale);
/**
* Sets the localized description of this calendar in the language, and sets the default locale.
*
* @param description the localized description of this calendar
* @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 calendar from the map of locales and localized descriptions.
*
* @param descriptionMap the locales and localized descriptions of this calendar
*/
public void setDescriptionMap(Map descriptionMap);
/**
* Sets the localized descriptions of this calendar from the map of locales and localized descriptions, and sets the default locale.
*
* @param descriptionMap the locales and localized descriptions of this calendar
* @param defaultLocale the default locale
*/
public void setDescriptionMap(
Map descriptionMap, Locale defaultLocale);
/**
* Returns the time zone ID of this calendar.
*
* @return the time zone ID of this calendar
*/
@AutoEscape
public String getTimeZoneId();
/**
* Sets the time zone ID of this calendar.
*
* @param timeZoneId the time zone ID of this calendar
*/
public void setTimeZoneId(String timeZoneId);
/**
* Returns the color of this calendar.
*
* @return the color of this calendar
*/
public int getColor();
/**
* Sets the color of this calendar.
*
* @param color the color of this calendar
*/
public void setColor(int color);
/**
* Returns the default calendar of this calendar.
*
* @return the default calendar of this calendar
*/
public boolean getDefaultCalendar();
/**
* Returns true if this calendar is default calendar.
*
* @return true if this calendar is default calendar; false otherwise
*/
public boolean isDefaultCalendar();
/**
* Sets whether this calendar is default calendar.
*
* @param defaultCalendar the default calendar of this calendar
*/
public void setDefaultCalendar(boolean defaultCalendar);
/**
* Returns the enable comments of this calendar.
*
* @return the enable comments of this calendar
*/
public boolean getEnableComments();
/**
* Returns true if this calendar is enable comments.
*
* @return true if this calendar is enable comments; false otherwise
*/
public boolean isEnableComments();
/**
* Sets whether this calendar is enable comments.
*
* @param enableComments the enable comments of this calendar
*/
public void setEnableComments(boolean enableComments);
/**
* Returns the enable ratings of this calendar.
*
* @return the enable ratings of this calendar
*/
public boolean getEnableRatings();
/**
* Returns true if this calendar is enable ratings.
*
* @return true if this calendar is enable ratings; false otherwise
*/
public boolean isEnableRatings();
/**
* Sets whether this calendar is enable ratings.
*
* @param enableRatings the enable ratings of this calendar
*/
public void setEnableRatings(boolean enableRatings);
/**
* Returns the last publish date of this calendar.
*
* @return the last publish date of this calendar
*/
@Override
public Date getLastPublishDate();
/**
* Sets the last publish date of this calendar.
*
* @param lastPublishDate the last publish date of this calendar
*/
@Override
public void setLastPublishDate(Date lastPublishDate);
@Override
public String[] getAvailableLanguageIds();
@Override
public String getDefaultLanguageId();
@Override
public void prepareLocalizedFieldsForImport() throws LocaleException;
@Override
public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
throws LocaleException;
@Override
public Calendar cloneWithOriginalValues();
public default String toXmlString() {
return null;
}
}