Interface RecurringEvent

All Superinterfaces:
Browsable, Containable, Extensible, Identifiable, Operable, OsidObject, OsidRule
public interface RecurringEvent extends OsidRule, Containable

A RecurringEvent an event that repeats over a set of Schedules , other events, or custom rule. The active status of the rule informs the appearance of recurring events as events.

  • Method Details

    • getScheduleIds

      IdList getScheduleIds()
      Gets the Schedule Id of this composite event.
      Returns:
      the recurring schedule Ids
      Compliance:
      mandatory - This method must be implemented.

    • getSchedules

      ScheduleList getSchedules() throws OperationFailedException
      Gets the recurring schedule in this composite event.
      Returns:
      the recurring schedules
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getSupersedingEventIds

      IdList getSupersedingEventIds()
      Gets the superseding event Ids . A superseding event is one that replaces another in a series.
      Returns:
      list of superseding event Ids
      Compliance:
      mandatory - This method must be implemented.

    • getSupersedingEvents

      SupersedingEventList getSupersedingEvents() throws OperationFailedException
      Gets the superseding events. A superseding event is one that replaces another in a series.
      Returns:
      list of superseding events
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getSpecificMeetingTimes

      MeetingTimeList getSpecificMeetingTimes()
      Gets specific dates for this event outside of the schedules. Specific dates are excluded from blackouts.
      Returns:
      speciifc list of dates
      Compliance:
      mandatory - This method must be implemented.

    • getEventIds

      IdList getEventIds()
      Gets the composed event Ids .
      Returns:
      list of event Ids
      Compliance:
      mandatory - This method must be implemented.

    • getEvents

      EventList getEvents() throws OperationFailedException
      Gets the composed events.
      Returns:
      list of events
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getBlackouts

      DateTimeIntervalList getBlackouts()
      Gets the blackout dates for this recurring event. Recurring events overlapping with the time intervals do not appear in their series.
      Returns:
      recurring event exceptions
      Compliance:
      mandatory - This method must be implemented.

    • hasSponsors

      boolean hasSponsors()
      Tests if a sponsor is associated with the overall recurring event.
      Returns:
      true if there is an associated sponsor. false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getSponsorIds

      IdList getSponsorIds()
      Gets the Id of the recurring event sponsors.
      Returns:
      the sponsor Ids
      Throws:
      IllegalStateException - hasSponsors() is false
      Compliance:
      mandatory - This method must be implemented.

    • getSponsors

      ResourceList getSponsors() throws OperationFailedException
      Gets the Sponsors .
      Returns:
      the sponsors
      Throws:
      IllegalStateException - hasSponsors() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getRecurringEventRecord

      RecurringEventRecord getRecurringEventRecord(Type recurringEventRecordType) throws OperationFailedException
      Gets the recurring event record corresponding to the given RecurringEvent record Type . This method is used to retrieve an object implementing the requested record. The recurringEventRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(recurringEventRecordType) is true .
      Parameters:
      recurringEventRecordType - the type of the record to retrieve
      Returns:
      the recurring event record
      Throws:
      NullArgumentException - recurringEventRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(recurringEventRecordType) is false
      Compliance:
      mandatory - This method must be implemented.