OSID Logo
OSID Specifications
calendaring cycle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.cycle.CalendaringCycleProfile
Implementsosid.OsidProfile
Description

The CalendaringCycleProfile describes the interoperability among calendaring cycle services.

MethodsupportsVisibleFederation
Description

Tests if federation is visible.

Returnboolean true if visible federation is supported , false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCyclicEventLookup
Description

Tests if a cyclic event lookup service is supported. a cyclic event lookup service defines methods to access cyclic events.

Returnbooleantrue if cyclic event lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCyclicEventQuery
Description

Tests if a cyclic event query service is supported.

Returnboolean true if cyclic event query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCyclicEventSearch
Description

Tests if a cyclic event search service is supported.

Returnboolean true if cyclic event search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCyclicEventAdmin
Description

Tests if a cyclic event administrative service is supported.

Returnboolean true if cyclic event admin is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCyclicEventNotification
Description

Tests if cyclic event notification is supported. Messages may be sent when cyclic events are created, modified, or deleted.

Returnboolean true if cyclic event notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCyclicEventCalendar
Description

Tests if a cyclic event to calendar lookup session is available.

Returnboolean true if cyclic event calendar lookup session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCyclicEventCalendarAssignment
Description

Tests if a cyclic event to calendar assignment session is available.

Returnboolean true if cyclic event calendar assignment is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCyclicEventSmartCalendar
Description

Tests if cyclic event smart calendaring is available.

Returnboolean true if cyclic event smart calendaring is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEventCyclicEventLookup
Description

Tests if a session to look up associations between events and cyclic events is available.

Returnboolean true if an event to cyclic event lookup session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEventCyclicEventAssignment
Description

Tests if a session for manually assigning events to cyclic events is available.

Returnboolean true if an event to cyclic event assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCyclicTimePeriodLookup
Description

Tests if a cyclic time period lookup service is supported.

Returnboolean true if cyclic time period lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCyclicTimePeriodSearch
Description

Tests if a cyclic time period search service is supported.

Returnboolean true if cyclic time period search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCyclicTimePeriodAdmin
Description

Tests if a cyclic time period administrative service is supported.

Returnboolean true if cyclic time period admin is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCyclicTimePeriodNotification
Description

Tests if cyclic time period notification is supported. Messages may be sent when cyclic time periods are created, modified, or deleted.

Returnboolean true if cyclic time period notification is supported , false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCyclicTimePeriodCalendar
Description

Tests if a cyclic time period to calendar lookup session is available.

Returnboolean true if cyclic time period calendar lookup session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCyclicTimePeriodCalendarAssignment
Description

Tests if a cyclic time period to calendar assignment session is available.

Returnboolean true if cyclic time period calendar assignment is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCyclicTimePeriodSmartCalendar
Description

Tests if cyclic time period smart calendaring is available.

Returnboolean true if cyclic time period smart calendaring is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsTimePeriodCyclicTimePeriodLookup
Description

Tests if a session to look up associations between time periods and cyclic time periods is available.

Returnboolean true if a time period to cyclic time period lookup session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsTimePeriodCyclicTimePeriodAssignment
Description

Tests if a session for manually assigning time periods to cyclic time periods is available.

Returnboolean true if a time period to cyclic time period assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsCalendaringCycleBatch
Description

Tests if a calendaring cycle batch service is available.

Returnboolean true if a calndaring cycle batch service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCyclicEventRecordTypes
Description

Gets the supported CyclicEvent record types.

Returnosid.type.TypeLista list containing the supported CyclicEvent record types
CompliancemandatoryThis method must be implemented.
MethodsupportsCyclicEventRecordType
Description

Tests if the given CyclicEvent record type is supported.

Parametersosid.type.TypecyclicEventRecordTypea Type indicating a CyclicEvent record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT cyclicEventRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetCyclicEventSearchRecordTypes
Description

Gets the supported CyclicEvent search record types.

Returnosid.type.TypeLista list containing the supported CyclicEvent search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsCyclicEventSearchRecordType
Description

Tests if the given CyclicEvent search record type is supported.

Parametersosid.type.TypecyclicEventSearchRecordTypea Type indicating a CyclicEvent search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT cyclicEventSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetCyclicTimePeriodRecordTypes
Description

Gets the supported CyclicTimePeriod record types.

Returnosid.type.TypeLista list containing the supported CyclicTimePeriod record types
CompliancemandatoryThis method must be implemented.
MethodsupportsCyclicTimePeriodRecordType
Description

Tests if the given CyclicTimePeriod record type is supported.

Parametersosid.type.TypecyclicTimePeriodRecordTypea Type indicating a CyclicTimePeriod record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT cyclicTimePeriodRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetCyclicTimePeriodSearchRecordTypes
Description

Gets the supported CyclicTimePeriod search record types.

Returnosid.type.TypeLista list containing the supported CyclicTimePeriod search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsCyclicTimePeriodSearchRecordType
Description

Tests if the given CyclicTimePeriod search record type is supported.

Parametersosid.type.TypecyclicTimePeriodSearchRecordTypea Type indicating a CyclicTimePeriod search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT cyclicTimePeriodSearchRecordType is null
CompliancemandatoryThis method must be implemented.