com.liferay.portlet.calendar.model
Interface CalEventModel

All Superinterfaces:

AuditedModel, BaseModel<CalEvent>, ClassedModel, Cloneable, Comparable<CalEvent>, GroupedModel, Serializable, StagedGroupedModel, StagedModel

All Known Subinterfaces:

CalEvent

All Known Implementing Classes:

CalEventWrapper

@ProviderType
public interface CalEventModel
extends BaseModel<CalEvent>, StagedGroupedModel

The base model interface for the CalEvent service. Represents a row in the "CalEvent" database table, with each column mapped to a property of this class.

This interface and its corresponding implementation CalEventModelImpl exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in CalEventImpl.

See Also:

CalEvent, CalEventImpl, CalEventModelImpl

Method Summary

Object	clone() Creates a shallow clone of this model instance.
int	compareTo(CalEvent calEvent)
boolean	getAllDay() Returns the all day of this cal event.
long	getCompanyId() Returns the company ID of this cal event.
Date	getCreateDate() Returns the create date of this cal event.
String	getDescription() Returns the description of this cal event.
int	getDurationHour() Returns the duration hour of this cal event.
int	getDurationMinute() Returns the duration minute of this cal event.
Date	getEndDate() Returns the end date of this cal event.
long	getEventId() Returns the event ID of this cal event.
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
int	getFirstReminder() Returns the first reminder of this cal event.
long	getGroupId() Returns the group ID of this cal event.
String	getLocation() Returns the location of this cal event.
Date	getModifiedDate() Returns the modified date of this cal event.
long	getPrimaryKey() Returns the primary key of this cal event.
Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
String	getRecurrence() Returns the recurrence of this cal event.
int	getRemindBy() Returns the remind by of this cal event.
boolean	getRepeating() Returns the repeating of this cal event.
int	getSecondReminder() Returns the second reminder of this cal event.
Date	getStartDate() Returns the start date of this cal event.
boolean	getTimeZoneSensitive() Returns the time zone sensitive of this cal event.
String	getTitle() Returns the title of this cal event.
String	getType() Returns the type of this cal event.
long	getUserId() Returns the user ID of this cal event.
String	getUserName() Returns the user name of this cal event.
String	getUserUuid() Returns the user uuid of this cal event.
String	getUuid() Returns the uuid of this cal event.
int	hashCode()
boolean	isAllDay() Returns true if this cal event is all day.
boolean	isCachedModel() Returns true if this model instance was retrieved from the entity cache.
boolean	isEscapedModel() Returns true if this model instance is escaped.
boolean	isNew() Returns true if this model instance does not yet exist in the database.
boolean	isRepeating() Returns true if this cal event is repeating.
boolean	isTimeZoneSensitive() Returns true if this cal event is time zone sensitive.
void	setAllDay(boolean allDay) Sets whether this cal event is all day.
void	setCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.
void	setCompanyId(long companyId) Sets the company ID of this cal event.
void	setCreateDate(Date createDate) Sets the create date of this cal event.
void	setDescription(String description) Sets the description of this cal event.
void	setDurationHour(int durationHour) Sets the duration hour of this cal event.
void	setDurationMinute(int durationMinute) Sets the duration minute of this cal event.
void	setEndDate(Date endDate) Sets the end date of this cal event.
void	setEventId(long eventId) Sets the event ID of this cal event.
void	setExpandoBridgeAttributes(BaseModel<?> baseModel)
void	setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
void	setExpandoBridgeAttributes(ServiceContext serviceContext) Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
void	setFirstReminder(int firstReminder) Sets the first reminder of this cal event.
void	setGroupId(long groupId) Sets the group ID of this cal event.
void	setLocation(String location) Sets the location of this cal event.
void	setModifiedDate(Date modifiedDate) Sets the modified date of this cal event.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setPrimaryKey(long primaryKey) Sets the primary key of this cal event.
void	setPrimaryKeyObj(Serializable primaryKeyObj) Sets the primary key of this model instance.
void	setRecurrence(String recurrence) Sets the recurrence of this cal event.
void	setRemindBy(int remindBy) Sets the remind by of this cal event.
void	setRepeating(boolean repeating) Sets whether this cal event is repeating.
void	setSecondReminder(int secondReminder) Sets the second reminder of this cal event.
void	setStartDate(Date startDate) Sets the start date of this cal event.
void	setTimeZoneSensitive(boolean timeZoneSensitive) Sets whether this cal event is time zone sensitive.
void	setTitle(String title) Sets the title of this cal event.
void	setType(String type) Sets the type of this cal event.
void	setUserId(long userId) Sets the user ID of this cal event.
void	setUserName(String userName) Sets the user name of this cal event.
void	setUserUuid(String userUuid) Sets the user uuid of this cal event.
void	setUuid(String uuid) Sets the uuid of this cal event.
CacheModel<CalEvent>	toCacheModel() Returns a cache model object for this entity used by entity cache.
CalEvent	toEscapedModel() Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
CalEvent	toUnescapedModel()
String	toXmlString() Returns the XML representation of this model instance.

Methods inherited from interface com.liferay.portal.model.BaseModel

getModelAttributes, resetOriginalValues, setModelAttributes

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

getModelClass, getModelClassName

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

getStagedModelType

Method Detail

getPrimaryKey

long getPrimaryKey()

Returns the primary key of this cal event.

Returns:

the primary key of this cal event

setPrimaryKey

void setPrimaryKey(long primaryKey)

Sets the primary key of this cal event.

Parameters:

primaryKey - the primary key of this cal event

getUuid

@AutoEscape
String getUuid()

Returns the uuid of this cal event.

Specified by:

getUuid in interface StagedModel

Returns:

the uuid of this cal event

setUuid

void setUuid(String uuid)

Sets the uuid of this cal event.

Specified by:

setUuid in interface StagedModel

Parameters:

uuid - the uuid of this cal event

getEventId

long getEventId()

Returns the event ID of this cal event.

Returns:

the event ID of this cal event

setEventId

void setEventId(long eventId)

Sets the event ID of this cal event.

Parameters:

eventId - the event ID of this cal event

getGroupId

long getGroupId()

Returns the group ID of this cal event.

Specified by:

getGroupId in interface GroupedModel

Returns:

the group ID of this cal event

setGroupId

void setGroupId(long groupId)

Sets the group ID of this cal event.

Specified by:

setGroupId in interface GroupedModel

Parameters:

groupId - the group ID of this cal event

getCompanyId

long getCompanyId()

Returns the company ID of this cal event.

Specified by:

getCompanyId in interface AuditedModel

Specified by:

getCompanyId in interface StagedModel

Returns:

the company ID of this cal event

setCompanyId

void setCompanyId(long companyId)

Sets the company ID of this cal event.

Specified by:

setCompanyId in interface AuditedModel

Specified by:

setCompanyId in interface StagedModel

Parameters:

companyId - the company ID of this cal event

getUserId

long getUserId()

Returns the user ID of this cal event.

Specified by:

getUserId in interface AuditedModel

Returns:

the user ID of this cal event

setUserId

void setUserId(long userId)

Sets the user ID of this cal event.

Specified by:

setUserId in interface AuditedModel

Parameters:

userId - the user ID of this cal event

getUserUuid

String getUserUuid()
                   throws SystemException

Returns the user uuid of this cal event.

Specified by:

getUserUuid in interface AuditedModel

Returns:

the user uuid of this cal event

Throws:

SystemException - if a system exception occurred

setUserUuid

void setUserUuid(String userUuid)

Sets the user uuid of this cal event.

Specified by:

setUserUuid in interface AuditedModel

Parameters:

userUuid - the user uuid of this cal event

getUserName

@AutoEscape
String getUserName()

Returns the user name of this cal event.

Specified by:

getUserName in interface AuditedModel

Returns:

the user name of this cal event

setUserName

void setUserName(String userName)

Sets the user name of this cal event.

Specified by:

setUserName in interface AuditedModel

Parameters:

userName - the user name of this cal event

getCreateDate

Date getCreateDate()

Returns the create date of this cal event.

Specified by:

getCreateDate in interface AuditedModel

Specified by:

getCreateDate in interface StagedModel

Returns:

the create date of this cal event

setCreateDate

void setCreateDate(Date createDate)

Sets the create date of this cal event.

Specified by:

setCreateDate in interface AuditedModel

Specified by:

setCreateDate in interface StagedModel

Parameters:

createDate - the create date of this cal event

getModifiedDate

Date getModifiedDate()

Returns the modified date of this cal event.

Specified by:

getModifiedDate in interface AuditedModel

Specified by:

getModifiedDate in interface StagedModel

Returns:

the modified date of this cal event

setModifiedDate

void setModifiedDate(Date modifiedDate)

Sets the modified date of this cal event.

Specified by:

setModifiedDate in interface AuditedModel

Specified by:

setModifiedDate in interface StagedModel

Parameters:

modifiedDate - the modified date of this cal event

getTitle

@AutoEscape
String getTitle()

Returns the title of this cal event.

Returns:

the title of this cal event

setTitle

void setTitle(String title)

Sets the title of this cal event.

Parameters:

title - the title of this cal event

getDescription

@AutoEscape
String getDescription()

Returns the description of this cal event.

Returns:

the description of this cal event

setDescription

void setDescription(String description)

Sets the description of this cal event.

Parameters:

description - the description of this cal event

getLocation

@AutoEscape
String getLocation()

Returns the location of this cal event.

Returns:

the location of this cal event

setLocation

void setLocation(String location)

Sets the location of this cal event.

Parameters:

location - the location of this cal event

getStartDate

Date getStartDate()

Returns the start date of this cal event.

Returns:

the start date of this cal event

setStartDate

void setStartDate(Date startDate)

Sets the start date of this cal event.

Parameters:

startDate - the start date of this cal event

getEndDate

Date getEndDate()

Returns the end date of this cal event.

Returns:

the end date of this cal event

setEndDate

void setEndDate(Date endDate)

Sets the end date of this cal event.

Parameters:

endDate - the end date of this cal event

getDurationHour

int getDurationHour()

Returns the duration hour of this cal event.

Returns:

the duration hour of this cal event

setDurationHour

void setDurationHour(int durationHour)

Sets the duration hour of this cal event.

Parameters:

durationHour - the duration hour of this cal event

getDurationMinute

int getDurationMinute()

Returns the duration minute of this cal event.

Returns:

the duration minute of this cal event

setDurationMinute

void setDurationMinute(int durationMinute)

Sets the duration minute of this cal event.

Parameters:

durationMinute - the duration minute of this cal event

getAllDay

boolean getAllDay()

Returns the all day of this cal event.

Returns:

the all day of this cal event

isAllDay

boolean isAllDay()

Returns true if this cal event is all day.

Returns:

true if this cal event is all day; false otherwise

setAllDay

void setAllDay(boolean allDay)

Sets whether this cal event is all day.

Parameters:

allDay - the all day of this cal event

getTimeZoneSensitive

boolean getTimeZoneSensitive()

Returns the time zone sensitive of this cal event.

Returns:

the time zone sensitive of this cal event

isTimeZoneSensitive

boolean isTimeZoneSensitive()

Returns true if this cal event is time zone sensitive.

Returns:

true if this cal event is time zone sensitive; false otherwise

setTimeZoneSensitive

void setTimeZoneSensitive(boolean timeZoneSensitive)

Sets whether this cal event is time zone sensitive.

Parameters:

timeZoneSensitive - the time zone sensitive of this cal event

getType

@AutoEscape
String getType()

Returns the type of this cal event.

Returns:

the type of this cal event

setType

void setType(String type)

Sets the type of this cal event.

Parameters:

type - the type of this cal event

getRepeating

boolean getRepeating()

Returns the repeating of this cal event.

Returns:

the repeating of this cal event

isRepeating

boolean isRepeating()

Returns true if this cal event is repeating.

Returns:

true if this cal event is repeating; false otherwise

setRepeating

void setRepeating(boolean repeating)

Sets whether this cal event is repeating.

Parameters:

repeating - the repeating of this cal event

getRecurrence

String getRecurrence()

Returns the recurrence of this cal event.

Returns:

the recurrence of this cal event

setRecurrence

void setRecurrence(String recurrence)

Sets the recurrence of this cal event.

Parameters:

recurrence - the recurrence of this cal event

getRemindBy

int getRemindBy()

Returns the remind by of this cal event.

Returns:

the remind by of this cal event

setRemindBy

void setRemindBy(int remindBy)

Sets the remind by of this cal event.

Parameters:

remindBy - the remind by of this cal event

getFirstReminder

int getFirstReminder()

Returns the first reminder of this cal event.

Returns:

the first reminder of this cal event

setFirstReminder

void setFirstReminder(int firstReminder)

Sets the first reminder of this cal event.

Parameters:

firstReminder - the first reminder of this cal event

getSecondReminder

int getSecondReminder()

Returns the second reminder of this cal event.

Returns:

the second reminder of this cal event

setSecondReminder

void setSecondReminder(int secondReminder)

Sets the second reminder of this cal event.

Parameters:

secondReminder - the second reminder of this cal event

isNew

boolean isNew()

Description copied from interface: BaseModel

Returns true if this model instance does not yet exist in the database.

Specified by:

isNew in interface BaseModel<CalEvent>

Returns:

true if this model instance does not yet exist in the database; false otherwise

setNew

void setNew(boolean n)

Description copied from interface: BaseModel

Sets whether this model instance does not yet exist in the database.

Specified by:

setNew in interface BaseModel<CalEvent>

Parameters:

n - whether this model instance does not yet exist in the database

isCachedModel

boolean isCachedModel()

Description copied from interface: BaseModel

Returns true if this model instance was retrieved from the entity cache.

Specified by:

isCachedModel in interface BaseModel<CalEvent>

Returns:

true if this model instance was retrieved from the entity cache; false otherwise

See Also:

BaseModel.setCachedModel(boolean)

setCachedModel

void setCachedModel(boolean cachedModel)

Description copied from interface: BaseModel

Sets whether this model instance was retrieved from the entity cache.

Specified by:

setCachedModel in interface BaseModel<CalEvent>

Parameters:

cachedModel - whether this model instance was retrieved from the entity cache

See Also:

EntityCache

isEscapedModel

boolean isEscapedModel()

Description copied from interface: BaseModel

Returns true if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<CalEvent>

Returns:

true if this model instance is escaped; false otherwise

getPrimaryKeyObj

Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Returns the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<CalEvent>

Specified by:

getPrimaryKeyObj in interface ClassedModel

Returns:

the primary key of this model instance

setPrimaryKeyObj

void setPrimaryKeyObj(Serializable primaryKeyObj)

Description copied from interface: BaseModel

Sets the primary key of this model instance.

Specified by:

setPrimaryKeyObj in interface BaseModel<CalEvent>

Specified by:

setPrimaryKeyObj in interface ClassedModel

Parameters:

primaryKeyObj - the primary key of this model instance

getExpandoBridge

ExpandoBridge getExpandoBridge()

Description copied from interface: BaseModel

Returns the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface BaseModel<CalEvent>

Specified by:

getExpandoBridge in interface ClassedModel

Returns:

the expando bridge for this model instance

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(BaseModel<?> baseModel)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<CalEvent>

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<CalEvent>

setExpandoBridgeAttributes

void setExpandoBridgeAttributes(ServiceContext serviceContext)

Description copied from interface: BaseModel

Sets the expando bridge attributes for this model instance to the attributes stored in the service context.

Specified by:

setExpandoBridgeAttributes in interface BaseModel<CalEvent>

Parameters:

serviceContext - the service context to be applied

See Also:

ServiceContext.getExpandoBridgeAttributes( )

clone

Object clone()

Description copied from interface: BaseModel

Creates a shallow clone of this model instance.

Specified by:

clone in interface BaseModel<CalEvent>

Specified by:

clone in interface StagedModel

Returns:

the shallow clone of this model instance

compareTo

int compareTo(CalEvent calEvent)

Specified by:

compareTo in interface Comparable<CalEvent>

hashCode

int hashCode()

Overrides:

hashCode in class Object

toCacheModel

CacheModel<CalEvent> toCacheModel()

Description copied from interface: BaseModel

Returns a cache model object for this entity used by entity cache.

Specified by:

toCacheModel in interface BaseModel<CalEvent>

Returns:

the cache model object

toEscapedModel

CalEvent toEscapedModel()

Description copied from interface: BaseModel

Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:

toEscapedModel in interface BaseModel<CalEvent>

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toUnescapedModel

CalEvent toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<CalEvent>

toString

String toString()

Overrides:

toString in class Object

toXmlString

String toXmlString()

Description copied from interface: BaseModel

Returns the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<CalEvent>

Returns:

the XML representation of this model instance