Package com.liferay.calendar.model
Interface CalendarModel
- All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel
,com.liferay.portal.kernel.model.BaseModel<Calendar>
,com.liferay.portal.kernel.model.ClassedModel
,Cloneable
,Comparable<Calendar>
,com.liferay.portal.kernel.model.change.tracking.CTModel<Calendar>
,com.liferay.portal.kernel.model.GroupedModel
,com.liferay.portal.kernel.model.LocalizedModel
,com.liferay.portal.kernel.model.MVCCModel
,Serializable
,com.liferay.portal.kernel.model.ShardedModel
,com.liferay.portal.kernel.model.StagedGroupedModel
,com.liferay.portal.kernel.model.StagedModel
- All Known Subinterfaces:
Calendar
- All Known Implementing Classes:
CalendarWrapper
@ProviderType
public interface CalendarModel
extends com.liferay.portal.kernel.model.BaseModel<Calendar>, com.liferay.portal.kernel.model.change.tracking.CTModel<Calendar>, com.liferay.portal.kernel.model.LocalizedModel, com.liferay.portal.kernel.model.MVCCModel, com.liferay.portal.kernel.model.ShardedModel, com.liferay.portal.kernel.model.StagedGroupedModel
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
.
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionString[]
long
Returns the calendar ID of this calendar.long
Returns the calendar resource ID of this calendar.int
getColor()
Returns the color of this calendar.long
Returns the company ID of this calendar.Returns the create date of this calendar.long
Returns the ct collection ID of this calendar.boolean
Returns the default calendar of this calendar.Returns the description of this calendar.getDescription
(String languageId) Returns the localized description of this calendar in the language.getDescription
(String languageId, boolean useDefault) Returns the localized description of this calendar in the language, optionally using the default language if no localization exists for the requested language.getDescription
(Locale locale) Returns the localized description of this calendar in the language.getDescription
(Locale locale, boolean useDefault) Returns the localized description of this calendar in the language, optionally using the default language if no localization exists for the requested language.Returns a map of the locales and localized descriptions of this calendar.boolean
Returns the enable comments of this calendar.boolean
Returns the enable ratings of this calendar.long
Returns the group ID of this calendar.Returns the last publish date of this calendar.Returns the modified date of this calendar.long
Returns the mvcc version of this calendar.getName()
Returns the name of this calendar.Returns the localized name of this calendar in the language.Returns the localized name of this calendar in the language, optionally using the default language if no localization exists for the requested language.Returns the localized name of this calendar in the language.Returns the localized name of this calendar in the language, optionally using the default language if no localization exists for the requested language.Returns a map of the locales and localized names of this calendar.long
Returns the primary key of this calendar.Returns the time zone ID of this calendar.long
Returns the user ID of this calendar.Returns the user name of this calendar.Returns the user uuid of this calendar.getUuid()
Returns the uuid of this calendar.boolean
Returnstrue
if this calendar is default calendar.boolean
Returnstrue
if this calendar is enable comments.boolean
Returnstrue
if this calendar is enable ratings.void
void
prepareLocalizedFieldsForImport
(Locale defaultImportLocale) void
setCalendarId
(long calendarId) Sets the calendar ID of this calendar.void
setCalendarResourceId
(long calendarResourceId) Sets the calendar resource ID of this calendar.void
setColor
(int color) Sets the color of this calendar.void
setCompanyId
(long companyId) Sets the company ID of this calendar.void
setCreateDate
(Date createDate) Sets the create date of this calendar.void
setCtCollectionId
(long ctCollectionId) Sets the ct collection ID of this calendar.void
setDefaultCalendar
(boolean defaultCalendar) Sets whether this calendar is default calendar.void
setDescription
(String description) Sets the description of this calendar.void
setDescription
(String description, Locale locale) Sets the localized description of this calendar in the language.void
setDescription
(String description, Locale locale, Locale defaultLocale) Sets the localized description of this calendar in the language, and sets the default locale.void
setDescriptionCurrentLanguageId
(String languageId) void
setDescriptionMap
(Map<Locale, String> descriptionMap) Sets the localized descriptions of this calendar from the map of locales and localized descriptions.void
setDescriptionMap
(Map<Locale, String> descriptionMap, Locale defaultLocale) Sets the localized descriptions of this calendar from the map of locales and localized descriptions, and sets the default locale.void
setEnableComments
(boolean enableComments) Sets whether this calendar is enable comments.void
setEnableRatings
(boolean enableRatings) Sets whether this calendar is enable ratings.void
setGroupId
(long groupId) Sets the group ID of this calendar.void
setLastPublishDate
(Date lastPublishDate) Sets the last publish date of this calendar.void
setModifiedDate
(Date modifiedDate) Sets the modified date of this calendar.void
setMvccVersion
(long mvccVersion) Sets the mvcc version of this calendar.void
Sets the name of this calendar.void
Sets the localized name of this calendar in the language.void
Sets the localized name of this calendar in the language, and sets the default locale.void
setNameCurrentLanguageId
(String languageId) void
setNameMap
(Map<Locale, String> nameMap) Sets the localized names of this calendar from the map of locales and localized names.void
setNameMap
(Map<Locale, String> nameMap, Locale defaultLocale) Sets the localized names of this calendar from the map of locales and localized names, and sets the default locale.void
setPrimaryKey
(long primaryKey) Sets the primary key of this calendar.void
setTimeZoneId
(String timeZoneId) Sets the time zone ID of this calendar.void
setUserId
(long userId) Sets the user ID of this calendar.void
setUserName
(String userName) Sets the user name of this calendar.void
setUserUuid
(String userUuid) Sets the user uuid of this calendar.void
Sets the uuid of this calendar.default String
Methods inherited from interface com.liferay.portal.kernel.model.BaseModel
clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel
Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassName
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone, getStagedModelType
-
Method Details
-
getPrimaryKey
long getPrimaryKey()Returns the primary key of this calendar.- Specified by:
getPrimaryKey
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<Calendar>
- Returns:
- the primary key of this calendar
-
setPrimaryKey
void setPrimaryKey(long primaryKey) Sets the primary key of this calendar.- Specified by:
setPrimaryKey
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<Calendar>
- Parameters:
primaryKey
- the primary key of this calendar
-
getMvccVersion
long getMvccVersion()Returns the mvcc version of this calendar.- Specified by:
getMvccVersion
in interfacecom.liferay.portal.kernel.model.MVCCModel
- Returns:
- the mvcc version of this calendar
-
setMvccVersion
void setMvccVersion(long mvccVersion) Sets the mvcc version of this calendar.- Specified by:
setMvccVersion
in interfacecom.liferay.portal.kernel.model.MVCCModel
- Parameters:
mvccVersion
- the mvcc version of this calendar
-
getCtCollectionId
long getCtCollectionId()Returns the ct collection ID of this calendar.- Specified by:
getCtCollectionId
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<Calendar>
- Returns:
- the ct collection ID of this calendar
-
setCtCollectionId
void setCtCollectionId(long ctCollectionId) Sets the ct collection ID of this calendar.- Specified by:
setCtCollectionId
in interfacecom.liferay.portal.kernel.model.change.tracking.CTModel<Calendar>
- Parameters:
ctCollectionId
- the ct collection ID of this calendar
-
getUuid
Returns the uuid of this calendar.- Specified by:
getUuid
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the uuid of this calendar
-
setUuid
Sets the uuid of this calendar.- Specified by:
setUuid
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
uuid
- the uuid of this calendar
-
getCalendarId
long getCalendarId()Returns the calendar ID of this calendar.- Returns:
- the calendar ID of this calendar
-
setCalendarId
void setCalendarId(long calendarId) Sets the calendar ID of this calendar.- Parameters:
calendarId
- the calendar ID of this calendar
-
getGroupId
long getGroupId()Returns the group ID of this calendar.- Specified by:
getGroupId
in interfacecom.liferay.portal.kernel.model.GroupedModel
- Returns:
- the group ID of this calendar
-
setGroupId
void setGroupId(long groupId) Sets the group ID of this calendar.- Specified by:
setGroupId
in interfacecom.liferay.portal.kernel.model.GroupedModel
- Parameters:
groupId
- the group ID of this calendar
-
getCompanyId
long getCompanyId()Returns the company ID of this calendar.- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Specified by:
getCompanyId
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the company ID of this calendar
-
setCompanyId
void setCompanyId(long companyId) Sets the company ID of this calendar.- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.ShardedModel
- Specified by:
setCompanyId
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
companyId
- the company ID of this calendar
-
getUserId
long getUserId()Returns the user ID of this calendar.- Specified by:
getUserId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user ID of this calendar
-
setUserId
void setUserId(long userId) Sets the user ID of this calendar.- Specified by:
setUserId
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userId
- the user ID of this calendar
-
getUserUuid
String getUserUuid()Returns the user uuid of this calendar.- Specified by:
getUserUuid
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user uuid of this calendar
-
setUserUuid
Sets the user uuid of this calendar.- Specified by:
setUserUuid
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userUuid
- the user uuid of this calendar
-
getUserName
Returns the user name of this calendar.- Specified by:
getUserName
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Returns:
- the user name of this calendar
-
setUserName
Sets the user name of this calendar.- Specified by:
setUserName
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Parameters:
userName
- the user name of this calendar
-
getCreateDate
Date getCreateDate()Returns the create date of this calendar.- Specified by:
getCreateDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getCreateDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the create date of this calendar
-
setCreateDate
Sets the create date of this calendar.- Specified by:
setCreateDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setCreateDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
createDate
- the create date of this calendar
-
getModifiedDate
Date getModifiedDate()Returns the modified date of this calendar.- Specified by:
getModifiedDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
getModifiedDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Returns:
- the modified date of this calendar
-
setModifiedDate
Sets the modified date of this calendar.- Specified by:
setModifiedDate
in interfacecom.liferay.portal.kernel.model.AuditedModel
- Specified by:
setModifiedDate
in interfacecom.liferay.portal.kernel.model.StagedModel
- Parameters:
modifiedDate
- the modified date of this calendar
-
getCalendarResourceId
long getCalendarResourceId()Returns the calendar resource ID of this calendar.- Returns:
- the calendar resource ID of this calendar
-
setCalendarResourceId
void setCalendarResourceId(long calendarResourceId) Sets the calendar resource ID of this calendar.- Parameters:
calendarResourceId
- the calendar resource ID of this calendar
-
getName
String getName()Returns the name of this calendar.- Returns:
- the name of this calendar
-
getName
Returns the localized name of this calendar in the language. Uses the default language if no localization exists for the requested language.- Parameters:
locale
- the locale of the language- Returns:
- the localized name of this calendar
-
getName
Returns the localized name of this calendar in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized name of this calendar. If
useDefault
isfalse
and no localization exists for the requested language, an empty string will be returned.
-
getName
Returns the localized name of this calendar in the language. Uses the default language if no localization exists for the requested language.- Parameters:
languageId
- the ID of the language- Returns:
- the localized name of this calendar
-
getName
Returns the localized name of this calendar in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized name of this calendar
-
getNameCurrentLanguageId
-
getNameCurrentValue
-
getNameMap
Returns a map of the locales and localized names of this calendar.- Returns:
- the locales and localized names of this calendar
-
setName
Sets the name of this calendar.- Parameters:
name
- the name of this calendar
-
setName
Sets the localized name of this calendar in the language.- Parameters:
name
- the localized name of this calendarlocale
- the locale of the language
-
setName
Sets the localized name of this calendar in the language, and sets the default locale.- Parameters:
name
- the localized name of this calendarlocale
- the locale of the languagedefaultLocale
- the default locale
-
setNameCurrentLanguageId
-
setNameMap
Sets the localized names of this calendar from the map of locales and localized names.- Parameters:
nameMap
- the locales and localized names of this calendar
-
setNameMap
Sets the localized names of this calendar from the map of locales and localized names, and sets the default locale.- Parameters:
nameMap
- the locales and localized names of this calendardefaultLocale
- the default locale
-
getDescription
String getDescription()Returns the description of this calendar.- Returns:
- the description of this calendar
-
getDescription
Returns the localized description of this calendar in the language. Uses the default language if no localization exists for the requested language.- Parameters:
locale
- the locale of the language- Returns:
- the localized description of this calendar
-
getDescription
Returns the localized description of this calendar in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
locale
- the local of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized description of this calendar. If
useDefault
isfalse
and no localization exists for the requested language, an empty string will be returned.
-
getDescription
Returns the localized description of this calendar in the language. Uses the default language if no localization exists for the requested language.- Parameters:
languageId
- the ID of the language- Returns:
- the localized description of this calendar
-
getDescription
Returns the localized description of this calendar in the language, optionally using the default language if no localization exists for the requested language.- Parameters:
languageId
- the ID of the languageuseDefault
- whether to use the default language if no localization exists for the requested language- Returns:
- the localized description of this calendar
-
getDescriptionCurrentLanguageId
-
getDescriptionCurrentValue
-
getDescriptionMap
Returns a map of the locales and localized descriptions of this calendar.- Returns:
- the locales and localized descriptions of this calendar
-
setDescription
Sets the description of this calendar.- Parameters:
description
- the description of this calendar
-
setDescription
Sets the localized description of this calendar in the language.- Parameters:
description
- the localized description of this calendarlocale
- the locale of the language
-
setDescription
Sets the localized description of this calendar in the language, and sets the default locale.- Parameters:
description
- the localized description of this calendarlocale
- the locale of the languagedefaultLocale
- the default locale
-
setDescriptionCurrentLanguageId
-
setDescriptionMap
Sets the localized descriptions of this calendar from the map of locales and localized descriptions.- Parameters:
descriptionMap
- the locales and localized descriptions of this calendar
-
setDescriptionMap
Sets the localized descriptions of this calendar from the map of locales and localized descriptions, and sets the default locale.- Parameters:
descriptionMap
- the locales and localized descriptions of this calendardefaultLocale
- the default locale
-
getTimeZoneId
Returns the time zone ID of this calendar.- Returns:
- the time zone ID of this calendar
-
setTimeZoneId
Sets the time zone ID of this calendar.- Parameters:
timeZoneId
- the time zone ID of this calendar
-
getColor
int getColor()Returns the color of this calendar.- Returns:
- the color of this calendar
-
setColor
void setColor(int color) Sets the color of this calendar.- Parameters:
color
- the color of this calendar
-
getDefaultCalendar
boolean getDefaultCalendar()Returns the default calendar of this calendar.- Returns:
- the default calendar of this calendar
-
isDefaultCalendar
boolean isDefaultCalendar()Returnstrue
if this calendar is default calendar.- Returns:
true
if this calendar is default calendar;false
otherwise
-
setDefaultCalendar
void setDefaultCalendar(boolean defaultCalendar) Sets whether this calendar is default calendar.- Parameters:
defaultCalendar
- the default calendar of this calendar
-
getEnableComments
boolean getEnableComments()Returns the enable comments of this calendar.- Returns:
- the enable comments of this calendar
-
isEnableComments
boolean isEnableComments()Returnstrue
if this calendar is enable comments.- Returns:
true
if this calendar is enable comments;false
otherwise
-
setEnableComments
void setEnableComments(boolean enableComments) Sets whether this calendar is enable comments.- Parameters:
enableComments
- the enable comments of this calendar
-
getEnableRatings
boolean getEnableRatings()Returns the enable ratings of this calendar.- Returns:
- the enable ratings of this calendar
-
isEnableRatings
boolean isEnableRatings()Returnstrue
if this calendar is enable ratings.- Returns:
true
if this calendar is enable ratings;false
otherwise
-
setEnableRatings
void setEnableRatings(boolean enableRatings) Sets whether this calendar is enable ratings.- Parameters:
enableRatings
- the enable ratings of this calendar
-
getLastPublishDate
Date getLastPublishDate()Returns the last publish date of this calendar.- Specified by:
getLastPublishDate
in interfacecom.liferay.portal.kernel.model.StagedGroupedModel
- Returns:
- the last publish date of this calendar
-
setLastPublishDate
Sets the last publish date of this calendar.- Specified by:
setLastPublishDate
in interfacecom.liferay.portal.kernel.model.StagedGroupedModel
- Parameters:
lastPublishDate
- the last publish date of this calendar
-
getAvailableLanguageIds
String[] getAvailableLanguageIds()- Specified by:
getAvailableLanguageIds
in interfacecom.liferay.portal.kernel.model.LocalizedModel
-
getDefaultLanguageId
String getDefaultLanguageId()- Specified by:
getDefaultLanguageId
in interfacecom.liferay.portal.kernel.model.LocalizedModel
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport() throws com.liferay.portal.kernel.exception.LocaleException- Specified by:
prepareLocalizedFieldsForImport
in interfacecom.liferay.portal.kernel.model.LocalizedModel
- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
prepareLocalizedFieldsForImport
void prepareLocalizedFieldsForImport(Locale defaultImportLocale) throws com.liferay.portal.kernel.exception.LocaleException - Specified by:
prepareLocalizedFieldsForImport
in interfacecom.liferay.portal.kernel.model.LocalizedModel
- Throws:
com.liferay.portal.kernel.exception.LocaleException
-
cloneWithOriginalValues
Calendar cloneWithOriginalValues()- Specified by:
cloneWithOriginalValues
in interfacecom.liferay.portal.kernel.model.BaseModel<Calendar>
-
toXmlString
-