com.liferay.calendar.model

Interface CalendarModel

All Superinterfaces:

AuditedModel, BaseModel<Calendar>, ClassedModel, java.lang.Cloneable, java.lang.Comparable<Calendar>, GroupedModel, LocalizedModel, MVCCModel, java.io.Serializable, ShardedModel, StagedGroupedModel, StagedModel

All Known Subinterfaces:

Calendar

All Known Implementing Classes:

CalendarWrapper

@ProviderType
public interface CalendarModel
extends BaseModel<Calendar>, LocalizedModel, MVCCModel, ShardedModel, 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:

Calendar

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getAvailableLanguageIds()
long	getCalendarId() Returns the calendar ID of this calendar.
long	getCalendarResourceId() Returns the calendar resource ID of this calendar.
int	getColor() Returns the color of this calendar.
long	getCompanyId() Returns the company ID of this calendar.
java.util.Date	getCreateDate() Returns the create date of this calendar.
boolean	getDefaultCalendar() Returns the default calendar of this calendar.
java.lang.String	getDefaultLanguageId()
java.lang.String	getDescription() Returns the description of this calendar.
java.lang.String	getDescription(java.util.Locale locale) Returns the localized description of this calendar in the language.
java.lang.String	getDescription(java.util.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.
java.lang.String	getDescription(java.lang.String languageId) Returns the localized description of this calendar in the language.
java.lang.String	getDescription(java.lang.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.
java.lang.String	getDescriptionCurrentLanguageId()
java.lang.String	getDescriptionCurrentValue()
java.util.Map<java.util.Locale,java.lang.String>	getDescriptionMap() Returns a map of the locales and localized descriptions of this calendar.
boolean	getEnableComments() Returns the enable comments of this calendar.
boolean	getEnableRatings() Returns the enable ratings of this calendar.
long	getGroupId() Returns the group ID of this calendar.
java.util.Date	getLastPublishDate() Returns the last publish date of this calendar.
java.util.Date	getModifiedDate() Returns the modified date of this calendar.
long	getMvccVersion() Returns the mvcc version of this calendar.
java.lang.String	getName() Returns the name of this calendar.
java.lang.String	getName(java.util.Locale locale) Returns the localized name of this calendar in the language.
java.lang.String	getName(java.util.Locale locale, boolean useDefault) Returns the localized name of this calendar in the language, optionally using the default language if no localization exists for the requested language.
java.lang.String	getName(java.lang.String languageId) Returns the localized name of this calendar in the language.
java.lang.String	getName(java.lang.String languageId, boolean useDefault) Returns the localized name of this calendar in the language, optionally using the default language if no localization exists for the requested language.
java.lang.String	getNameCurrentLanguageId()
java.lang.String	getNameCurrentValue()
java.util.Map<java.util.Locale,java.lang.String>	getNameMap() Returns a map of the locales and localized names of this calendar.
long	getPrimaryKey() Returns the primary key of this calendar.
java.lang.String	getTimeZoneId() Returns the time zone ID of this calendar.
long	getUserId() Returns the user ID of this calendar.
java.lang.String	getUserName() Returns the user name of this calendar.
java.lang.String	getUserUuid() Returns the user uuid of this calendar.
java.lang.String	getUuid() Returns the uuid of this calendar.
boolean	isDefaultCalendar() Returns true if this calendar is default calendar.
boolean	isEnableComments() Returns true if this calendar is enable comments.
boolean	isEnableRatings() Returns true if this calendar is enable ratings.
void	prepareLocalizedFieldsForImport()
void	prepareLocalizedFieldsForImport(java.util.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(java.util.Date createDate) Sets the create date of this calendar.
void	setDefaultCalendar(boolean defaultCalendar) Sets whether this calendar is default calendar.
void	setDescription(java.lang.String description) Sets the description of this calendar.
void	setDescription(java.lang.String description, java.util.Locale locale) Sets the localized description of this calendar in the language.
void	setDescription(java.lang.String description, java.util.Locale locale, java.util.Locale defaultLocale) Sets the localized description of this calendar in the language, and sets the default locale.
void	setDescriptionCurrentLanguageId(java.lang.String languageId)
void	setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap) Sets the localized descriptions of this calendar from the map of locales and localized descriptions.
void	setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.util.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(java.util.Date lastPublishDate) Sets the last publish date of this calendar.
void	setModifiedDate(java.util.Date modifiedDate) Sets the modified date of this calendar.
void	setMvccVersion(long mvccVersion) Sets the mvcc version of this calendar.
void	setName(java.lang.String name) Sets the name of this calendar.
void	setName(java.lang.String name, java.util.Locale locale) Sets the localized name of this calendar in the language.
void	setName(java.lang.String name, java.util.Locale locale, java.util.Locale defaultLocale) Sets the localized name of this calendar in the language, and sets the default locale.
void	setNameCurrentLanguageId(java.lang.String languageId)
void	setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap) Sets the localized names of this calendar from the map of locales and localized names.
void	setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.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(java.lang.String timeZoneId) Sets the time zone ID of this calendar.
void	setUserId(long userId) Sets the user ID of this calendar.
void	setUserName(java.lang.String userName) Sets the user name of this calendar.
void	setUserUuid(java.lang.String userUuid) Sets the user uuid of this calendar.
void	setUuid(java.lang.String uuid) Sets the uuid of this calendar.

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, toXmlString

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

getModelClass, getModelClassName

Methods inherited from interface com.liferay.portal.kernel.model.StagedModel

clone, getStagedModelType

Method Detail

getPrimaryKey

long getPrimaryKey()

Returns the primary key of this calendar.

Returns:

the primary key of this calendar

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this calendar.

Parameters:

primaryKey - the primary key of this calendar

getMvccVersion

long getMvccVersion()

Returns the mvcc version of this calendar.

Specified by:

getMvccVersion in interface MVCCModel

Returns:

the mvcc version of this calendar

setMvccVersion

void setMvccVersion(long mvccVersion)

Sets the mvcc version of this calendar.

Specified by:

setMvccVersion in interface MVCCModel

Parameters:

mvccVersion - the mvcc version of this calendar

getUuid

@AutoEscape
java.lang.String getUuid()

Returns the uuid of this calendar.

Specified by:

getUuid in interface StagedModel

Returns:

the uuid of this calendar

setUuid

void setUuid(java.lang.String uuid)

Sets the uuid of this calendar.

Specified by:

setUuid in interface 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 interface GroupedModel

Returns:

the group ID of this calendar

setGroupId

void setGroupId(long groupId)

Sets the group ID of this calendar.

Specified by:

setGroupId in interface GroupedModel

Parameters:

groupId - the group ID of this calendar

getCompanyId

long getCompanyId()

Returns the company ID of this calendar.

Specified by:

getCompanyId in interface AuditedModel

Specified by:

getCompanyId in interface ShardedModel

Specified by:

getCompanyId in interface StagedModel

Returns:

the company ID of this calendar

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this calendar.

Specified by:

setCompanyId in interface AuditedModel

Specified by:

setCompanyId in interface ShardedModel

Specified by:

setCompanyId in interface StagedModel

Parameters:

companyId - the company ID of this calendar

getUserId

long getUserId()

Returns the user ID of this calendar.

Specified by:

getUserId in interface AuditedModel

Returns:

the user ID of this calendar

setUserId

void setUserId(long userId)

Sets the user ID of this calendar.

Specified by:

setUserId in interface AuditedModel

Parameters:

userId - the user ID of this calendar

getUserUuid

java.lang.String getUserUuid()

Returns the user uuid of this calendar.

Specified by:

getUserUuid in interface AuditedModel

Returns:

the user uuid of this calendar

setUserUuid

void setUserUuid(java.lang.String userUuid)

Sets the user uuid of this calendar.

Specified by:

setUserUuid in interface AuditedModel

Parameters:

userUuid - the user uuid of this calendar

getUserName

@AutoEscape
java.lang.String getUserName()

Returns the user name of this calendar.

Specified by:

getUserName in interface AuditedModel

Returns:

the user name of this calendar

setUserName

void setUserName(java.lang.String userName)

Sets the user name of this calendar.

Specified by:

setUserName in interface AuditedModel

Parameters:

userName - the user name of this calendar

getCreateDate

java.util.Date getCreateDate()

Returns the create date of this calendar.

Specified by:

getCreateDate in interface AuditedModel

Specified by:

getCreateDate in interface StagedModel

Returns:

the create date of this calendar

setCreateDate

void setCreateDate(java.util.Date createDate)

Sets the create date of this calendar.

Specified by:

setCreateDate in interface AuditedModel

Specified by:

setCreateDate in interface StagedModel

Parameters:

createDate - the create date of this calendar

getModifiedDate

java.util.Date getModifiedDate()

Returns the modified date of this calendar.

Specified by:

getModifiedDate in interface AuditedModel

Specified by:

getModifiedDate in interface StagedModel

Returns:

the modified date of this calendar

setModifiedDate

void setModifiedDate(java.util.Date modifiedDate)

Sets the modified date of this calendar.

Specified by:

setModifiedDate in interface AuditedModel

Specified by:

setModifiedDate in interface 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

java.lang.String getName()

Returns the name of this calendar.

Returns:

the name of this calendar

getName

@AutoEscape
java.lang.String getName(java.util.Locale locale)

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

@AutoEscape
java.lang.String getName(java.util.Locale locale,
                                     boolean useDefault)

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 language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized name of this calendar. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getName

@AutoEscape
java.lang.String getName(java.lang.String languageId)

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

@AutoEscape
java.lang.String getName(java.lang.String languageId,
                                     boolean useDefault)

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 language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized name of this calendar

getNameCurrentLanguageId

@AutoEscape
java.lang.String getNameCurrentLanguageId()

getNameCurrentValue

@AutoEscape
java.lang.String getNameCurrentValue()

getNameMap

java.util.Map<java.util.Locale,java.lang.String> getNameMap()

Returns a map of the locales and localized names of this calendar.

Returns:

the locales and localized names of this calendar

setName

void setName(java.lang.String name)

Sets the name of this calendar.

Parameters:

name - the name of this calendar

setName

void setName(java.lang.String name,
             java.util.Locale locale)

Sets the localized name of this calendar in the language.

Parameters:

name - the localized name of this calendar

locale - the locale of the language

setName

void setName(java.lang.String name,
             java.util.Locale locale,
             java.util.Locale defaultLocale)

Sets the localized name of this calendar in the language, and sets the default locale.

Parameters:

name - the localized name of this calendar

locale - the locale of the language

defaultLocale - the default locale

setNameCurrentLanguageId

void setNameCurrentLanguageId(java.lang.String languageId)

setNameMap

void setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap)

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

void setNameMap(java.util.Map<java.util.Locale,java.lang.String> nameMap,
                java.util.Locale defaultLocale)

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 calendar

defaultLocale - the default locale

getDescription

java.lang.String getDescription()

Returns the description of this calendar.

Returns:

the description of this calendar

getDescription

@AutoEscape
java.lang.String getDescription(java.util.Locale locale)

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

@AutoEscape
java.lang.String getDescription(java.util.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.

Parameters:

locale - the local of the language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized description of this calendar. If useDefault is false and no localization exists for the requested language, an empty string will be returned.

getDescription

@AutoEscape
java.lang.String getDescription(java.lang.String languageId)

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

@AutoEscape
java.lang.String getDescription(java.lang.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.

Parameters:

languageId - the ID of the language

useDefault - whether to use the default language if no localization exists for the requested language

Returns:

the localized description of this calendar

getDescriptionCurrentLanguageId

@AutoEscape
java.lang.String getDescriptionCurrentLanguageId()

getDescriptionCurrentValue

@AutoEscape
java.lang.String getDescriptionCurrentValue()

getDescriptionMap

java.util.Map<java.util.Locale,java.lang.String> getDescriptionMap()

Returns a map of the locales and localized descriptions of this calendar.

Returns:

the locales and localized descriptions of this calendar

setDescription

void setDescription(java.lang.String description)

Sets the description of this calendar.

Parameters:

description - the description of this calendar

setDescription

void setDescription(java.lang.String description,
                    java.util.Locale locale)

Sets the localized description of this calendar in the language.

Parameters:

description - the localized description of this calendar

locale - the locale of the language

setDescription

void setDescription(java.lang.String description,
                    java.util.Locale locale,
                    java.util.Locale defaultLocale)

Sets the localized description of this calendar in the language, and sets the default locale.

Parameters:

description - the localized description of this calendar

locale - the locale of the language

defaultLocale - the default locale

setDescriptionCurrentLanguageId

void setDescriptionCurrentLanguageId(java.lang.String languageId)

setDescriptionMap

void setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap)

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

void setDescriptionMap(java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                       java.util.Locale defaultLocale)

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 calendar

defaultLocale - the default locale

getTimeZoneId

@AutoEscape
java.lang.String getTimeZoneId()

Returns the time zone ID of this calendar.

Returns:

the time zone ID of this calendar

setTimeZoneId

void setTimeZoneId(java.lang.String timeZoneId)

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()

Returns true 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()

Returns true 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()

Returns true 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

java.util.Date getLastPublishDate()

Returns the last publish date of this calendar.

Specified by:

getLastPublishDate in interface StagedGroupedModel

Returns:

the last publish date of this calendar

setLastPublishDate

void setLastPublishDate(java.util.Date lastPublishDate)

Sets the last publish date of this calendar.

Specified by:

setLastPublishDate in interface StagedGroupedModel

Parameters:

lastPublishDate - the last publish date of this calendar

getAvailableLanguageIds

java.lang.String[] getAvailableLanguageIds()

Specified by:

getAvailableLanguageIds in interface LocalizedModel

getDefaultLanguageId

java.lang.String getDefaultLanguageId()

Specified by:

getDefaultLanguageId in interface LocalizedModel

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport()
                              throws LocaleException

Specified by:

prepareLocalizedFieldsForImport in interface LocalizedModel

Throws:

LocaleException

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
                              throws LocaleException

Specified by:

prepareLocalizedFieldsForImport in interface LocalizedModel

Throws:

LocaleException