Package org.alfresco.service.cmr.calendar

Interface CalendarService

All Known Implementing Classes:

CalendarServiceImpl

public interface CalendarService

The Calendar service.

Since:

4.0

Author:

Nick Burch

Method Summary

Modifier and Type	Method	Description
CalendarEntry	createCalendarEntry(String siteShortName, CalendarEntry entry)	Stores a new CalendarEntry into the given site.
void	deleteCalendarEntry(CalendarEntry entry)	Deletes an existing CalendarEntry from the repository
CalendarEntry	getCalendarEntry(String siteShortName, String entryName)	Retrieves an existing CalendarEntry from the repository
org.alfresco.query.PagingResults<CalendarEntry>	listCalendarEntries(String[] siteShortNames, Date from, Date to, org.alfresco.query.PagingRequest paging)	Retrieves all CalendarEntry instances in the repository for the given sites, between the specified date range.
org.alfresco.query.PagingResults<CalendarEntry>	listCalendarEntries(String[] siteShortNames, org.alfresco.query.PagingRequest paging)	Retrieves all CalendarEntry instances in the repository for the given sites.
org.alfresco.query.PagingResults<CalendarEntry>	listCalendarEntries(String siteShortName, org.alfresco.query.PagingRequest paging)	Retrieves all CalendarEntry instances in the repository for the given site.
org.alfresco.query.PagingResults<CalendarEntry>	listOutlookCalendarEntries(String siteShortName, String outlookUID, org.alfresco.query.PagingRequest paging)	Retrieves all Outlook based CalendarEntry instances in the repository for the given site, optionally filtered by the Outlook Event UID.
CalendarEntry	updateCalendarEntry(CalendarEntry entry)	Updates an existing CalendarEntry in the repository.

Method Detail

createCalendarEntry

@NotAuditable
CalendarEntry createCalendarEntry(String siteShortName,
                                  CalendarEntry entry)

Stores a new CalendarEntry into the given site. The concrete class CalendarEntryDTO can be used to create a CalendarEntry instance for this.

Returns:

The newly created CalendarEntry

updateCalendarEntry

@NotAuditable
CalendarEntry updateCalendarEntry(CalendarEntry entry)

Updates an existing CalendarEntry in the repository.

Returns:

The updated CalendarEntry

deleteCalendarEntry

@NotAuditable
void deleteCalendarEntry(CalendarEntry entry)

Deletes an existing CalendarEntry from the repository

getCalendarEntry

@NotAuditable
CalendarEntry getCalendarEntry(String siteShortName,
                               String entryName)

Retrieves an existing CalendarEntry from the repository

listCalendarEntries

@NotAuditable
org.alfresco.query.PagingResults<CalendarEntry> listCalendarEntries(String siteShortName,
                                                                    org.alfresco.query.PagingRequest paging)

Retrieves all CalendarEntry instances in the repository for the given site.

listCalendarEntries

@NotAuditable
org.alfresco.query.PagingResults<CalendarEntry> listCalendarEntries(String[] siteShortNames,
                                                                    org.alfresco.query.PagingRequest paging)

Retrieves all CalendarEntry instances in the repository for the given sites.

listCalendarEntries

@NotAuditable
org.alfresco.query.PagingResults<CalendarEntry> listCalendarEntries(String[] siteShortNames,
                                                                    Date from,
                                                                    Date to,
                                                                    org.alfresco.query.PagingRequest paging)

Retrieves all CalendarEntry instances in the repository for the given sites, between the specified date range.

listOutlookCalendarEntries

@NotAuditable
org.alfresco.query.PagingResults<CalendarEntry> listOutlookCalendarEntries(String siteShortName,
                                                                           String outlookUID,
                                                                           org.alfresco.query.PagingRequest paging)

Retrieves all Outlook based CalendarEntry instances in the repository for the given site, optionally filtered by the Outlook Event UID.