Event (eXo PLF:: Calendar Service 5.0.3 API)

java.lang.Object
- org.exoplatform.calendar.model.AbstractModel
- - org.exoplatform.calendar.model.Event

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CalendarEvent
```
public class Event
extends AbstractModel
```
Version:

$Revision$

Author:

Trong Tran

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CANCELLED`
`static String`	`COMPLETED`
`static String`	`CONFIRMED`
`static String`	`DRAFT`
`static String[]`	`EVENT_STATUS`
`static String`	`FINAL`
`static String`	`IN_PROCESS`
`static String`	`IS_PRIVATE`
`static String`	`IS_PUBLIC`
`static String[]`	`JOURNAL_STATUS`
`static String`	`NEEDS_ACTION`
`static int`	`PRI_HIGH`
`static int`	`PRI_LOW`
`static int`	`PRI_MEDIUM`
`static int`	`PRI_UNDEFINED`
`static String[]`	`PRIORITY`
`static String`	`PRIORITY_HIGH`
`static String`	`PRIORITY_LOW`
`static String`	`PRIORITY_NONE`
`static String`	`PRIORITY_NORMAL`
`static String[]`	`REPEATTYPES`
`static String`	`RP_DAILY`
`static String`	`RP_MONTHLY`
`static String`	`RP_NOREPEAT`
`static String`	`RP_WEEKEND`
`static String`	`RP_WEEKLY`
`static String[]`	`RP_WEEKLY_BYDAY`
`static String`	`RP_WORKINGDAYS`
`static String`	`RP_YEARLY`
`static String`	`ST_AVAILABLE`
`static String`	`ST_BUSY`
`static String`	`ST_OUTSIDE`
`static String[]`	`TASK_STATUS`
`static String`	`TENTATIVE`
`static String`	`TYPE_EVENT`
`static String`	`TYPE_JOURNAL`
`static String`	`TYPE_TASK`

Constructor Summary

Constructors
Constructor and Description

Event()

Event(Event event)

Constructors
Constructor and Description
`Event()`
`Event(Event event)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExclusion(String id)` This method will add more excluded id to existed collection
`void`	`addParticipant(String parName, String status)`
`boolean`	`equals(Object o)`
`String`	`getActivityId()`
`List<Attachment>`	`getAttachment()`
`String`	`getCalendarId()`
`Date`	`getCompletedDateTime()`
`String`	`getDescription()`
`String`	`getEventCategoryId()`
`String`	`getEventCategoryName()`
`String`	`getEventState()`
`String`	`getEventType()`
`Collection<String>`	`getExclusions()`
`Date`	`getFromDateTime()`
`String[]`	`getInvitation()`
`Invitation[]`	`getInvitations()`
`Boolean`	`getIsExceptionOccurrence()`
`String`	`getLocation()`
`String`	`getMessage()`
`String`	`getOriginalReference()`
`String[]`	`getParticipant()`
`String[]`	`getParticipantStatus()`
`String`	`getPriority()`
`String`	`getRecurrenceId()`
`List<Reminder>`	`getReminders()`
`String[]`	`getRepeatByDay()`
`long[]`	`getRepeatByHour()`
`long[]`	`getRepeatByMinute()`
`long[]`	`getRepeatByMonth()`
`long[]`	`getRepeatByMonthDay()`
`long[]`	`getRepeatBySecond()`
`long[]`	`getRepeatBySetPos()`
`long[]`	`getRepeatByWeekNo()`
`long[]`	`getRepeatByYearDay()`
`long`	`getRepeatCount()`
`long`	`getRepeatInterval()`
`String`	`getRepeatType()`
`Date`	`getRepeatUntilDate()`
`String`	`getRepeatWkst()`
`String`	`getSendOption()`
`String`	`getStatus()` This method is always return EMPTY string because field status is not used in fact.
`Map<String,String>`	`getStatusMap()`
`String`	`getSummary()`
`String`	`getTaskDelegator()`
`Date`	`getToDateTime()`
`int`	`hashCode()`
`boolean`	`isEventDurationSmallerThanHalfHour()` used in template for rendering event differently if its duration smaller than 30 minutes
`boolean`	`isPrivate()`
`void`	`removeExclusion(String id)`
`void`	`removeParticipant(String parName)`
`void`	`setActivityId(String activityId)`
`void`	`setAttachment(List<Attachment> list)`
`void`	`setCalendarId(String calendarId)`
`void`	`setCompletedDateTime(Date completedDateTime)`
`void`	`setDescription(String description)`
`void`	`setEventCategoryId(String eventCategoryId)`
`void`	`setEventCategoryName(String eventCategoryName)`
`void`	`setEventState(String eventState)`
`void`	`setEventType(String eventType)`
`void`	`setExclusions(Collection<String> ids)` This method will set the collection of excluded event's id to the collection
`void`	`setFromDateTime(Date fromDateTime)`
`void`	`setInvitation(String[] invitation)`
`void`	`setIsExceptionOccurrence(Boolean isExceptionOccurrence)`
`void`	`setLocation(String location)`
`void`	`setMessage(String message)`
`void`	`setOriginalReference(String originalReference)`
`void`	`setParticipant(String[] participant)`
`void`	`setParticipantStatus(String[] participantStatus)`
`void`	`setPriority(String priority)`
`void`	`setPrivate(boolean isPrivate)`
`void`	`setRecurrenceId(String recurrenceId)`
`void`	`setReminders(List<Reminder> rm)`
`void`	`setRepeatByDay(String[] repeatByDay)`
`void`	`setRepeatByHour(long[] repeatByHour)`
`void`	`setRepeatByMinute(long[] repeatByMinute)`
`void`	`setRepeatByMonth(long[] repeatByMonth)`
`void`	`setRepeatByMonthDay(long[] repeatByMonthDay)`
`void`	`setRepeatBySecond(long[] repeatBySecond)`
`void`	`setRepeatBySetPos(long[] repeatBySetPos)`
`void`	`setRepeatByWeekNo(long[] repeatByWeekNo)`
`void`	`setRepeatByYearDay(long[] repeatByYearDay)`
`void`	`setRepeatCount(long repeatCount)`
`void`	`setRepeatInterval(long repeatInterval)`
`void`	`setRepeatType(String repeatType)`
`void`	`setRepeatUntilDate(Date repeatUntilDate)`
`void`	`setRepeatWkst(String repeatWkst)`
`void`	`setSendOption(String sendOption)`
`void`	`setStatus(String status)`
`void`	`setStatusMap(Map<String,String> statusMap)`
`void`	`setSummary(String sum)`
`void`	`setTaskDelegator(String taskDelegator)`
`void`	`setToDateTime(Date toDateTime)`

Methods inherited from class org.exoplatform.calendar.model.AbstractModel
getCompositeId, getDS, getId, getLastModified, setDS, setId, setLastModified

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_EVENT
```
public static final String TYPE_EVENT
```

TYPE_TASK
```
public static final String TYPE_TASK
```

TYPE_JOURNAL

public static final String TYPE_JOURNAL

TENTATIVE
```
public static final String TENTATIVE
```

CONFIRMED
```
public static final String CONFIRMED
```

CANCELLED
```
public static final String CANCELLED
```

NEEDS_ACTION

public static final String NEEDS_ACTION

COMPLETED
```
public static final String COMPLETED
```

IN_PROCESS
```
public static final String IN_PROCESS
```

PRIORITY_NONE

public static final String PRIORITY_NONE

PRIORITY_LOW

public static final String PRIORITY_LOW

PRIORITY_NORMAL

public static final String PRIORITY_NORMAL

PRIORITY_HIGH

public static final String PRIORITY_HIGH

PRI_UNDEFINED
```
public static final int PRI_UNDEFINED
```
See Also:

Constant Field Values

PRI_HIGH
```
public static final int PRI_HIGH
```
See Also:

Constant Field Values

PRI_MEDIUM
```
public static final int PRI_MEDIUM
```
See Also:

Constant Field Values

PRI_LOW
```
public static final int PRI_LOW
```
See Also:

Constant Field Values

PRIORITY
```
public static final String[] PRIORITY
```

DRAFT
```
public static final String DRAFT
```

FINAL
```
public static final String FINAL
```

EVENT_STATUS

public static final String[] EVENT_STATUS

TASK_STATUS

public static final String[] TASK_STATUS

JOURNAL_STATUS

public static final String[] JOURNAL_STATUS

IS_PUBLIC
```
public static final String IS_PUBLIC
```

IS_PRIVATE
```
public static final String IS_PRIVATE
```

ST_AVAILABLE

public static final String ST_AVAILABLE

ST_BUSY
```
public static final String ST_BUSY
```

ST_OUTSIDE
```
public static final String ST_OUTSIDE
```

RP_NOREPEAT
```
public static final String RP_NOREPEAT
```

RP_DAILY
```
public static final String RP_DAILY
```

RP_WEEKLY
```
public static final String RP_WEEKLY
```

RP_MONTHLY
```
public static final String RP_MONTHLY
```

RP_YEARLY
```
public static final String RP_YEARLY
```

RP_WEEKEND
```
public static final String RP_WEEKEND
```

RP_WORKINGDAYS

public static final String RP_WORKINGDAYS

RP_WEEKLY_BYDAY

public static final String[] RP_WEEKLY_BYDAY

REPEATTYPES

public static final String[] REPEATTYPES

Constructor Detail

Event
```
public Event()
```

Event
```
public Event(Event event)
```

Method Detail

getSummary
```
public String getSummary()
```

setSummary
```
public void setSummary(String sum)
```

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

isPrivate
```
public boolean isPrivate()
```

setPrivate

public void setPrivate(boolean isPrivate)

getEventCategoryId
```
public String getEventCategoryId()
```

setEventCategoryId

public void setEventCategoryId(String eventCategoryId)

getCalendarId
```
public String getCalendarId()
```

setCalendarId

public void setCalendarId(String calendarId)

getFromDateTime
```
public Date getFromDateTime()
```

setFromDateTime

public void setFromDateTime(Date fromDateTime)

getToDateTime
```
public Date getToDateTime()
```

setToDateTime

public void setToDateTime(Date toDateTime)

getCompletedDateTime
```
public Date getCompletedDateTime()
```

setCompletedDateTime

public void setCompletedDateTime(Date completedDateTime)

getLocation
```
public String getLocation()
```

setLocation

public void setLocation(String location)

getEventState
```
public String getEventState()
```

setEventState

public void setEventState(String eventState)

getStatus
```
public String getStatus()
```
This method is always return EMPTY string because field status is not used in fact.

Returns:

setStatus
```
public void setStatus(String status)
```

getEventType
```
public String getEventType()
```

setEventType

public void setEventType(String eventType)

getPriority
```
public String getPriority()
```

setPriority

public void setPriority(String priority)

getInvitation
```
public String[] getInvitation()
```

setInvitation

public void setInvitation(String[] invitation)

getReminders
```
public List<Reminder> getReminders()
```

setReminders

public void setReminders(List<Reminder> rm)

setRepeatType

public void setRepeatType(String repeatType)

getRepeatType
```
public String getRepeatType()
```

getAttachment

public List<Attachment> getAttachment()

setAttachment

public void setAttachment(List<Attachment> list)

setParticipant

public void setParticipant(String[] participant)

getParticipant
```
public String[] getParticipant()
```

getParticipantStatus

public String[] getParticipantStatus()

setParticipantStatus

public void setParticipantStatus(String[] participantStatus)

setTaskDelegator

public void setTaskDelegator(String taskDelegator)

getTaskDelegator
```
public String getTaskDelegator()
```

setEventCategoryName

public void setEventCategoryName(String eventCategoryName)

getEventCategoryName
```
public String getEventCategoryName()
```

setSendOption

public void setSendOption(String sendOption)

getSendOption
```
public String getSendOption()
```

getMessage
```
public String getMessage()
```

setMessage

public void setMessage(String message)

setRecurrenceId
```
public void setRecurrenceId(String recurrenceId)
```
Parameters:

recurrenceId - the recurrenceIndex to set

getRecurrenceId
```
public String getRecurrenceId()
```
Returns:

the recurrenceIndex

setIsExceptionOccurrence
```
public void setIsExceptionOccurrence(Boolean isExceptionOccurrence)
```
Parameters:

isExceptionOccurrence - the isExceptionOccurrence to set

getIsExceptionOccurrence
```
public Boolean getIsExceptionOccurrence()
```
Returns:

the isExceptionOccurrence

setExclusions
```
public void setExclusions(Collection<String> ids)
```
This method will set the collection of excluded event's id to the collection

Parameters:

ids - a collection of id with string type

getExclusions
```
public Collection<String> getExclusions()
```
Returns:

collection of excluded event's id

addExclusion
```
public void addExclusion(String id)
```
This method will add more excluded id to existed collection

Parameters:

id - a single id want to add to exited excluded collection

removeExclusion

public void removeExclusion(String id)

setRepeatUntilDate
```
public void setRepeatUntilDate(Date repeatUntilDate)
```
Parameters:

repeatUntilDate - the repeatUntilDate to set

getRepeatUntilDate
```
public Date getRepeatUntilDate()
```
Returns:

the repeatUntilDate

setOriginalReference
```
public void setOriginalReference(String originalReference)
```
Parameters:

originalReference - the originalReference to set

getOriginalReference
```
public String getOriginalReference()
```
Returns:

the originalReference

setRepeatCount
```
public void setRepeatCount(long repeatCount)
```
Parameters:

repeatCount - the repeatCount to set

getRepeatCount
```
public long getRepeatCount()
```
Returns:

the repeatCount

setRepeatInterval
```
public void setRepeatInterval(long repeatInterval)
```
Parameters:

repeatInterval - the repeatInterval to set

getRepeatInterval
```
public long getRepeatInterval()
```
Returns:

the repeatInterval

setRepeatBySecond
```
public void setRepeatBySecond(long[] repeatBySecond)
```
Parameters:

repeatBySecond - the repeatBySecond to set

getRepeatBySecond
```
public long[] getRepeatBySecond()
```
Returns:

the repeatBySecond

getRepeatByMinute
```
public long[] getRepeatByMinute()
```
Returns:

the repeatByMinute

setRepeatByMinute
```
public void setRepeatByMinute(long[] repeatByMinute)
```
Parameters:

repeatByMinute - the repeatByMinute to set

getRepeatByMonthDay
```
public long[] getRepeatByMonthDay()
```
Returns:

the repeatByMonthDay

setRepeatByMonthDay
```
public void setRepeatByMonthDay(long[] repeatByMonthDay)
```
Parameters:

repeatByMonthDay - the repeatByMonthDay to set

getRepeatByYearDay
```
public long[] getRepeatByYearDay()
```
Returns:

the repeatByYearDay

setRepeatByYearDay
```
public void setRepeatByYearDay(long[] repeatByYearDay)
```
Parameters:

repeatByYearDay - the repeatByYearDay to set

getRepeatByWeekNo
```
public long[] getRepeatByWeekNo()
```
Returns:

the repeatByWeekNo

setRepeatByWeekNo
```
public void setRepeatByWeekNo(long[] repeatByWeekNo)
```
Parameters:

repeatByWeekNo - the repeatByWeekNo to set

getRepeatByMonth
```
public long[] getRepeatByMonth()
```
Returns:

the repeatByMonth

setRepeatByMonth
```
public void setRepeatByMonth(long[] repeatByMonth)
```
Parameters:

repeatByMonth - the repeatByMonth to set

getRepeatBySetPos
```
public long[] getRepeatBySetPos()
```
Returns:

the repeatBySetPos

setRepeatBySetPos
```
public void setRepeatBySetPos(long[] repeatBySetPos)
```
Parameters:

repeatBySetPos - the repeatBySetPos to set

getRepeatWkst
```
public String getRepeatWkst()
```
Returns:

the repeatWkst

setRepeatWkst
```
public void setRepeatWkst(String repeatWkst)
```
Parameters:

repeatWkst - the repeatWkst to set

setRepeatByHour
```
public void setRepeatByHour(long[] repeatByHour)
```
Parameters:

repeatByHour - the repeatByHour to set

getRepeatByHour
```
public long[] getRepeatByHour()
```
Returns:

the repeatByHour

setRepeatByDay
```
public void setRepeatByDay(String[] repeatByDay)
```
Parameters:

repeatByDay - the repeatByDay to set

getRepeatByDay
```
public String[] getRepeatByDay()
```
Returns:

the repeatByDay

isEventDurationSmallerThanHalfHour
```
public boolean isEventDurationSmallerThanHalfHour()
```
used in template for rendering event differently if its duration smaller than 30 minutes

Returns:

true, false

getActivityId
```
public String getActivityId()
```

setActivityId

public void setActivityId(String activityId)

addParticipant

public void addParticipant(String parName,
                           String status)

removeParticipant

public void removeParticipant(String parName)

getInvitations
```
public Invitation[] getInvitations()
```

setStatusMap

public void setStatusMap(Map<String,String> statusMap)

getStatusMap

public Map<String,String> getStatusMap()

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class AbstractModel

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class AbstractModel

Class Event

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.exoplatform.calendar.model.AbstractModel

Methods inherited from class java.lang.Object

Field Detail

TYPE_EVENT

TYPE_TASK

TYPE_JOURNAL

TENTATIVE

CONFIRMED

CANCELLED

NEEDS_ACTION

COMPLETED

IN_PROCESS

PRIORITY_NONE

PRIORITY_LOW

PRIORITY_NORMAL

PRIORITY_HIGH

PRI_UNDEFINED

PRI_HIGH

PRI_MEDIUM

PRI_LOW

PRIORITY

DRAFT

FINAL

EVENT_STATUS

TASK_STATUS

JOURNAL_STATUS

IS_PUBLIC

IS_PRIVATE

ST_AVAILABLE

ST_BUSY

ST_OUTSIDE

RP_NOREPEAT

RP_DAILY

RP_WEEKLY

RP_MONTHLY

RP_YEARLY

RP_WEEKEND

RP_WORKINGDAYS

RP_WEEKLY_BYDAY

REPEATTYPES

Constructor Detail

Event

Event

Method Detail

getSummary

setSummary

getDescription

setDescription

isPrivate

setPrivate

getEventCategoryId

setEventCategoryId

getCalendarId

setCalendarId

getFromDateTime

setFromDateTime

getToDateTime

setToDateTime

getCompletedDateTime

setCompletedDateTime

getLocation

setLocation

getEventState

setEventState

getStatus

setStatus

getEventType

setEventType

getPriority

setPriority

getInvitation

setInvitation

getReminders

setReminders

setRepeatType

getRepeatType