OSID - osid.calendaring.rules.CommitmentEnablerCalendarSession Service Interface Definition

Interface	osid.calendaring.rules.CommitmentEnablerCalendarSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `CommitmentEnabler` to `Calendar` mappings. A `CommitmentEnabler` may appear in multiple `Calendar` objects. Each calendar may have its own authorizations governing who is allowed to look at it. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition
Method	canLookupCommitmentEnablerCalendarMappings
Description	Tests if this user can perform lookups of commitment enabler/calendar mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeCommitmentEnablerCalendarView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryCommitmentEnablerCalendarView
Description	A complete view of the `CommitmentEnabler` and `Calendar` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	getCommitmentEnablerIdsByCalendar
Description	Gets the list of `CommitmentEnabler Ids` associated with a `Calendar.`
Parameters	`osid.id.Id`	`calendarId`	`Id` of the `Calendar`
Return	`osid.id.IdList`		list of related commitment enabler `Ids`
Errors	NOT_FOUND		`calendarId` is not found
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentEnablersByCalendar
Description	Gets the list of commitment enablers associated with a `Calendar.`
Parameters	`osid.id.Id`	`calendarId`	`Id` of the `Calendar`
Return	`osid.calendaring.rules.CommitmentEnablerList`		list of related commitment enablers
Errors	NOT_FOUND		`calendarId` is not found
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentEnablerIdsByCalendars
Description	Gets the list of `CommitmentEnabler Ids` corresponding to a list of `Calendars.`
Parameters	`osid.id.IdList`	`calendarIds`	list of calendar `Ids`
Return	`osid.id.IdList`		list of commitment enabler `Ids`
Errors	NULL_ARGUMENT		`calendarIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentEnablersByCalendars
Description	Gets the list of commitment enablers corresponding to a list of `Calendars.`
Parameters	`osid.id.IdList`	`calendarIds`	list of calendar `Ids`
Return	`osid.calendaring.rules.CommitmentEnablerList`		list of commitment enablers
Errors	NULL_ARGUMENT		`calendarIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCalendarIdsByCommitmentEnabler
Description	Gets the `Calendar` `Ids` mapped to a `CommitmentEnabler.`
Parameters	`osid.id.Id`	`commitmentEnablerId`	`Id` of a `CommitmentEnabler`
Return	`osid.id.IdList`		list of calendars
Errors	NOT_FOUND		`commitmentEnablerId` is not found
	NULL_ARGUMENT		`commitmentEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCalendarsByCommitmentEnabler
Description	Gets the `Calendars` mapped to a `CommitmentEnabler.`
Parameters	`osid.id.Id`	`commitmentEnablerId`	`Id` of a `CommitmentEnabler`
Return	`osid.calendaring.CalendarList`		list of calendars
Errors	NOT_FOUND		`commitmentEnablerId` is not found
	NULL_ARGUMENT		`commitmentEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.