OSID - osid.resourcing.WorkLookupSession Service Interface Definition

Interface	osid.resourcing.WorkLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Work` objects. The `Work` represents a fixed connection between two `Availabilities.` 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 foundry view: All work methods in this session operate, retrieve and pertain to works defined explicitly in the current foundry. Using an isolated view is useful for managing `Works` with the `WorkAdminSession.` federated foundry view: All work methods in this session operate, retrieve and pertain to all works defined in this foundry and any other works implicitly available in this foundry through foundry inheritence. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedFoundryView()` and `useIsolatedFoundryView()` behave as a radio group and one should be selected before invoking any lookup methods.
Method	getFoundryId
Description	Gets the `Foundry` `Id` associated with this session.
Return	`osid.id.Id`		the `Foundry Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFoundry
Description	Gets the `Foundry` associated with this session.
Return	`osid.resourcing.Foundry`		the foundry
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupWorks
Description	Tests if this user can perform `Work` 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 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	useComparativeWorkView
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	usePlenaryWorkView
Description	A complete view of the `Work` 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	useFederatedFoundryView
Description	Federates the view for methods in this session. A federated view will include works in foundries which are children of this foundry in the foundry hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedFoundryView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this foundry only.
Compliance	`mandatory`		This method is must be implemented.
Method	getWork
Description	Gets the `Work` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Work` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Work` and retained for compatibility.
Parameters	`osid.id.Id`	`workId`	`Id` of the `Work`
Return	`osid.resourcing.Work`		the work
Errors	NOT_FOUND		`workId` not found
	NULL_ARGUMENT		`workId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getWorksByIds
Description	Gets a `WorkList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the works 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 `Works` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`workIds`	the list of `Ids` to retrieve
Return	`osid.resourcing.WorkList`		the returned `Work` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`workIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getWorksByGenusType
Description	Gets a `WorkList` corresponding to the given work genus `Type` which does not include works of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known works or an error results. Otherwise, the returned list may contain only those works that are accessible through this session.
Parameters	`osid.type.Type`	`workGenusType`	a work genus type
Return	`osid.resourcing.WorkList`		the returned `Work` list
Errors	NULL_ARGUMENT		`workGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getWorksByParentGenusType
Description	Gets a `WorkList` corresponding to the given work genus `Type` and include any additional works with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known works or an error results. Otherwise, the returned list may contain only those works that are accessible through this session.
Parameters	`osid.type.Type`	`workGenusType`	a work genus type
Return	`osid.resourcing.WorkList`		the returned `Work` list
Errors	NULL_ARGUMENT		`workGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getWorksByRecordType
Description	Gets a `WorkList` containing the given work record `Type.` In plenary mode, the returned list contains all known works or an error results. Otherwise, the returned list may contain only those works that are accessible through this session.
Parameters	`osid.type.Type`	`workRecordType`	a work record type
Return	`osid.resourcing.WorkList`		the returned `Work` list
Errors	NULL_ARGUMENT		`workRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getWorksForJob
Description	Gets a `WorkList` corresponding to the given job `.` In plenary mode, the returned list contains all known works or an error results. Otherwise, the returned list may contain only those works that are accessible through this session.
Parameters	`osid.id.Id`	`jobId`	a job `Id`
Return	`osid.resourcing.WorkList`		the returned `Work` list
Errors	NULL_ARGUMENT		`jobId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getUncommittedWorksForJob
Description	Gets a `WorkList` of uncommitted works corresponding to the given job `.` In plenary mode, the returned list contains all known works or an error results. Otherwise, the returned list may contain only those works that are accessible through this session.
Parameters	`osid.id.Id`	`jobId`	a job `Id`
Return	`osid.resourcing.WorkList`		the returned `Work` list
Errors	NULL_ARGUMENT		`jobId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIncompleteWorksForJob
Description	Gets a `WorkList` of incomplete works corresponding to the given job `.` In plenary mode, the returned list contains all known works or an error results. Otherwise, the returned list may contain only those works that are accessible through this session.
Parameters	`osid.id.Id`	`jobId`	a job `Id`
Return	`osid.resourcing.WorkList`		the returned `Work` list
Errors	NULL_ARGUMENT		`jobId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getWorksByDate
Description	Gets a `WorkList` of all works created between the given date range inclusive `.` In plenary mode, the returned list contains all known works or an error results. Otherwise, the returned list may contain only those works that are accessible through this session.
Parameters	`osid.calendaring.DateTime`	`from`	start range
Parameters	`osid.calendaring.DateTime`	`to`	end range
Return	`osid.resourcing.WorkList`		the returned `Work` 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	getIncompleteWorksByDate
Description	Gets a `WorkList` of incomplete works created between the given date range inclusive `.` In plenary mode, the returned list contains all known works or an error results. Otherwise, the returned list may contain only those works that are accessible through this session.
Parameters	`osid.calendaring.DateTime`	`from`	start range
Parameters	`osid.calendaring.DateTime`	`to`	end range
Return	`osid.resourcing.WorkList`		the returned `Work` 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	getUncommittedWorksByDate
Description	Gets a `WorkList` of uncommitted works created between the given date range inclusive `.` In plenary mode, the returned list contains all known works or an error results. Otherwise, the returned list may contain only those works that are accessible through this session.
Parameters	`osid.calendaring.DateTime`	`from`	start range
Parameters	`osid.calendaring.DateTime`	`to`	end range
Return	`osid.resourcing.WorkList`		the returned `Work` 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	getWorksByDateForJob
Description	Gets a `WorkList` of all works of corresponding to the given job and created between the given date range inclusive `.` In plenary mode, the returned list contains all known works or an error results. Otherwise, the returned list may contain only those works that are accessible through this session.
Parameters	`osid.id.Id`	`jobId`	a job `Id`
	`osid.calendaring.DateTime`	`from`	start range
	`osid.calendaring.DateTime`	`to`	end range
Return	`osid.resourcing.WorkList`		the returned `Work` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`jobId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIncompleteWorksByDateForJob
Description	Gets a `WorkList` of incomplete works corresponding to the given job and created between the given date range inclusive `.` In plenary mode, the returned list contains all known works or an error results. Otherwise, the returned list may contain only those works that are accessible through this session.
Parameters	`osid.id.Id`	`jobId`	a job `Id`
	`osid.calendaring.DateTime`	`from`	start range
	`osid.calendaring.DateTime`	`to`	end range
Return	`osid.resourcing.WorkList`		the returned `Work` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`jobId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getIncompleteWorks
Description	Gets all incomplete `Works.` In plenary mode, the returned list contains all known works or an error results. Otherwise, the returned list may contain only those works that are accessible through this session.
Return	`osid.resourcing.WorkList`		a list of `Works`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getUncommittedWorks
Description	Gets all `Works` that have no commitments. In plenary mode, the returned list contains all known works or an error results. Otherwise, the returned list may contain only those works that are accessible through this session.
Return	`osid.resourcing.WorkList`		a list of uncommitted `Works`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getWorks
Description	Gets all `Works.` In plenary mode, the returned list contains all known works or an error results. Otherwise, the returned list may contain only those works that are accessible through this session.
Return	`osid.resourcing.WorkList`		a list of `Works`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.