OSID - osid.calendaring.TimePeriodQuerySession Service Interface Definition

Interface	osid.calendaring.TimePeriodQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.calendaring.TimePeriodSearchSession`
Used By	`osid.calendaring.CalendaringManager`
Used By	`osid.calendaring.CalendaringProxyManager`
Description	This session provides methods for searching `TimePeriod` objects. The search query is constructed using the `TimePeriodQuery`. The time period record `Type` also specifies the record for the time period query. Time periods may have a query record indicated by their respective record types. The query record is accessed via the `TimePeriodQuery`.
Method	getCalendarId
Description	Gets the `Calendar` `Id` associated with this session.
Return	`osid.id.Id`		the `Calendar Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCalendar
Description	Gets the `Calendar` associated with this session.
Return	`osid.calendaring.Calendar`		the `Calendar` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchTimePeriods
Description	Tests if this user can perform `TimePeriod` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedCalendarView
Description	Federates the view for methods in this session. A federated view will include time periods in calendars which are children of this calendar in the calendar hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCalendarView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this calendar only.
Compliance	`mandatory`		This method is must be implemented.
Method	getTimePeriodQuery
Description	Gets a time period query.
Return	`osid.calendaring.TimePeriodQuery`		the time period query
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodsByQuery
Description	Gets a list of `TimePeriods` matching the given query.
Parameters	`osid.calendaring.TimePeriodQuery`	`timePeriodQuery`	the time period query
Return	`osid.calendaring.TimePeriodList`		the returned `TimePeriodList`
Errors	NULL_ARGUMENT		`timePeriodQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`timePeriodQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.