OSID - osid.hold.MyHoldSession Service Interface Definition

Interface	osid.hold.MyHoldSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving holds pertaining to the authenticated agent. This lookup session defines several views: isolated oubliette view: All hold methods in this session operate, retrieve and pertain to holds defined explicitly in the current oubliette. federated oubliette view: All hold lookup methods holds this session operate, retrieve and pertain to all holds defined in this oubliette and any other availabilities implicitly available in this oubliette through oubliette inheritence. effective work view: All lookup methods return holds where the current date falls in between the effective dates inclusive. any effective work view: Holds of any effective date are returned from methods. The methods `useFederatedOublietteView()` and `useIsolatedOublietteView()` behave as a radio group and one should be selected before invoking any lookup methods.
Method	getOublietteId
Description	Gets the `Oubliette` `Id` associated with this session.
Return	`osid.id.Id`		the `Oubliette Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getOubliette
Description	Gets the `Oubliette` associated with this session.
Return	`osid.hold.Oubliette`		the oubliette
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupMyHolds
Description	Tests if this user can perform `Hold` 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	useFederatedOublietteView
Description	Federates the view for methods in this session. A federated view will include availabilities in foundries which are children of this oubliette in the oubliette hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedOublietteView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this oubliette only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveWorkView
Description	Only availabilities, commissions and efforts whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveWorkView
Description	All availabilities, commissions and efforts of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getMyHolds
Description	Gets all the holds associated with the authenticated agent.
Return	`osid.hold.HoldList`		the returned `HoldList`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMyHoldsForIssue
Description	Gets all the holds associated with the authenticated agent for the given issue.
Parameters	`osid.id.Id`	`issueId`	an issue `Id`
Return	`osid.hold.HoldList`		the returned `Hold` list
Errors	NULL_ARGUMENT		`issueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getMyHoldsForBlock
Description	Gets all the holds associated with the authenticated agent for the given block.
Parameters	`osid.id.Id`	`blockId`	a block `Id`
Return	`osid.hold.HoldList`		the returned `Hold` list
Errors	NULL_ARGUMENT		`blockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.