Interface RecurringEventAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
RecurringEventBatchAdminSession
public interface RecurringEventAdminSession extends OsidSession

This session creates, updates, and deletes RecurringEvents . The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a RecurringEvent , a RecurringEventForm is requested using getRecurringEventFormForCreate() specifying the desired relationship peers and record Types or none if no record Types are needed. The returned RecurringEventForm will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the RecurringEventForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each RecurringEventForm corresponds to an attempted transaction.

For updates, RecurringEventForms are requested to the RecurringEvent Id that is to be updated using getRecurringEventFormForUpdate() . Similarly, the RecurringEventForm has metadata about the data that can be updated and it can perform validation before submitting the update. The RecurringEventForm can only be used once for a successful update and cannot be reused.

The delete operations delete Recurring Events . To unmap a RecurringEvent from the current Calendar , the RecurringEventCalendarAssignmentSession should be used. These delete operations attempt to remove the Event itself thus removing it from all known Calendar catalogs.

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.