OSID - osid.room.construction.ProjectLookupSession Service Interface Definition

Interface	osid.room.construction.ProjectLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Project` objects. The `Project` represents a construction of a building. 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 campus view: All room methods in this session operate, retrieve and pertain to projects defined explicitly in the current campus. Using an isolated view is useful for managing projects with the `ProjectAdminSession.` federated campus view: All project lookup methods in this session operate, retrieve and pertain to all projects defined in this campus and any other campuses implicitly available in this campus through campus inheritence. effective project view: All project lookup methods return effective projects. any effective project view: projects of any effective date are returned.
Method	getCampusId
Description	Gets the `Campus` `Id` associated with this session.
Return	`osid.id.Id`		the `Campus Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCampus
Description	Gets the `Campus` associated with this session.
Return	`osid.room.Campus`		the campus
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupProjects
Description	Tests if this user can perform `Project` 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	useComparativeProjectView
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	usePlenaryProjectView
Description	A complete view of the `Project` 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	useFederatedCampusView
Description	Federates the view for methods in this session. A federated view will include projects in campuses which are children of this campus in the campus hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCampusView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this campus only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveProjectView
Description	Only projects whose effective dates are current are returned by methods in this session
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveProjectView
Description	Projects of any effective dates are returned by all methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getProject
Description	Gets the `Project` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Project` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Project` and retained for compatibility. In effective mode, projects are returned that are currently effective. In any effective mode, effective projects and those currently expired are returned.
Parameters	`osid.id.Id`	`projectId`	`Id` of the `Project`
Return	`osid.room.construction.Project`		the project
Errors	NOT_FOUND		`projectId` not found
	NULL_ARGUMENT		`projectId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getProjectsByIds
Description	Gets a `ProjectList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the projects 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 `Projects` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, projects are returned that are currently effective. In any effective mode, effective projects and those currently expired are returned.
Parameters	`osid.id.IdList`	`projectIds`	the list of `Ids` to retrieve
Return	`osid.room.construction.ProjectList`		the returned `Project` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`projectIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProjectsByGenusType
Description	Gets a `ProjectList` corresponding to the given project genus `Type` which does not include projects of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known projects or an error results. Otherwise, the returned list may contain only those projects that are accessible through this session. In effective mode, projects are returned that are currently effective. In any effective mode, effective projects and those currently expired are returned.
Parameters	`osid.type.Type`	`projectGenusType`	a project genus type
Return	`osid.room.construction.ProjectList`		the returned `Project` list
Errors	NULL_ARGUMENT		`projectGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProjectsByParentGenusType
Description	Gets a `ProjectList` corresponding to the given project genus `Type` and include any additional projects with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known projects or an error results. Otherwise, the returned list may contain only those projects that are accessible through this session. In effective mode, projects are returned that are currently effective. In any effective mode, effective projects and those currently expired are returned.
Parameters	`osid.type.Type`	`projectGenusType`	a project genus type
Return	`osid.room.construction.ProjectList`		the returned `Project` list
Errors	NULL_ARGUMENT		`projectGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProjectsByRecordType
Description	Gets a `ProjectList` containing the given project record `Type.` In plenary mode, the returned list contains all known projects or an error results. Otherwise, the returned list may contain only those projects that are accessible through this session. In effective mode, projects are returned that are currently effective. In any effective mode, effective projects and those currently expired are returned.
Parameters	`osid.type.Type`	`projectRecordType`	a project record type
Return	`osid.room.construction.ProjectList`		the returned `Project` list
Errors	NULL_ARGUMENT		`projectRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProjectsOnDate
Description	Gets a list of all projects effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known projects or an error results. Otherwise, the returned list may contain only those projects that are accessible through this session. In effective mode, projects are returned that are currently effective. In any effective mode, effective projects 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.room.construction.ProjectList`		the returned `Project` 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	getProjectsByGenusTypeOnDate
Description	Gets a list of all projects with a 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 projects or an error results. Otherwise, the returned list may contain only those projects that are accessible through this session. In effective mode, projects are returned that are currently effective. In any effective mode, effective projects and those currently expired are returned.
Parameters	`osid.type.Type`	`projectGenusType`	a project genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.room.construction.ProjectList`		the returned `Project` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`projectGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProjectsForBuilding
Description	Gets a `ProjectList` containing the given building `.` In plenary mode, the returned list contains all known projects or an error results. Otherwise, the returned list may contain only those projects that are accessible through this session. In effective mode, projects are returned that are currently effective. In any effective mode, effective projects and those currently expired are returned.
Parameters	`osid.id.Id`	`buildingId`	a building `Id`
Return	`osid.room.construction.ProjectList`		the returned `Project` list
Errors	NULL_ARGUMENT		`buildingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProjectsByGenusTypeForBuilding
Description	Gets a `ProjectList` containing the given building and genus type `.` In plenary mode, the returned list contains all known projects or an error results. Otherwise, the returned list may contain only those projects that are accessible through this session. In effective mode, projects are returned that are currently effective. In any effective mode, effective projects and those currently expired are returned.
Parameters	`osid.id.Id`	`buildingId`	a building `Id`
Parameters	`osid.type.Type`	`projectGenusType`	a project genus type
Return	`osid.room.construction.ProjectList`		the returned `Project` list
Errors	NULL_ARGUMENT		`buildingId` or `projectGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProjectsForBuildingOnDate
Description	Gets a list of all projects for a building effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known projects or an error results. Otherwise, the returned list may contain only those projects that are accessible through this session. In effective mode, projects are returned that are currently effective. In any effective mode, effective projects and those currently expired are returned.
Parameters	`osid.id.Id`	`buildingId`	a building `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.room.construction.ProjectList`		the returned `Project` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`buildingId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProjectsByGenusTypeForBuildingOnDate
Description	Gets a list of all projects for a building with a 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 projects or an error results. Otherwise, the returned list may contain only those projects that are accessible through this session. In effective mode, projects are returned that are currently effective. In any effective mode, effective projects and those currently expired are returned.
Parameters	`osid.id.Id`	`buildingId`	a building `Id`
	`osid.type.Type`	`projectGenusType`	a project genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.room.construction.ProjectList`		the returned `Project` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`buildingId, projectGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProjects
Description	Gets all `Projects.` In plenary mode, the returned list contains all known projects or an error results. Otherwise, the returned list may contain only those projects that are accessible through this session. In effective mode, projects are returned that are currently effective. In any effective mode, effective projects and those currently expired are returned.
Return	`osid.room.construction.ProjectList`		a list of `Projects`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.