OSID - osid.calendaring.cycle.CalendaringCycleProfile Service Interface Definition

Interface	osid.calendaring.cycle.CalendaringCycleProfile
Implements	`osid.OsidProfile`
Description	The `CalendaringCycleProfile` describes the interoperability among calendaring cycle services.
Method	supportsVisibleFederation
Description	Tests if federation is visible.
Return	`boolean`		`true` if visible federation is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicEventLookup
Description	Tests if a cyclic event lookup service is supported. a cyclic event lookup service defines methods to access cyclic events.
Return	`boolean`		true if cyclic event lookup is supported, false otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicEventQuery
Description	Tests if a cyclic event query service is supported.
Return	`boolean`		`true` if cyclic event query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicEventSearch
Description	Tests if a cyclic event search service is supported.
Return	`boolean`		`true` if cyclic event search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicEventAdmin
Description	Tests if a cyclic event administrative service is supported.
Return	`boolean`		`true` if cyclic event admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicEventNotification
Description	Tests if cyclic event notification is supported. Messages may be sent when cyclic events are created, modified, or deleted.
Return	`boolean`		`true` if cyclic event notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicEventCalendar
Description	Tests if a cyclic event to calendar lookup session is available.
Return	`boolean`		`true` if cyclic event calendar lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicEventCalendarAssignment
Description	Tests if a cyclic event to calendar assignment session is available.
Return	`boolean`		`true` if cyclic event calendar assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicEventSmartCalendar
Description	Tests if cyclic event smart calendaring is available.
Return	`boolean`		`true` if cyclic event smart calendaring is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEventCyclicEventLookup
Description	Tests if a session to look up associations between events and cyclic events is available.
Return	`boolean`		`true` if an event to cyclic event lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEventCyclicEventAssignment
Description	Tests if a session for manually assigning events to cyclic events is available.
Return	`boolean`		`true` if an event to cyclic event assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicTimePeriodLookup
Description	Tests if a cyclic time period lookup service is supported.
Return	`boolean`		`true` if cyclic time period lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicTimePeriodSearch
Description	Tests if a cyclic time period search service is supported.
Return	`boolean`		`true` if cyclic time period search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicTimePeriodAdmin
Description	Tests if a cyclic time period administrative service is supported.
Return	`boolean`		`true` if cyclic time period admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicTimePeriodNotification
Description	Tests if cyclic time period notification is supported. Messages may be sent when cyclic time periods are created, modified, or deleted.
Return	`boolean`		`true` if cyclic time period notification is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicTimePeriodCalendar
Description	Tests if a cyclic time period to calendar lookup session is available.
Return	`boolean`		`true` if cyclic time period calendar lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicTimePeriodCalendarAssignment
Description	Tests if a cyclic time period to calendar assignment session is available.
Return	`boolean`		`true` if cyclic time period calendar assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicTimePeriodSmartCalendar
Description	Tests if cyclic time period smart calendaring is available.
Return	`boolean`		`true` if cyclic time period smart calendaring is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTimePeriodCyclicTimePeriodLookup
Description	Tests if a session to look up associations between time periods and cyclic time periods is available.
Return	`boolean`		`true` if a time period to cyclic time period lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTimePeriodCyclicTimePeriodAssignment
Description	Tests if a session for manually assigning time periods to cyclic time periods is available.
Return	`boolean`		`true` if a time period to cyclic time period assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCalendaringCycleBatch
Description	Tests if a calendaring cycle batch service is available.
Return	`boolean`		`true` if a calndaring cycle batch service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicEventRecordTypes
Description	Gets the supported `CyclicEvent` record types.
Return	`osid.type.TypeList`		a list containing the supported `CyclicEvent` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicEventRecordType
Description	Tests if the given `CyclicEvent` record type is supported.
Parameters	`osid.type.Type`	`cyclicEventRecordType`	a `Type` indicating a `CyclicEvent` record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`cyclicEventRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicEventSearchRecordTypes
Description	Gets the supported `CyclicEvent` search record types.
Return	`osid.type.TypeList`		a list containing the supported `CyclicEvent` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicEventSearchRecordType
Description	Tests if the given `CyclicEvent` search record type is supported.
Parameters	`osid.type.Type`	`cyclicEventSearchRecordType`	a `Type` indicating a `CyclicEvent` search record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`cyclicEventSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicTimePeriodRecordTypes
Description	Gets the supported `CyclicTimePeriod` record types.
Return	`osid.type.TypeList`		a list containing the supported `CyclicTimePeriod` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicTimePeriodRecordType
Description	Tests if the given `CyclicTimePeriod` record type is supported.
Parameters	`osid.type.Type`	`cyclicTimePeriodRecordType`	a `Type` indicating a `CyclicTimePeriod` record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`cyclicTimePeriodRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicTimePeriodSearchRecordTypes
Description	Gets the supported `CyclicTimePeriod` search record types.
Return	`osid.type.TypeList`		a list containing the supported `CyclicTimePeriod` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicTimePeriodSearchRecordType
Description	Tests if the given `CyclicTimePeriod` search record type is supported.
Parameters	`osid.type.Type`	`cyclicTimePeriodSearchRecordType`	a `Type` indicating a `CyclicTimePeriod` search record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`cyclicTimePeriodSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.