OSID - osid.calendaring.TimePeriod Service Interface Definition

Interface	osid.calendaring.TimePeriod
Implements	`osid.OsidObject`
Description	A `TimePeriod` represents a span of time in which recurring events are expanded.
Method	getStart
Description	Gets the start time of the time period.
Return	`osid.calendaring.DateTime`		the start time
Compliance	`mandatory`		This method must be implemented.
Method	getEnd
Description	Gets the end time of the time period.
Return	`osid.calendaring.DateTime`		the end time
Compliance	`mandatory`		This method must be implemented.
Method	getExceptionIds
Description	Gets the exception `Ids` to this time period. Recurring events overlapping with these events do not appear in any recurring event for this time period.
Return	`osid.id.IdList`		list of exception event `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getExceptions
Description	Gets the exceptions to this time period. Recurring events overlapping with these events do not appear in any recurring event for this time period.
Return	`osid.calendaring.EventList`		event exceptions
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodRecord
Description	Gets the time period record corresponding to the given `TimePeriod` record `Type.` This method is used to retrieve an object implementing the requested record. The `timePeriodRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(timePeriodRecordType)` is `true` .
Parameters	`osid.type.Type`	`timePeriodRecordType`	the type of the record to retrieve
Return	`osid.calendaring.records.TimePeriodRecord`		the time period record
Errors	NULL_ARGUMENT		`timePeriodRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(timePeriodRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.