OSID - osid.calendaring.CommitmentLookupSession Service Interface Definition

Interface	osid.calendaring.CommitmentLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for examining event commitments. This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated calendar view: All event methods in this session operate, retrieve and pertain to commitments defined explicitly in the current calendar. Using an isolated view is useful for managing events with the `CommitmentAdminSession.` federated calendar view: All commitment methods in this session operate, retrieve and pertain to all commitments defined in this calendar and any other calendars implicitly available in this calendar through calendar inheritence. effective commitment view: Commitment methods return only effective commitments any effective commitment view: Commitment methods return all commitments
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	canLookupCommitments
Description	Tests if this user can lookup event commitments. 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeCommitmentView
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	usePlenaryCommitmentView
Description	A complete view of the `Commitment` 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	useFederatedCalendarView
Description	Federates the view for methods in this session. A federated view will include commitments 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 lookups to this calendar only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveCommitmentView
Description	The commitments in this lookup session return only commitments currently in effect.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveCommitmentView
Description	The commitments in this lookup session return both effective and ineffective commitments.
Compliance	`mandatory`		This method is must be implemented.
Method	getCommitment
Description	Gets the `Commitment` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Commitment` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Commitment` and retained for compatibility. In effective mode, commitments are returned that are currently effective. In any effective mode, effective commitments and those currently expired are returned.
Parameters	`osid.id.Id`	`commitmentId`	`Id` of the `Commitment`
Return	`osid.calendaring.Commitment`		the commitment
Errors	NOT_FOUND		`commitmentId` not found
	NULL_ARGUMENT		`commitmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getCommitmentsByIds
Description	Gets a `CommitmentList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the commitments specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Commitments` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, commitments are returned that are currently effective. In any effective mode, effective commitments and those currently expired are returned.
Parameters	`osid.id.IdList`	`commitmentIds`	the list of `Ids` to retrieve
Return	`osid.calendaring.CommitmentList`		the returned `Commitment` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`commitmentIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentsByGenusType
Description	Gets the commitments for the given event genus type. In plenary mode, the returned list contains all known commitments or an error results. Otherwise, the returned list may contain only those commitments that are accessible through this session. In effective mode, commitments are returned that are currently effective. In any effective mode, effective commitments and those currently expired are returned.
Parameters	`osid.type.Type`	`commitmentGenusType`	commitment genus type
Return	`osid.calendaring.CommitmentList`		list of commitments
Errors	NULL_ARGUMENT		`commitmentGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getCommitmentsByParentGenusType
Description	Gets the commitments for the given event genus type and include any commitments with a genus type derived from the specified genus type. In plenary mode, the returned list contains all known commitments or an error results. Otherwise, the returned list may contain only those commitments that are accessible through this session. In effective mode, commitments are returned that are currently effective. In any effective mode, effective commitments and those currently expired are returned.
Parameters	`osid.type.Type`	`commitmentGenusType`	commitment genus type
Return	`osid.calendaring.CommitmentList`		list of commitments
Errors	NULL_ARGUMENT		`commitmentGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getCommitmentsByRecordType
Description	Gets a `CommitmentList` containing the given event commitment record `Type.` In plenary mode, the returned list contains all known commitments or an error results. Otherwise, the returned list may contain only those commitments that are accessible through this session. In effective mode, commitments are returned that are currently effective. In any effective mode, effective commitments and those currently expired are returned.
Parameters	`osid.type.Type`	`commitmentRecordType`	a commitment record type
Return	`osid.calendaring.CommitmentList`		list of commitments
Errors	NULL_ARGUMENT		`eventRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentsOnDate
Description	Gets a `CommitmentList` effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known commitments or an error results. Otherwise, the returned list may contain only those commitments that are accessible through this session. In effective mode, commitments are returned that are currently effective. In any effective mode, effective commitments and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
Parameters	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.calendaring.CommitmentList`		list of commitments
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentsByGenusTypeOnDate
Description	Gets a `CommitmentList` of the given genus type and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known commitments or an error results. Otherwise, the returned list may contain only those commitments that are accessible through this session. In effective mode, commitments are returned that are currently effective. In any effective mode, effective commitments and those currently expired are returned.
Parameters	`osid.type.Type`	`commitmentGenusType`	a commitment genus type
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.calendaring.CommitmentList`		list of commitments
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`commitmentGenusType, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentsForEvent
Description	Gets the commitments for the given event. If the event is a recurring event, the commitments are returned for the recurring event only. In plenary mode, the returned list contains all of the commitments mapped to the event `Id` or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible `Commitments` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, commitments are returned that are currently effective. In any effective mode, effective commitments and those currently expired are returned.
Parameters	`osid.id.Id`	`eventId`	`Id` of the `Event`
Return	`osid.calendaring.CommitmentList`		list of commitments
Errors	NULL_ARGUMENT		`eventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getCommitmentsForEventOnDate
Description	Gets a `CommitmentList` for the given event and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known commitments or an error results. Otherwise, the returned list may contain only those commitments that are accessible through this session. In effective mode, commitments are returned that are currently effective. In any effective mode, effective commitments and those currently expired are returned.
Parameters	`osid.id.Id`	`eventId`	`Id` of the `Event`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.calendaring.CommitmentList`		list of commitments
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`eventId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentsByGenusTypeForEvent
Description	Gets the commitments for the given event and commitment genus type including any genus types derived from the given genus type. If the event is a recurring event, the commitments are returned for the recurring event only. In plenary mode, the returned list contains all of the commitments mapped to the event `Id` or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible commitments may be ommitted. In effective mode, commitments are returned that are currently effective. In any effective mode, effective commitments and those currently expired are returned.
Parameters	`osid.id.Id`	`eventId`	`Id` of the `Event`
Parameters	`osid.type.Type`	`commitmentGenusType`	commitment genus type
Return	`osid.calendaring.CommitmentList`		list of commitments
Errors	NULL_ARGUMENT		`eventId` or `commitmentGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getCommitmentsByGenusTypeForEventOnDate
Description	Gets a `CommitmentList` for the given event and commitment genus type effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known commitments or an error results. Otherwise, the returned list may contain only those commitments that are accessible through this session. In effective mode, commitments are returned that are currently effective. In any effective mode, effective commitments and those currently expired are returned.
Parameters	`osid.id.Id`	`eventId`	`Id` of the `Event`
	`osid.type.Type`	`commitmentGenusType`	commitment genus type
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.calendaring.CommitmentList`		list of commitments
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`eventId, commitmentGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentsForResource
Description	Gets the commitments for the given resource. In plenary mode, the returned list contains all of the commitments mapped to the resource `Id` or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible `Commitments` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, commitments are returned that are currently effective. In any effective mode, effective commitments and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	`Id` of a `Resource`
Return	`osid.calendaring.CommitmentList`		list of commitments
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getCommitmentsForResourceOnDate
Description	Gets a `CommitmentList` for the given resource and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known commitments or an error results. Otherwise, the returned list may contain only those commitments that are accessible through this session. In effective mode, commitments are returned that are currently effective. In any effective mode, effective commitments and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	`Id` of the `Event`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.calendaring.CommitmentList`		list of commitments
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentsByGenusTypeForResource
Description	Gets the commitments for the given resource and commitment genus type including any genus types derived from the given genus type. In plenary mode, the returned list contains all of the commitments mapped to the resource `Id` or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible `Commitments` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, commitments are returned that are currently effective. In any effective mode, effective commitments and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	`Id` of a `Resource`
Parameters	`osid.type.Type`	`commitmentGenusType`	commitment genus type
Return	`osid.calendaring.CommitmentList`		list of commitments
Errors	NULL_ARGUMENT		`resourceId` or `commitmentGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getCommitmentsByGenusTypeForResourceOnDate
Description	Gets a `CommitmentList` for the given resource, commitment genus type, and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known commitments or an error results. Otherwise, the returned list may contain only those commitments that are accessible through this session. In effective mode, commitments are returned that are currently effective. In any effective mode, effective commitments and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	`Id` of the `Event`
	`osid.type.Type`	`commitmentGenusType`	commitment genus type
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.calendaring.CommitmentList`		list of commitments
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, commitmentGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentsForEventAndResource
Description	Gets the commitments for the given event and resource. If the event is a recurring event, the commitments are returned for the recurring event only. In plenary mode, the returned list contains all of the commitments mapped to the event `Id` or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible `Commitments` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, commitments are returned that are currently effective. In any effective mode, effective commitments and those currently expired are returned.
Parameters	`osid.id.Id`	`eventId`	`Id` of the `Event`
Parameters	`osid.id.Id`	`resourceId`	`Id` of a `Resource`
Return	`osid.calendaring.CommitmentList`		list of commitments
Errors	NULL_ARGUMENT		`eventId` or `resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getCommitmentsForEventAndResourceOnDate
Description	Gets a `CommitmentList` for the given event and resource and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known commitments or an error results. Otherwise, the returned list may contain only those commitments that are accessible through this session. In effective mode, commitments are returned that are currently effective. In any effective mode, effective commitments and those currently expired are returned.
Parameters	`osid.id.Id`	`eventId`	`Id` of the `Event`
	`osid.id.Id`	`resourceId`	`Id` of a `Resource`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.calendaring.CommitmentList`		list of commitments
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`eventId, resourceId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommitmentsByGenusTypeForEventAndResource
Description	Gets the commitments of the given genus type for the given event, resource, and commitment genus type including any genus types derived from the given genus type. If the event is a recurring event, the commitments are returned for the recurring event only. In plenary mode, the returned list contains all of the commitments mapped to the event `Id` or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible `Commitments` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, commitments are returned that are currently effective. In any effective mode, effective commitments and those currently expired are returned.
Parameters	`osid.id.Id`	`eventId`	`Id` of the `Event`
	`osid.id.Id`	`resourceId`	`Id` of a `Resource`
	`osid.type.Type`	`commitmentGenusType`	commitment genus type
Return	`osid.calendaring.CommitmentList`		list of commitments
Errors	NULL_ARGUMENT		`eventId, resourceId` or `commitmentGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getCommitmentsByGenusTypeForEventAndResourceOnDate
Description	Gets a `CommitmentList` of the given genus type for the given event, resource, commitment genus type and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known commitments or an error results. Otherwise, the returned list may contain only those commitments that are accessible through this session. In effective mode, commitments are returned that are currently effective. In any effective mode, effective commitments and those currently expired are returned.
Parameters	`osid.id.Id`	`eventId`	`Id` of the `Event`
	`osid.id.Id`	`resourceId`	`Id` of a `Resource`
	`osid.type.Type`	`commitmentGenusType`	commitment genus type
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.calendaring.CommitmentList`		list of commitments
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`eventId, resourceId, commitmentGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCommitments
Description	Gets all commitments. In plenary mode, the returned list contains all known commitments or an error results. Otherwise, the returned list may contain only those commitments that are accessible through this session. In effective mode, commitments are returned that are currently effective. In any effective mode, effective commitments and those currently expired are returned.
Return	`osid.calendaring.CommitmentList`		list of commitments
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.