Interface CalendaringCycleProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
CalendaringCycleManager, CalendaringCycleProxyManager
public interface CalendaringCycleProfile extends OsidProfile

The CalendaringCycleProfile describes the interoperability among calendaring cycle services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      Tests if federation is visible.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCyclicEventLookup

      boolean supportsCyclicEventLookup()
      Tests if a cyclic event lookup service is supported. a cyclic event lookup service defines methods to access cyclic events.
      Returns:
      true if cyclic event lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCyclicEventQuery

      boolean supportsCyclicEventQuery()
      Tests if a cyclic event query service is supported.
      Returns:
      true if cyclic event query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCyclicEventSearch

      boolean supportsCyclicEventSearch()
      Tests if a cyclic event search service is supported.
      Returns:
      true if cyclic event search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCyclicEventAdmin

      boolean supportsCyclicEventAdmin()
      Tests if a cyclic event administrative service is supported.
      Returns:
      true if cyclic event admin is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCyclicEventNotification

      boolean supportsCyclicEventNotification()
      Tests if cyclic event notification is supported. Messages may be sent when cyclic events are created, modified, or deleted.
      Returns:
      true if cyclic event notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCyclicEventCalendar

      boolean supportsCyclicEventCalendar()
      Tests if a cyclic event to calendar lookup session is available.
      Returns:
      true if cyclic event calendar lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCyclicEventCalendarAssignment

      boolean supportsCyclicEventCalendarAssignment()
      Tests if a cyclic event to calendar assignment session is available.
      Returns:
      true if cyclic event calendar assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCyclicEventSmartCalendar

      boolean supportsCyclicEventSmartCalendar()
      Tests if cyclic event smart calendaring is available.
      Returns:
      true if cyclic event smart calendaring is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEventCyclicEventLookup

      boolean supportsEventCyclicEventLookup()
      Tests if a session to look up associations between events and cyclic events is available.
      Returns:
      true if an event to cyclic event lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEventCyclicEventAssignment

      boolean supportsEventCyclicEventAssignment()
      Tests if a session for manually assigning events to cyclic events is available.
      Returns:
      true if an event to cyclic event assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCyclicTimePeriodLookup

      boolean supportsCyclicTimePeriodLookup()
      Tests if a cyclic time period lookup service is supported.
      Returns:
      true if cyclic time period lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCyclicTimePeriodSearch

      boolean supportsCyclicTimePeriodSearch()
      Tests if a cyclic time period search service is supported.
      Returns:
      true if cyclic time period search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCyclicTimePeriodAdmin

      boolean supportsCyclicTimePeriodAdmin()
      Tests if a cyclic time period administrative service is supported.
      Returns:
      true if cyclic time period admin is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCyclicTimePeriodNotification

      boolean supportsCyclicTimePeriodNotification()
      Tests if cyclic time period notification is supported. Messages may be sent when cyclic time periods are created, modified, or deleted.
      Returns:
      true if cyclic time period notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCyclicTimePeriodCalendar

      boolean supportsCyclicTimePeriodCalendar()
      Tests if a cyclic time period to calendar lookup session is available.
      Returns:
      true if cyclic time period calendar lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCyclicTimePeriodCalendarAssignment

      boolean supportsCyclicTimePeriodCalendarAssignment()
      Tests if a cyclic time period to calendar assignment session is available.
      Returns:
      true if cyclic time period calendar assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCyclicTimePeriodSmartCalendar

      boolean supportsCyclicTimePeriodSmartCalendar()
      Tests if cyclic time period smart calendaring is available.
      Returns:
      true if cyclic time period smart calendaring is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTimePeriodCyclicTimePeriodLookup

      boolean supportsTimePeriodCyclicTimePeriodLookup()
      Tests if a session to look up associations between time periods and cyclic time periods is available.
      Returns:
      true if a time period to cyclic time period lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsTimePeriodCyclicTimePeriodAssignment

      boolean supportsTimePeriodCyclicTimePeriodAssignment()
      Tests if a session for manually assigning time periods to cyclic time periods is available.
      Returns:
      true if a time period to cyclic time period assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCalendaringCycleBatch

      boolean supportsCalendaringCycleBatch()
      Tests if a calendaring cycle batch service is available.
      Returns:
      true if a calndaring cycle batch service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCyclicEventRecordTypes

      TypeList getCyclicEventRecordTypes()
      Gets the supported CyclicEvent record types.
      Returns:
      a list containing the supported CyclicEvent record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsCyclicEventRecordType

      boolean supportsCyclicEventRecordType(Type cyclicEventRecordType)
      Tests if the given CyclicEvent record type is supported.
      Parameters:
      cyclicEventRecordType - a Type indicating a CyclicEvent record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - cyclicEventRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getCyclicEventSearchRecordTypes

      TypeList getCyclicEventSearchRecordTypes()
      Gets the supported CyclicEvent search record types.
      Returns:
      a list containing the supported CyclicEvent search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsCyclicEventSearchRecordType

      boolean supportsCyclicEventSearchRecordType(Type cyclicEventSearchRecordType)
      Tests if the given CyclicEvent search record type is supported.
      Parameters:
      cyclicEventSearchRecordType - a Type indicating a CyclicEvent search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - cyclicEventSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getCyclicTimePeriodRecordTypes

      TypeList getCyclicTimePeriodRecordTypes()
      Gets the supported CyclicTimePeriod record types.
      Returns:
      a list containing the supported CyclicTimePeriod record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsCyclicTimePeriodRecordType

      boolean supportsCyclicTimePeriodRecordType(Type cyclicTimePeriodRecordType)
      Tests if the given CyclicTimePeriod record type is supported.
      Parameters:
      cyclicTimePeriodRecordType - a Type indicating a CyclicTimePeriod record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - cyclicTimePeriodRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getCyclicTimePeriodSearchRecordTypes

      TypeList getCyclicTimePeriodSearchRecordTypes()
      Gets the supported CyclicTimePeriod search record types.
      Returns:
      a list containing the supported CyclicTimePeriod search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsCyclicTimePeriodSearchRecordType

      boolean supportsCyclicTimePeriodSearchRecordType(Type cyclicTimePeriodSearchRecordType)
      Tests if the given CyclicTimePeriod search record type is supported.
      Parameters:
      cyclicTimePeriodSearchRecordType - a Type indicating a CyclicTimePeriod search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - cyclicTimePeriodSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.