Uses of Class
org.silverpeas.core.calendar.CalendarEvent

Packages that use CalendarEvent

Package	Description
org.silverpeas.core.calendar	Provides the Calendar and Event Planning Engine.
org.silverpeas.core.calendar.ical4j
org.silverpeas.core.calendar.icalendar	Provides the services dedicated to the export and the import of CalendarEvent instances into and from iCalendar sources.
org.silverpeas.core.calendar.notification
org.silverpeas.core.calendar.repository
org.silverpeas.core.importexport.ical	Provides an exporter of calendar events into iCal data.
org.silverpeas.core.importexport.ical.ical4j	Provides an implementation of the iCal exporting process by using the ICal4J Java library.
org.silverpeas.core.webapi.calendar

Uses of CalendarEvent in org.silverpeas.core.calendar

Methods in org.silverpeas.core.calendar that return CalendarEvent

Modifier and Type	Method	Description
CalendarEvent	CalendarEvent.copy()	Copies the specified event to another one.
CalendarEvent	CalendarEvent.createdBy(String userId)	This event is created by the specified user.
CalendarEvent	CalendarEvent.createdBy(User user)	This event is created by the specified user.
static CalendarEvent	CalendarEvent.getByExternalId(Calendar calendar, String externalId)	Gets a calendar event by its external identifier and the calendar it belongs.
static CalendarEvent	CalendarEvent.getById(String id)	Gets a calendar event by its identifier.
CalendarEvent	CalendarEventOccurrence.getCalendarEvent()	Gets the event from which this occurrence was spawned.
CalendarEvent	CalendarEvent.identifiedBy(String appId, String eventId)	Sets explicitly the identifier of this event.
CalendarEvent	CalendarEvent.inLocation(String location)	Specifies a location where this event will occur.
static CalendarEvent	CalendarEvent.on(LocalDate day)	Creates a new calendar event that is on all the specified day.
static CalendarEvent	CalendarEvent.on(Period period)	Creates a new calendar event that is spanning on the specified period of time.
CalendarEvent	CalendarEvent.planOn(Calendar calendar)
CalendarEvent	CalendarEvent.recur(Recurrence recurrence)	Recurs this event with the specified event recurrence.
CalendarEvent	CalendarEvent.withAttendee(String email)	Adds an attendee in this event and returns itself.
CalendarEvent	CalendarEvent.withAttendee(User user)	Adds an attendee in this event and returns itself.
CalendarEvent	CalendarEvent.withAttribute(String attrName, String attrValue)	Adds the specified attribute among the attributes of this event.
CalendarEvent	CalendarEvent.withCategories(String... categories)	Adds the specified categories to the event.
CalendarEvent	CalendarEvent.withDescription(String description)	Sets a description ot this event.
CalendarEvent	CalendarEvent.withExternalId(String externalId)	Specifies an external identifier.
CalendarEvent	CalendarEvent.withPriority(Priority priority)	Sets a priority to this event.
CalendarEvent	CalendarEvent.withTitle(String title)	Specifies a title to this event.
CalendarEvent	CalendarEvent.withVisibilityLevel(VisibilityLevel accessLevel)	Specifies the visibility level to this event.

Methods in org.silverpeas.core.calendar that return types with arguments of type CalendarEvent

Modifier and Type	Method	Description
OperationResult<CalendarEvent,CalendarEventOccurrence>	PlannableOnCalendar.delete()	Deletes this planned object from the calendar it belongs to.
Optional<CalendarEvent>	Calendar.event(String eventId)	Gets either the calendar event with the specified identifier or nothing if no such event exists with the given identifier.
Optional<CalendarEvent>	Calendar.externalEvent(String externalEventId)	Gets either the calendar external event with the specified external identifier or nothing if no such event exists with the given external identifier.
static List<CalendarEvent>	CalendarEvent.getByIds(List<String> ids)	Gets list of calendar event by their identifier.
List<CalendarEvent>	CalendarTimeWindow.getEvents()	Gets all the events that have at least one occurrence in this window of time, once the filtering applied.
Optional<CalendarEvent>	CalendarEventOccurrence.getParent()
Stream<CalendarEvent>	CalendarEvents.stream()	Gets as a stream all the events verifying the filters if any. Please be careful to always close the streams in order to avoid memory leaks!!!
OperationResult<CalendarEvent,CalendarEventOccurrence>	PlannableOnCalendar.update()	Updates this planned object in the underlying calendar it belongs to.

Methods in org.silverpeas.core.calendar with parameters of type CalendarEvent

Modifier and Type	Method	Description
long	CalendarEventOccurrenceGenerator.countOccurrencesOf(CalendarEvent event, Period inPeriod)	Counts the number of occurrences of the specified event in the given period.
static CalendarEventOccurrenceBuilder	CalendarEventOccurrenceBuilder.forEvent(CalendarEvent event)
CalendarEventOccurrence	CalendarEventOccurrenceGenerator.generateNextOccurrenceOf(CalendarEvent event, ZonedDateTime since)	Generates the next occurrence of the specified event since the given date time.
static Optional<CalendarEventOccurrence>	CalendarEventOccurrence.getBy(CalendarEvent event, String occurrenceStartDate)	Gets optionally an event occurrence from the specified data.
static Optional<CalendarEventOccurrence>	CalendarEventOccurrence.getBy(CalendarEvent event, Temporal occurrenceStartDate)	Gets optionally an event occurrence from the specified data.
static CalendarComponentPath	CalendarComponentPath.getPath(CalendarEvent event)	Gets a calendar component path without taking care about right accesses.
<T extends Contribution> Optional<ResourcePath<T>>	CalendarResourcePathProvider.getResourcePathOf(CalendarEvent calendarEvent)	Gets a calendar component path without taking care about right accesses.
Optional<CalendarComponentPath>	DefaultCalendarResourcePathProvider.getResourcePathOf(CalendarEvent calendarEvent)
boolean	CalendarEvent.isModifiedSince(CalendarEvent previous)	Is the properties of this calendar event was modified since its last specified state?
CalendarEvent.EventOperationResult	CalendarEvent.updateFrom(CalendarEvent event)	Updates this event with the state of the specified calendar event.

Method parameters in org.silverpeas.core.calendar with type arguments of type CalendarEvent

Modifier and Type	Method	Description
List<CalendarEventOccurrence>	CalendarEventOccurrenceGenerator.generateOccurrencesOf(List<CalendarEvent> events, Period inPeriod)	Generates the actual occurrences of the specified events and that occur in the period of time.

Constructors in org.silverpeas.core.calendar with parameters of type CalendarEvent

Constructor	Description
CalendarEventModel(CalendarEvent contribution)

Uses of CalendarEvent in org.silverpeas.core.calendar.ical4j

Methods in org.silverpeas.core.calendar.ical4j with parameters of type CalendarEvent

Modifier and Type	Method	Description
net.fortuna.ical4j.model.DateList	ICal4JRecurrenceCodec.convertExceptionDates(CalendarEvent event)	Converts the exception dates from a calendar event with a recurrence rule.
long	ICal4JCalendarEventOccurrenceGenerator.countOccurrencesOf(CalendarEvent event, Period inPeriod)
net.fortuna.ical4j.model.Recur	ICal4JRecurrenceCodec.encode(CalendarEvent event)	Encodes the recurrence of the specified Silverpeas calendar event into an iCal4J recurrence.
CalendarEventOccurrence	ICal4JCalendarEventOccurrenceGenerator.generateNextOccurrenceOf(CalendarEvent event, ZonedDateTime since)

Method parameters in org.silverpeas.core.calendar.ical4j with type arguments of type CalendarEvent

Modifier and Type	Method	Description
void	ICal4JExporter.exports(ExportDescriptor descriptor, Supplier<Stream<CalendarEvent>> supplier)
List<CalendarEventOccurrence>	ICal4JCalendarEventOccurrenceGenerator.generateOccurrencesOf(List<CalendarEvent> events, Period inPeriod)
void	ICal4JImporter.imports(ImportDescriptor descriptor, Consumer<Stream<org.apache.commons.lang3.tuple.Pair<CalendarEvent,List<CalendarEventOccurrence>>>> consumer)

Uses of CalendarEvent in org.silverpeas.core.calendar.icalendar

Method parameters in org.silverpeas.core.calendar.icalendar with type arguments of type CalendarEvent

Modifier and Type	Method	Description
void	ICalendarExporter.exports(ExportDescriptor descriptor, Supplier<Stream<CalendarEvent>> supplier)	Exports a the supplied stream of events of a given calendar into the output stream provided by the specified descriptor.
void	ICalendarImporter.imports(ImportDescriptor descriptor, Consumer<Stream<org.apache.commons.lang3.tuple.Pair<CalendarEvent,List<CalendarEventOccurrence>>>> consumer)	Imports the events serialized in the iCal format from the input stream provided by the descriptor and passes the import stream to the specified consumer.

Uses of CalendarEvent in org.silverpeas.core.calendar.notification

Methods in org.silverpeas.core.calendar.notification with parameters of type CalendarEvent

Modifier and Type	Method	Description
protected CalendarEventLifeCycleEvent	CalendarEventLifeCycleEventNotifier.createResourceEventFrom(ResourceEvent.Type type, CalendarEvent... resource)

Constructors in org.silverpeas.core.calendar.notification with parameters of type CalendarEvent

Constructor	Description
CalendarEventLifeCycleEvent(ResourceEvent.Type type, @NotNull CalendarEvent... calendarEvent)	Constructs a new lifecycle event with the specified type and that implies the specified CalendarEvent instances, each of them representing a different state in the lifecycle of the calendar event.

Uses of CalendarEvent in org.silverpeas.core.calendar.repository

Methods in org.silverpeas.core.calendar.repository that return CalendarEvent

Modifier and Type	Method	Description
CalendarEvent	CalendarEventRepository.getByExternalId(Calendar calendar, String externalId)	Gets an event by its external identifier which is unique into context of a calendar.
CalendarEvent	DefaultCalendarEventRepository.getByExternalId(Calendar calendar, String externalId)
CalendarEvent	CalendarEventRepository.moveToCalendar(CalendarEvent event, Calendar target)	Moves the given event from specified calendar to the one the CalendarEvent instance refers.
CalendarEvent	DefaultCalendarEventRepository.moveToCalendar(CalendarEvent event, Calendar target)

Methods in org.silverpeas.core.calendar.repository that return types with arguments of type CalendarEvent

Modifier and Type	Method	Description
List<CalendarEvent>	CalendarEventRepository.getAllBetween(CalendarEventFilter filter, Instant startDateTime, Instant endDateTime)	Gets all the events matching the specified filter and that occur between the two specified date and times.
List<CalendarEvent>	DefaultCalendarEventRepository.getAllBetween(CalendarEventFilter filter, Instant startDateTime, Instant endDateTime)
Stream<CalendarEvent>	CalendarEventRepository.streamAll(CalendarEventFilter filter)	Gets all the events that satisfies the specified filter Please be careful to always close the streams in order to avoid memory leaks!!!
Stream<CalendarEvent>	DefaultCalendarEventRepository.streamAll(CalendarEventFilter filter)

Methods in org.silverpeas.core.calendar.repository with parameters of type CalendarEvent

Modifier and Type	Method	Description
List<CalendarEventOccurrence>	CalendarEventOccurrenceRepository.getAllByEvent(CalendarEvent event)	Gets all the persisted occurrences of the specified event.
List<CalendarEventOccurrence>	DefaultCalendarEventOccurrenceRepository.getAllByEvent(CalendarEvent event)
CalendarEvent	CalendarEventRepository.moveToCalendar(CalendarEvent event, Calendar target)	Moves the given event from specified calendar to the one the CalendarEvent instance refers.
CalendarEvent	DefaultCalendarEventRepository.moveToCalendar(CalendarEvent event, Calendar target)

Method parameters in org.silverpeas.core.calendar.repository with type arguments of type CalendarEvent

Modifier and Type	Method	Description
List<CalendarEventOccurrence>	CalendarEventOccurrenceRepository.getAll(Collection<CalendarEvent> events, Period period)	Gets all the persisted occurrences of the specified events occurring in the specified period of time.
List<CalendarEventOccurrence>	DefaultCalendarEventOccurrenceRepository.getAll(Collection<CalendarEvent> events, Period period)

Uses of CalendarEvent in org.silverpeas.core.importexport.ical

Methods in org.silverpeas.core.importexport.ical that return types with arguments of type CalendarEvent

Modifier and Type	Method	Description
List<CalendarEvent>	ExportableCalendar.getEvents()	Gets the events to export.

Methods in org.silverpeas.core.importexport.ical with parameters of type CalendarEvent

Modifier and Type	Method	Description
static ExportableCalendar	ExportableCalendar.with(CalendarEvent... events)	Creates a new calendar ready to be exported with the specified calendar events.

Method parameters in org.silverpeas.core.importexport.ical with type arguments of type CalendarEvent

Modifier and Type	Method	Description
String	ICalCodec.encode(List<CalendarEvent> events)	Encodes the specified events in a calendar into the iCal format.
static ExportableCalendar	ExportableCalendar.with(Collection<CalendarEvent> events)	Creates a new calendar ready to be exported with the specified calendar events.

Uses of CalendarEvent in org.silverpeas.core.importexport.ical.ical4j

Method parameters in org.silverpeas.core.importexport.ical.ical4j with type arguments of type CalendarEvent

Modifier and Type	Method	Description
String	ICal4JICalCodec.encode(List<CalendarEvent> events)

Uses of CalendarEvent in org.silverpeas.core.webapi.calendar

Methods in org.silverpeas.core.webapi.calendar that return CalendarEvent

Modifier and Type	Method	Description
CalendarEvent	CalendarWebManager.createEvent(Calendar calendar, CalendarEvent event, String volatileEventId)	Creates an event from the given calendar and event data. This method handles also a common behavior the UI must have between each way an event is saved (from a controller, a WEB service...)
protected CalendarEvent	CalendarWebManager.deleteOccurrence(CalendarEventOccurrence occurrence, OccurrenceEventActionMethodType deleteMethodType, ZoneId zoneId)	Deletes occurrences of an event from the given occurrence. This method handles also a common behavior the UI must have between each way an event is deleted (from a controller, a WEB service...)
protected CalendarEvent	CalendarWebManager.updateOccurrenceAttendeeParticipation(CalendarEventOccurrence occurrence, String attendeeId, Attendee.ParticipationStatus participationStatus, OccurrenceEventActionMethodType answerMethodType, ZoneId zoneId)	Updates the participation of an attendee of an event or on an occurrence of an event from the given data. This method handles also a common behavior the UI must have between each way an event is deleted (from a controller, a WEB service...)

Methods in org.silverpeas.core.webapi.calendar that return types with arguments of type CalendarEvent

Modifier and Type	Method	Description
protected List<CalendarEvent>	CalendarWebManager.saveOccurrence(CalendarEventOccurrence occurrence, OccurrenceEventActionMethodType updateMethodType, ZoneId zoneId)	Saves an event occurrence. This method handles also a common behavior the UI must have between each way an event is saved (from a controller, a WEB service...)

Methods in org.silverpeas.core.webapi.calendar with parameters of type CalendarEvent

Modifier and Type	Method	Description
CalendarEventEntity	CalendarResource.asEventWebEntity(CalendarEvent event)	Converts the calendar event into its corresponding web entity.
CalendarEvent	CalendarWebManager.createEvent(Calendar calendar, CalendarEvent event, String volatileEventId)	Creates an event from the given calendar and event data. This method handles also a common behavior the UI must have between each way an event is saved (from a controller, a WEB service...)
protected CalendarEventEntity	CalendarEventEntity.decorate(CalendarEvent calendarEvent, String componentInstanceId, ZoneId zoneId, boolean isEditionMode)
protected CalendarEventRecurrenceEntity	CalendarEventRecurrenceEntity.decorate(CalendarEvent event, ZoneId zoneId)
static CalendarEventRecurrenceEntity	CalendarEventRecurrenceEntity.from(CalendarEvent event, ZoneId zoneId)
static CalendarEventEntity	CalendarEventEntity.fromEvent(CalendarEvent event, String componentInstanceId, ZoneId zoneId, boolean isEditionMode)

Method parameters in org.silverpeas.core.webapi.calendar with type arguments of type CalendarEvent

Modifier and Type	Method	Description
List<CalendarEventEntity>	CalendarResource.asEventWebEntities(Collection<CalendarEvent> events)	Converts the list of calendar event into list of calendar event web entities.