BaseEventStamp (cosmo-api 3.2.0 API)

All Superinterfaces:

AuditableObject, Stamp

All Known Subinterfaces:

EventExceptionStamp, EventStamp
```
public interface BaseEventStamp
extends Stamp
```
Represents a stamp that contains event specific information.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`creatDisplayAlarm()` Create and add new display alarm on event.
`void`	`createCalendar()` Initializes the Calendar with a default master event.
`Boolean`	`getAnyTime()` Same as isAnyTime()
`net.fortuna.ical4j.model.component.VAlarm`	`getDisplayAlarm()` Return the first display alarm on the event
`String`	`getDisplayAlarmDescription()` Return the description of the first display alarm on the event.
`net.fortuna.ical4j.model.Dur`	`getDisplayAlarmDuration()` Return the duration of the first display alarm on the event
`Integer`	`getDisplayAlarmRepeat()` Return the repeat count on the first display alarm on the event
`net.fortuna.ical4j.model.property.Trigger`	`getDisplayAlarmTrigger()` Return the Trigger of the first display alarm on the event
`net.fortuna.ical4j.model.Dur`	`getDuration()` Returns the duration of the event as calculated from the iCalendar DURATION property value or the the iCalendar DTEND - DTSTART.
`net.fortuna.ical4j.model.Date`	`getEndDate()` Returns the end date of the event as calculated from the iCalendar DTEND property value or the the iCalendar DTSTART + DURATION.
`net.fortuna.ical4j.model.component.VEvent`	`getEvent()` Get the underlying VEvent
`net.fortuna.ical4j.model.Calendar`	`getEventCalendar()` Get the Calendar that contains the VEvent
`net.fortuna.ical4j.model.DateList`	`getExceptionDates()` Returns a list of copies of the values of all iCalendar EXDATE properties of the event (can be empty).
`List<net.fortuna.ical4j.model.Recur>`	`getExceptionRules()` Returns a list of copies of the iCalendar EXRULE property values of the event (can be empty).
`String`	`getIcalUid()` Returns a copy of the the iCalendar UID property value of the event .
`String`	`getLocation()` Returns a copy of the the iCalendar LOCATION property value of the event (can be null).
`net.fortuna.ical4j.model.DateList`	`getRecurrenceDates()` Returns a list of copies of the iCalendar RDATE property values of the event (can be empty).
`net.fortuna.ical4j.model.Date`	`getRecurrenceId()` Returns a copy of the the iCalendar RECURRENCE_ID property value of the event (can be null).
`List<net.fortuna.ical4j.model.Recur>`	`getRecurrenceRules()` Returns a list of copies of the iCalendar RRULE property values of the event (can be empty).
`net.fortuna.ical4j.model.Date`	`getStartDate()` Returns a copy of the the iCalendar DTSTART property value of the event (never null).
`String`	`getStatus()` Returns a copy of the the iCalendar STATUS property value of the event (can be null).
`Boolean`	`isAnyTime()` Is the event marked as anytime.
`boolean`	`isRecurring()` Determine if an event is recurring
`void`	`removeDisplayAlarm()` Remove first display alarm on the event
`void`	`setAnyTime(Boolean isAnyTime)` Toggle the event anytime parameter.
`void`	`setDescription(String text)` Sets the iCalendar DESCRIPTION property of the event.
`void`	`setDisplayAlarmDescription(String newDescription)` Set the description of the first display alarm on the event.
`void`	`setDisplayAlarmDuration(net.fortuna.ical4j.model.Dur dur)` Set the durcation of the first display alarm on the event
`void`	`setDisplayAlarmRepeat(Integer count)` Set the repeat count on the first display alarm on the event.
`void`	`setDisplayAlarmTrigger(net.fortuna.ical4j.model.property.Trigger newTrigger)` Set the trigger property of the first display alarm on the event.
`void`	`setDisplayAlarmTriggerDate(net.fortuna.ical4j.model.DateTime triggerDate)` Set the trigger property of the first display alarm on the event to be a absolute trigger.
`void`	`setDuration(net.fortuna.ical4j.model.Dur dur)` Sets the iCalendar DURATION property of the event.
`void`	`setEndDate(net.fortuna.ical4j.model.Date date)` Sets the iCalendar DTEND property of the event.
`void`	`setEventCalendar(net.fortuna.ical4j.model.Calendar calendar)` Set the Calendar that contains the VEvent
`void`	`setExceptionDates(net.fortuna.ical4j.model.DateList dates)` Sets a single iCalendar EXDATE property of the event, removing any EXDATEs that were previously set.
`void`	`setExceptionRules(List<net.fortuna.ical4j.model.Recur> recurs)` Sets the iCalendar EXRULE properties of the event, removing any EXRULEs that were previously set.
`void`	`setIcalUid(String uid)` Sets the iCalendar UID property of the event.
`void`	`setLocation(String text)` Sets the iCalendar LOCATION property of the event.
`void`	`setRecurrenceDates(net.fortuna.ical4j.model.DateList dates)` Sets a single iCalendar RDATE property of the event, removing any RDATEs that were previously set.
`void`	`setRecurrenceId(net.fortuna.ical4j.model.Date date)` Sets the iCalendar RECURRENCE_ID property of the event.
`void`	`setRecurrenceRule(net.fortuna.ical4j.model.Recur recur)` Sets a single iCalendar RRULE property of the event, removing any RRULEs that were previously set.
`void`	`setRecurrenceRules(List<net.fortuna.ical4j.model.Recur> recurs)` Sets the iCalendar RRULE properties of the event, removing any RRULEs that were previously set.
`void`	`setStartDate(net.fortuna.ical4j.model.Date date)` Sets the iCalendar DTSTART property of the event.
`void`	`setStatus(String text)` Sets the iCalendar STATUS property of the event.
`void`	`setSummary(String text)` Sets the iCalendar SUMMARY property of the event.

Methods inherited from interface org.unitedinternet.cosmo.model.Stamp
copy, getItem, getType, setItem, updateTimestamp

Methods inherited from interface org.unitedinternet.cosmo.model.AuditableObject
getCreationDate, getEntityTag, getFactory, getModifiedDate

- Method Detail
  - getEvent
```
net.fortuna.ical4j.model.component.VEvent getEvent()
```
    Get the underlying VEvent
    
    Returns:
    
    VEvent
  - getEventCalendar
```
net.fortuna.ical4j.model.Calendar getEventCalendar()
```
    Get the Calendar that contains the VEvent
    
    Returns:
    
    Calendar containing VEvent
  - setEventCalendar
```
void setEventCalendar(net.fortuna.ical4j.model.Calendar calendar)
```
    Set the Calendar that contains the VEvent
    
    Parameters:
    
    calendar - Calendar containing VEvent
  - getIcalUid
```
String getIcalUid()
```
    Returns a copy of the the iCalendar UID property value of the event .
  - setIcalUid
```
void setIcalUid(String uid)
```
    Sets the iCalendar UID property of the event.
    
    Parameters:
    
    uid - uid of VEVENT
  - setSummary
```
void setSummary(String text)
```
    Sets the iCalendar SUMMARY property of the event.
    
    Parameters:
    
    text - a text string
  - setDescription
```
void setDescription(String text)
```
    Sets the iCalendar DESCRIPTION property of the event.
    
    Parameters:
    
    text - a text string
  - getStartDate
```
net.fortuna.ical4j.model.Date getStartDate()
```
    Returns a copy of the the iCalendar DTSTART property value of the event (never null).
  - setStartDate
```
void setStartDate(net.fortuna.ical4j.model.Date date)
```
    Sets the iCalendar DTSTART property of the event.
    
    Parameters:
    
    date - a Date
  - getEndDate
```
net.fortuna.ical4j.model.Date getEndDate()
```
    Returns the end date of the event as calculated from the iCalendar DTEND property value or the the iCalendar DTSTART + DURATION.
  - setEndDate
```
void setEndDate(net.fortuna.ical4j.model.Date date)
```
    Sets the iCalendar DTEND property of the event.
    
    Parameters:
    
    date - a Date
  - getDuration
```
net.fortuna.ical4j.model.Dur getDuration()
```
    Returns the duration of the event as calculated from the iCalendar DURATION property value or the the iCalendar DTEND - DTSTART.
  - setDuration
```
void setDuration(net.fortuna.ical4j.model.Dur dur)
```
    Sets the iCalendar DURATION property of the event.
    
    Parameters:
    
    dur - a Dur
  - getLocation
```
String getLocation()
```
    Returns a copy of the the iCalendar LOCATION property value of the event (can be null).
  - setLocation
```
void setLocation(String text)
```
    Sets the iCalendar LOCATION property of the event.
    
    Parameters:
    
    text - a text string
  - getRecurrenceRules
```
List<net.fortuna.ical4j.model.Recur> getRecurrenceRules()
```
    Returns a list of copies of the iCalendar RRULE property values of the event (can be empty).
  - setRecurrenceRules
```
void setRecurrenceRules(List<net.fortuna.ical4j.model.Recur> recurs)
```
    Sets the iCalendar RRULE properties of the event, removing any RRULEs that were previously set.
    
    Parameters:
    
    recurs - a List of Recurs
  - setRecurrenceRule
```
void setRecurrenceRule(net.fortuna.ical4j.model.Recur recur)
```
    Sets a single iCalendar RRULE property of the event, removing any RRULEs that were previously set.
    
    Parameters:
    
    recur - a Recur
  - getExceptionRules
```
List<net.fortuna.ical4j.model.Recur> getExceptionRules()
```
    Returns a list of copies of the iCalendar EXRULE property values of the event (can be empty).
  - setExceptionRules
```
void setExceptionRules(List<net.fortuna.ical4j.model.Recur> recurs)
```
    Sets the iCalendar EXRULE properties of the event, removing any EXRULEs that were previously set.
    
    Parameters:
    
    recurs - a List of Recurs
  - getRecurrenceDates
```
net.fortuna.ical4j.model.DateList getRecurrenceDates()
```
    Returns a list of copies of the iCalendar RDATE property values of the event (can be empty).
  - setRecurrenceDates
```
void setRecurrenceDates(net.fortuna.ical4j.model.DateList dates)
```
    Sets a single iCalendar RDATE property of the event, removing any RDATEs that were previously set.
    
    Parameters:
    
    dates - a DateList
  - getExceptionDates
```
net.fortuna.ical4j.model.DateList getExceptionDates()
```
    Returns a list of copies of the values of all iCalendar EXDATE properties of the event (can be empty).
  - getDisplayAlarm
```
net.fortuna.ical4j.model.component.VAlarm getDisplayAlarm()
```
    Return the first display alarm on the event
    
    Returns:
    
    first display alarm on event
  - removeDisplayAlarm
```
void removeDisplayAlarm()
```
    Remove first display alarm on the event
  - getDisplayAlarmDescription
```
String getDisplayAlarmDescription()
```
    Return the description of the first display alarm on the event.
    
    Returns:
    
    alarm description
  - setDisplayAlarmDescription
```
void setDisplayAlarmDescription(String newDescription)
```
    Set the description of the first display alarm on the event.
    
    Parameters:
    
    newDescription - display alarm description
  - getDisplayAlarmTrigger
```
net.fortuna.ical4j.model.property.Trigger getDisplayAlarmTrigger()
```
    Return the Trigger of the first display alarm on the event
    
    Returns:
    
    trigger of the first display alarm
  - setDisplayAlarmTrigger
```
void setDisplayAlarmTrigger(net.fortuna.ical4j.model.property.Trigger newTrigger)
```
    Set the trigger property of the first display alarm on the event.
    
    Parameters:
    
    newTrigger - trigger
  - setDisplayAlarmTriggerDate
```
void setDisplayAlarmTriggerDate(net.fortuna.ical4j.model.DateTime triggerDate)
```
    Set the trigger property of the first display alarm on the event to be a absolute trigger.
    
    Parameters:
    
    triggerDate - date display alarm triggers
  - getDisplayAlarmDuration
```
net.fortuna.ical4j.model.Dur getDisplayAlarmDuration()
```
    Return the duration of the first display alarm on the event
    
    Returns:
    
    duration of the first display alarm
  - setDisplayAlarmDuration
```
void setDisplayAlarmDuration(net.fortuna.ical4j.model.Dur dur)
```
    Set the durcation of the first display alarm on the event
    
    Parameters:
    
    dur - duration
  - getDisplayAlarmRepeat
```
Integer getDisplayAlarmRepeat()
```
    Return the repeat count on the first display alarm on the event
    
    Returns:
    
    repeat count of the first display alarm on the event
  - setDisplayAlarmRepeat
```
void setDisplayAlarmRepeat(Integer count)
```
    Set the repeat count on the first display alarm on the event.
    
    Parameters:
    
    count - repeat count of the first display alarm.
  - setExceptionDates
```
void setExceptionDates(net.fortuna.ical4j.model.DateList dates)
```
    Sets a single iCalendar EXDATE property of the event, removing any EXDATEs that were previously set.
    
    Parameters:
    
    dates - a DateList
  - getRecurrenceId
```
net.fortuna.ical4j.model.Date getRecurrenceId()
```
    Returns a copy of the the iCalendar RECURRENCE_ID property value of the event (can be null).
  - setRecurrenceId
```
void setRecurrenceId(net.fortuna.ical4j.model.Date date)
```
    Sets the iCalendar RECURRENCE_ID property of the event.
    
    Parameters:
    
    date - a Date
  - getStatus
```
String getStatus()
```
    Returns a copy of the the iCalendar STATUS property value of the event (can be null).
  - setStatus
```
void setStatus(String text)
```
    Sets the iCalendar STATUS property of the event.
    
    Parameters:
    
    text - a text string
  - isAnyTime
```
Boolean isAnyTime()
```
    Is the event marked as anytime.
    
    Returns:
    
    true if the event is an anytime event
  - getAnyTime
```
Boolean getAnyTime()
```
    Same as isAnyTime()
    
    Returns:
    
    true if the event is an anytime event
  - setAnyTime
```
void setAnyTime(Boolean isAnyTime)
```
    Toggle the event anytime parameter.
    
    Parameters:
    
    isAnyTime - true if the event occurs anytime
  - createCalendar
```
void createCalendar()
```
    Initializes the Calendar with a default master event. Initializes the master event using the underlying item's icalUid (if NoteItem) or uid.
  - isRecurring
```
boolean isRecurring()
```
    Determine if an event is recurring
    
    Returns:
    
    true if the underlying event is a recurring event
  - creatDisplayAlarm
```
void creatDisplayAlarm()
```
    Create and add new display alarm on event.

Interface BaseEventStamp

Method Summary

Methods inherited from interface org.unitedinternet.cosmo.model.Stamp

Methods inherited from interface org.unitedinternet.cosmo.model.AuditableObject

Method Detail

getEvent

getEventCalendar

setEventCalendar

getIcalUid

setIcalUid

setSummary

setDescription

getStartDate

setStartDate

getEndDate

setEndDate

getDuration

setDuration

getLocation

setLocation

getRecurrenceRules

setRecurrenceRules

setRecurrenceRule

getExceptionRules

setExceptionRules

getRecurrenceDates

setRecurrenceDates

getExceptionDates

getDisplayAlarm

removeDisplayAlarm

getDisplayAlarmDescription

setDisplayAlarmDescription

getDisplayAlarmTrigger

setDisplayAlarmTrigger

setDisplayAlarmTriggerDate

getDisplayAlarmDuration

setDisplayAlarmDuration

getDisplayAlarmRepeat

setDisplayAlarmRepeat

setExceptionDates

getRecurrenceId

setRecurrenceId

getStatus

setStatus

isAnyTime

getAnyTime

setAnyTime

createCalendar

isRecurring

creatDisplayAlarm