OSID - osid.offering.ParticipantLookupSession Service Interface Definition

Interface	osid.offering.ParticipantLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving participants. 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 isolated catalogue view: All participant methods in this session operate, retrieve and pertain to participants defined explicitly in the current catalogue. Using an isolated view is useful for managing participants with the `ParticipantAdminSession.` federated catalogue view: All participant lookup methods in this session operate, retrieve and pertain to all participants defined in this catalogue and any other catalogues implicitly available in this catalogue through catalogue inheritence. effective participant view: All participant lookup methods return participants where the current date falls in between the effective dates inclusive. any effective participant view: Participants of any effective date are returned from methods. The methods `useFederatedCatalogueView()` and `useIsolatedCatalogueView()` behave as a radio group and one should be selected before invoking any lookup methods.
Method	getCatalogueId
Description	Gets the `Catalogue` `Id` associated with this session.
Return	`osid.id.Id`		the `Catalogue Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogue
Description	Gets the `Catalogue` associated with this session.
Return	`osid.offering.Catalogue`		the catalogue
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupParticipants
Description	Tests if this user can examine this catalogue. 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 these operations.
Return	`boolean`		`false` if catalogue reading methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeParticipantView
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	usePlenaryParticipantView
Description	A complete view of the `Participant` 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	useFederatedCatalogueView
Description	Federates the view for methods in this session. A federated view will include participants in catalogues which are children of this catalogue in the catalogue hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCatalogueView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this catalogue only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveParticipantView
Description	Only participants whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveParticipantView
Description	All participants of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getParticipant
Description	Gets the `Participant` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Participant` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Participant` and retained for compatibility. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`participantId`	the `Id` of the `Participant` to retrieve
Return	`osid.offering.Participant`		the returned `Participant`
Errors	NOT_FOUND		no `Participant` found with the given `Id`
	NULL_ARGUMENT		`participantId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsByIds
Description	Gets a `ParticipantList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the participants 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 participants may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.IdList`	`participantIds`	the list of `Ids` to retrieve
Return	`osid.offering.ParticipantList`		the returned `Participant list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`participantIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsByGenusType
Description	Gets a `ParticipantList` corresponding to the given participant genus `Type` which does not include participants of types derived from the specified `Type.` In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.type.Type`	`participantGenusType`	a participant genus type
Return	`osid.offering.ParticipantList`		the returned `Participant list`
Errors	NULL_ARGUMENT		`participantGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsByParentGenusType
Description	Gets a `ParticipantList` corresponding to the given participant genus `Type` and include any additional participants with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In active mode, participants are returned that are currently active. In any status mode, active and inactive participants are returned.
Parameters	`osid.type.Type`	`participantGenusType`	a participant genus type
Return	`osid.offering.ParticipantList`		the returned `Participant list`
Errors	NULL_ARGUMENT		`participantGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsByRecordType
Description	Gets a `ParticipantList` containing the given participant record `Type.` In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.type.Type`	`participantRecordType`	a participant record type
Return	`osid.offering.ParticipantList`		the returned `ParticipantList`
Errors	NULL_ARGUMENT		`participantRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsOnDate
Description	Gets a `ParticipantList` effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	start of date range
Parameters	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.ParticipantList`		the returned `ParticipantList`
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	getParticipantsByGenusTypeOnDate
Description	Gets a `ParticipantList` by 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.type.Type`	`participantGenusType`	a participant genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.ParticipantList`		the returned `ParticipantList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`participantGenusType, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsForOffering
Description	Gets a `ParticipantList` for the given offering `.` In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`offeringId`	an offering `Id`
Return	`osid.offering.ParticipantList`		the returned `ParticipantList`
Errors	NULL_ARGUMENT		`offeringId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsByGenusTypeForOffering
Description	Gets a `ParticipantList` by genus type for the given offering `.` In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`offeringId`	an offering `Id`
Parameters	`osid.type.Type`	`participantGenusType`	a participant genus type
Return	`osid.offering.ParticipantList`		the returned `ParticipantList`
Errors	NULL_ARGUMENT		`participantGenusType` or `offeringId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsForOfferingOnDate
Description	Gets a `ParticipantList` for an offering 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`offeringId`	an offering `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.ParticipantList`		a list of participants
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`offeringId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsByGenusTypeForOfferingOnDate
Description	Gets a `ParticipantList` by genus type for an offering 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`offeringId`	an offering `Id`
	`osid.type.Type`	`participantGenusType`	a participant genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.ParticipantList`		a list of participants
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`offeringId, participantGenusType, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsByTimePeriodForOffering
Description	Gets a `ParticipantList` for the given offering in a time period `.` In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`offeringId`	an offering `Id`
Parameters	`osid.id.Id`	`timePeriodId`	a time period `Id`
Return	`osid.offering.ParticipantList`		the returned `ParticipantList`
Errors	NULL_ARGUMENT		`offeringId` or `timePeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsByTimePeriodAndGenusTypeForOffering
Description	Gets a `ParticipantList` by genus type for the given offering in a time period `.` In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`offeringId`	an offering `Id`
	`osid.id.Id`	`timePeriodId`	a time period `Id`
	`osid.type.Type`	`participantGenusType`	a participant genus type
Return	`osid.offering.ParticipantList`		the returned `ParticipantList`
Errors	NULL_ARGUMENT		`offeringId, timePeriodId,` or `participantGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsByTimePeriodForOfferingOnDate
Description	Gets a `ParticipantList` for an offering in a time period 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`offeringId`	an offering `Id`
	`osid.id.Id`	`timePeriodId`	a time period `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.ParticipantList`		a list of participants
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`offeringId, timePeriodId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsByTimePeriodAndGenusTypeForOfferingOnDate
Description	Gets a `ParticipantList` by genus type for an offering in a time period 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`offeringId`	an offering `Id`
	`osid.id.Id`	`timePeriodId`	a time period `Id`
	`osid.type.Type`	`participantGenusType`	a participant genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.ParticipantList`		a list of participants
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`offeringId, timePeriodId, participantGenusType, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsForResource
Description	Gets a `ParticipantList` for the given resource. In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.offering.ParticipantList`		the returned `ParticipantList`
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsByGenusTypeForResource
Description	Gets a `ParticipantList` by genus type for the given resource. In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`osid.type.Type`	`participantGenusType`	a participant genus type
Return	`osid.offering.ParticipantList`		the returned `ParticipantList`
Errors	NULL_ARGUMENT		`resourceId` or `participantGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsForResourceOnDate
Description	Gets a `ParticipantList` for a 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.ParticipantList`		a list of participants
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	getParticipantsByGenusTypeForResourceOnDate
Description	Gets a `ParticipantList` by genus type for a 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.type.Type`	`participantGenusType`	a participant genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.ParticipantList`		a list of participants
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, participantGenusType, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsByTimePeriodForResource
Description	Gets a `ParticipantList` for the given resource in a time period `.` In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`osid.id.Id`	`timePeriodId`	a time period `Id`
Return	`osid.offering.ParticipantList`		the returned `ParticipantList`
Errors	NULL_ARGUMENT		`resourceId` or `timePeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsByTimePeriodAndGenusTypeForResource
Description	Gets a `ParticipantList` by genus type for the given resource in a time period `.` In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.id.Id`	`timePeriodId`	a time period `Id`
	`osid.type.Type`	`participantGenusType`	a participant genus type
Return	`osid.offering.ParticipantList`		the returned `ParticipantList`
Errors	NULL_ARGUMENT		`resourceId, timePeriodId,` or `participantGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsByTimePeriodForResourceOnDate
Description	Gets a `ParticipantList` for a resource in a time period 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.id.Id`	`timePeriodId`	a time period `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.ParticipantList`		a list of participants
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, timePeriodId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsByTimePeriodAndGenusTypeForResourceOnDate
Description	Gets a `ParticipantList` by genus type for a resource in a time period 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.id.Id`	`timePeriodId`	a time period `Id`
	`osid.type.Type`	`participantGenusType`	a participant genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.ParticipantList`		a list of participants
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, timePeriodId, participantGenusType, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsForOfferingAndResource
Description	Gets a `ParticipantList` for the given offering and resource `.` In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`offeringId`	an offering `Id`
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.offering.ParticipantList`		the returned `ParticipantList`
Errors	NULL_ARGUMENT		`offeringId` or `resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsByGenusTypeForOfferingAndResource
Description	Gets a `ParticipantList` by genus type for the given offering and resource `.` In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`offeringId`	an offering `Id`
	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.type.Type`	`participantGenusType`	a participant genus type
Return	`osid.offering.ParticipantList`		the returned `ParticipantList`
Errors	NULL_ARGUMENT		`offeringId, resourceId` or `participantGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsForOfferingAndResourceOnDate
Description	Gets a `ParticipantList` for an offering, 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`offeringId`	an offering `Id`
	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.ParticipantList`		a list of participants
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	getParticipantsByGenusTypeForOfferingAndResourceOnDate
Description	Gets a `ParticipantList` by genus type for an offering, 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`offeringId`	an offering `Id`
	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.type.Type`	`participantGenusType`	a participant genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.ParticipantList`		a list of participants
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, participantGenusType, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsByTimePeriodForOfferingAndResource
Description	Gets a `ParticipantList` for the given offering and resource in a time period `.` In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`offeringId`	an offering `Id`
	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.id.Id`	`timePeriodId`	a time period `Id`
Return	`osid.offering.ParticipantList`		the returned `ParticipantList`
Errors	NULL_ARGUMENT		`offeringId, resourceId,` or `timePeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsByTimePeriodAndGenusTypeForOfferingAndResource
Description	Gets a `ParticipantList` by genus type for the given offering and resource in a time period `.` In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`offeringId`	an offering `Id`
	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.id.Id`	`timePeriodId`	a time period `Id`
	`osid.type.Type`	`participantGenusType`	a participant genus type
Return	`osid.offering.ParticipantList`		the returned `ParticipantList`
Errors	NULL_ARGUMENT		`offeringId, resourceId,` `timePeriodId` or `participantGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsByTimePeriodForOfferingAndResourceOnDate
Description	Gets a `ParticipantList` for an offering and resource in a time period 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`offeringId`	an offering `Id`
	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.id.Id`	`timePeriodId`	a time period `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.ParticipantList`		a list of participants
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`offeringId, resourceId, timePeriodId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsByTimePeriodAndGenusTypeForOfferingAndResourceOnDate
Description	Gets a `ParticipantList` by genus type for an offering and resource in a time period 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Parameters	`osid.id.Id`	`offeringId`	an offering `Id`
	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.id.Id`	`timePeriodId`	a time period `Id`
	`osid.type.Type`	`participantGenusType`	a participant genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.ParticipantList`		a list of participants
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`offeringId, resourceId, timePeriodId,participantGenusType, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParticipants
Description	Gets all participants. In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.
Return	`osid.offering.ParticipantList`		a list of participants
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.