OSID - osid.course.syllabus.DocetLookupSession Service Interface Definition

Interface	osid.course.syllabus.DocetLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Docet` objects. The `Docet` represents a collection of syllabi. 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 view or is an error condition isolated course catalog view: All docet methods in this session operate, retrieve and pertain to docetsdefined explicitly in the current course catalog. Using an isolated view is useful for managing docetswith the `DocetAdminSession.` federated course catalog view: All docet lookup methods in this session operate, retrieve and pertain to all docetsdefined in this course catalog and any other course catalogs implicitly available in this course catalog through course catalog inheritence. effective docet view: All docet lookup methods return docets where the current date falls in between the effective dates inclusive. any effective docet view: Docets of any effective date are returned from methods.
Method	getCourseCatalogId
Description	Gets the `CourseCatalog` `Id` associated with this session.
Return	`osid.id.Id`		the `CourseCatalog Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalog
Description	Gets the `CourseCatalog` associated with this session.
Return	`osid.course.CourseCatalog`		the course catalog
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupDocets
Description	Tests if this user can perform `Docet` lookups. 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 not 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	useComparativeDocetView
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	usePlenaryDocetView
Description	A complete view of the `Docet` 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	useFederatedCourseCatalogView
Description	Federates the view for methods in this session. A federated view will include docetsin course catalogs which are children of this course catalog in the course catalog hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCourseCatalogView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveDocetView
Description	Only docets whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveDocetView
Description	All docets of any effective dates are returned by all methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getDocet
Description	Gets the `Docet` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Docet` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `Docet` and retained for compatibility. In effective mode, docets are returned that are currently effective. In any effective mode, effective docets and those currently expired are returned.
Parameters	`osid.id.Id`	`docetId`	`Id` of the `Docet`
Return	`osid.course.syllabus.Docet`		the docet
Errors	NOT_FOUND		`docetId` not found
	NULL_ARGUMENT		`docetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getDocetsByIds
Description	Gets an `DocetList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the docetsspecified 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 `Docets` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, docets are returned that are currently effective. In any effective mode, effective docets and those currently expired are returned.
Parameters	`osid.id.IdList`	`docetIds`	the list of `Ids` to retrieve
Return	`osid.course.syllabus.DocetList`		the returned `Docet` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`docetIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDocetsByGenusType
Description	Gets an `DocetList` corresponding to the given docet genus `Type` which does not include docetsof genus types derived from the specified `Type.` In plenary mode, the returned list contains all known docetsor an error results. Otherwise, the returned list may contain only those docets that are accessible through this session. In effective mode, docets are returned that are currently effective. In any effective mode, effective docets and those currently expired are returned.
Parameters	`osid.type.Type`	`docetGenusType`	a docet genus type
Return	`osid.course.syllabus.DocetList`		the returned `Docet` list
Errors	NULL_ARGUMENT		`docetGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDocetsByParentGenusType
Description	Gets an `DocetList` corresponding to the given docet genus `Type` and include any additional docetswith genus types derived from the specified `Type.` In plenary mode, the returned list contains all known docetsor an error results. Otherwise, the returned list may contain only those docets that are accessible through this session. In effective mode, docets are returned that are currently effective. In any effective mode, effective docets and those currently expired are returned.
Parameters	`osid.type.Type`	`docetGenusType`	a docet genus type
Return	`osid.course.syllabus.DocetList`		the returned `Docet` list
Errors	NULL_ARGUMENT		`docetGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDocetsByRecordType
Description	Gets an `DocetList` containing the given docet record `Type.` In plenary mode, the returned list contains all known docetsor an error results. Otherwise, the returned list may contain only those docets that are accessible through this session. In effective mode, docets are returned that are currently effective. In any effective mode, effective docets and those currently expired are returned.
Parameters	`osid.type.Type`	`docetRecordType`	a docet record type
Return	`osid.course.syllabus.DocetList`		the returned `Docet` list
Errors	NULL_ARGUMENT		`docetRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDocetsOnDate
Description	Gets an `DocetList` effective sduring the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known docetsor an error results. Otherwise, the returned list may contain only those docets that are accessible through this session. In effective mode, docets are returned that are currently effective. In any effective mode, effective docets and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	s atsrting date
Parameters	`osid.calendaring.DateTime`	`to`	an ending date
Return	`osid.course.syllabus.DocetList`		the returned `Docet` list
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	getDocetsForModule
Description	Gets an `DocetList` for the given module `Id.` In plenary mode, the returned list contains all known docetsor an error results. Otherwise, the returned list may contain only those docets that are accessible through this session. In effective mode, docets are returned that are currently effective. In any effective mode, effective docets and those currently expired are returned.
Parameters	`osid.id.Id`	`moduleId`	a module `Id`
Return	`osid.course.syllabus.DocetList`		the returned `Docet` list
Errors	NULL_ARGUMENT		`moduleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDocetsForModuleOnDate
Description	Gets an `DocetList` for a module effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known docetsor an error results. Otherwise, the returned list may contain only those docets that are accessible through this session. In effective mode, docets are returned that are currently effective. In any effective mode, effective docets and those currently expired are returned.
Parameters	`osid.id.Id`	`moduleId`	a module `Id`
	`osid.calendaring.DateTime`	`from`	s atsrting date
	`osid.calendaring.DateTime`	`to`	an ending date
Return	`osid.course.syllabus.DocetList`		the returned `Docet` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`moduleId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDocetsForActivityUnit
Description	Gets an `DocetList` for the given activity unit `Id.` In plenary mode, the returned list contains all known docetsor an error results. Otherwise, the returned list may contain only those docets that are accessible through this session. In effective mode, docets are returned that are currently effective. In any effective mode, effective docets and those currently expired are returned.
Parameters	`osid.id.Id`	`activityUnitId`	an activity unit `Id`
Return	`osid.course.syllabus.DocetList`		the returned `Docet` list
Errors	NULL_ARGUMENT		`activityUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDocetsForActivityUnitOnDate
Description	Gets an `DocetList` for an activity unit effective sduring the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known docetsor an error results. Otherwise, the returned list may contain only those docets that are accessible through this session. In effective mode, docets are returned that are currently effective. In any effective mode, effective docets and those currently expired are returned.
Parameters	`osid.id.Id`	`activityUnitId`	an activity unit `Id`
	`osid.calendaring.DateTime`	`from`	s atsrting date
	`osid.calendaring.DateTime`	`to`	an ending date
Return	`osid.course.syllabus.DocetList`		the returned `Docet` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`activityUnitId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDocetsForModuleAndActivityUnit
Description	Gets an `DocetList` for the given module and activity unit `.` In plenary mode, the returned list contains all known docetsor an error results. Otherwise, the returned list may contain only those docets that are accessible through this session. In effective mode, docets are returned that are currently effective. In any effective mode, effective docets and those currently expired are returned.
Parameters	`osid.id.Id`	`moduleId`	a module `Id`
Parameters	`osid.id.Id`	`activityUnitId`	an activity unit `Id`
Return	`osid.course.syllabus.DocetList`		the returned `Docet` list
Errors	NULL_ARGUMENT		`moduleId` or `activityUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDocetsForModuleAndActivityUnitOnDate
Description	Gets an `DocetList` for a module and activity unit effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known docetsor an error results. Otherwise, the returned list may contain only those docets that are accessible through this session. In effective mode, docets are returned that are currently effective. In any effective mode, effective docets and those currently expired are returned.
Parameters	`osid.id.Id`	`moduleId`	a module `Id`
	`osid.id.Id`	`activityUnitId`	an activity unit `Id`
	`osid.calendaring.DateTime`	`from`	s atsrting date
	`osid.calendaring.DateTime`	`to`	an ending date
Return	`osid.course.syllabus.DocetList`		the returned `Docet` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`moduleId, activityUnitId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDocets
Description	Gets all `Docets.` In plenary mode, the returned list contains all known docetsor an error results. Otherwise, the returned list may contain only those docets that are accessible through this session. In effective mode, docets are returned that are currently effective. In any effective mode, effective docets and those currently expired are returned.
Return	`osid.course.syllabus.DocetList`		a list of `Docets`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.