OSID - osid.hold.HoldLookupSession Service Interface Definition

Interface	osid.hold.HoldLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Hold` relationships. 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 oubliette view: All hold methods in this session operate, retrieve and pertain to holds defined explicitly in the current oubliette. Using an isolated view is useful for managing `Holds` with the `HoldAdminSession.` federated oubliette view: All hold methods in this session operate, retrieve and pertain to all holds defined in this oubliette and any other holds implicitly available in this oubliette through oubliette inheritence. effective hold view: All hold lookup methods return holds where the current date falls in between the effective dates inclusive. any effective hold view: Holds of any effective date are returned from methods. 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 `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	canLookupHolds
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 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	useComparativeHoldView
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	usePlenaryHoldView
Description	A complete view of the `Hold` 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	useFederatedOublietteView
Description	Federates the view for methods in this session. A federated view will include holds in oubliettes 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 lookups to this oubliette only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveHoldView
Description	Only holds whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveHoldView
Description	All holds of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getHold
Description	Gets the `Hold` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Hold` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Hold` and retained for compatibility. In effective mode, holds are returned that are currently effective. In any effective mode, effective holds and those currently expired are returned.
Parameters	`osid.id.Id`	`holdId`	`Id` of the `Hold`
Return	`osid.hold.Hold`		the hold
Errors	NOT_FOUND		`holdId` not found
	NULL_ARGUMENT		`holdId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getHoldsByIds
Description	Gets a `HoldList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the holds 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 `Holds` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, holds are returned that are currently effective. In any effective mode, effective holds and those currently expired are returned.
Parameters	`osid.id.IdList`	`holdIds`	the list of `Ids` to retrieve
Return	`osid.hold.HoldList`		the returned `Hold` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`holdIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHoldsByGenusType
Description	Gets a `HoldList` corresponding to the given hold genus `Type` which does not include holds of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known holds or an error results. Otherwise, the returned list may contain only those holds that are accessible through this session. In effective mode, holds are returned that are currently effective. In any effective mode, effective holds and those currently expired are returned.
Parameters	`osid.type.Type`	`holdGenusType`	a hold genus type
Return	`osid.hold.HoldList`		the returned `Hold` list
Errors	NULL_ARGUMENT		`holdGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHoldsByParentGenusType
Description	Gets a `HoldList` corresponding to the given hold genus `Type` and include any additional holds with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known holds or an error results. Otherwise, the returned list may contain only those holds that are accessible through this session. In effective mode, holds are returned that are currently effective. In any effective mode, effective holds and those currently expired are returned.
Parameters	`osid.type.Type`	`holdGenusType`	a hold genus type
Return	`osid.hold.HoldList`		the returned `Hold` list
Errors	NULL_ARGUMENT		`holdGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHoldsByRecordType
Description	Gets a `HoldList` containing the given hold record `Type.` In plenary mode, the returned list contains all known holds or an error results. Otherwise, the returned list may contain only those holds that are accessible through this session. In effective mode, holds are returned that are currently effective. In any effective mode, effective holds and those currently expired are returned.
Parameters	`osid.type.Type`	`holdRecordType`	a hold record type
Return	`osid.hold.HoldList`		the returned `Hold` list
Errors	NULL_ARGUMENT		`holdRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHoldsOnDate
Description	Gets a list of holds for a resource, including any holds for agents related to the 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 holds or an error results. Otherwise, the returned list may contain only those holds that are accessible through this session. In effective mode, holds are returned that are currently effective. In any effective mode, effective holds 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.hold.HoldList`		the returned `Hold` 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	getHoldsForResource
Description	Gets a list of holds for a resource including any holds for agents related to the resource. In plenary mode, the returned list contains all known holds or an error results. Otherwise, the returned list may contain only those holds that are accessible through this session. In effective mode, holds are returned that are currently effective. In any effective mode, effective holds and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.hold.HoldList`		the returned `Hold` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHoldsForResourceOnDate
Description	Gets a list of holds for a resource, including any holds for agents related to the 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 holds or an error results. Otherwise, the returned list may contain only those holds that are accessible through this session. In effective mode, holds are returned that are currently effective. In any effective mode, effective holds 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.hold.HoldList`		the returned `Hold` list
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	getHoldsForAgent
Description	Gets a list of holds for an agent. In plenary mode, the returned list contains all known holds or an error results. Otherwise, the returned list may contain only those holds that are accessible through this session. In effective mode, holds are returned that are currently effective. In any effective mode, effective holds and those currently expired are returned.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
Return	`osid.hold.HoldList`		the returned `Hold` list
Errors	NULL_ARGUMENT		`agentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHoldsForAgentOnDate
Description	Gets a list of holds for an agent 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 holds or an error results. Otherwise, the returned list may contain only those holds that are accessible through this session. In both cases, the order of the set is by the start of the effective date. In effective mode, holds are returned that are currently effective. In any effective mode, effective holds and those currently expired are returned.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.hold.HoldList`		the returned `Hold` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`agentId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHoldsForIssue
Description	Gets a list of holds for an issue. In plenary mode, the returned list contains all known holds or an error results. Otherwise, the returned list may contain only those holds that are accessible through this session. In effective mode, holds are returned that are currently effective. In any effective mode, effective holds and those currently expired are returned.
Parameters	`osid.id.Id`	`issueId`	an issue `Id`
Return	`osid.hold.HoldList`		the returned C `ommission` 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	getHoldsForIssueOnDate
Description	Gets a list of holds for an issue 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 holds or an error results. Otherwise, the returned list may contain only those holds that are accessible through this session. In effective mode, holds are returned that are currently effective. In any effective mode, effective holds and those currently expired are returned.
Parameters	`osid.id.Id`	`issueId`	an issue `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.hold.HoldList`		the returned C `ommission` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`issueId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHoldsForResourceAndIssue
Description	Gets a list of holds for a resource and issue including any holds for agents related to the resource. In plenary mode, the returned list contains all known holds or an error results. Otherwise, the returned list may contain only those holds that are accessible through this session. In effective mode, holds are returned that are currently effective. In any effective mode, effective holds and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`osid.id.Id`	`issueId`	an issue `Id`
Return	`osid.hold.HoldList`		the returned C `ommission` list
Errors	NULL_ARGUMENT		`resourceId` or `issueid` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHoldsForResourceAndIssueOnDate
Description	Gets a list of holds for a resource, including any holds for agents related to the resource, and issue 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 holds or an error results. Otherwise, the returned list may contain only those holds that are accessible through this session. In effective mode, holds are returned that are currently effective. In any effective mode, effective holds and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.id.Id`	`issueId`	an issue `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.hold.HoldList`		the returned C `ommission` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, issueId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHoldsForAgentAndIssue
Description	Gets a list of holds for an agent. In plenary mode, the returned list contains all known holds or an error results. Otherwise, the returned list may contain only those holds that are accessible through this session. In effective mode, holds are returned that are currently effective. In any effective mode, effective holds and those currently expired are returned.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
Parameters	`osid.id.Id`	`issueId`	an issue `Id`
Return	`osid.hold.HoldList`		the returned C `ommission` list
Errors	NULL_ARGUMENT		`agentId` or `issueid` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHoldsForAgentAndIssueOnDate
Description	Gets a list of holds for an agent and issue 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 holds or an error results. Otherwise, the returned list may contain only those holds that are accessible through this session. In effective mode, holds are returned that are currently effective. In any effective mode, effective holds and those currently expired are returned.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
	`osid.id.Id`	`issueId`	an issue `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.hold.HoldList`		the returned C `ommission` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`agentId, issueId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getHolds
Description	Gets all `Holds.` In plenary mode, the returned list contains all known holds or an error results. Otherwise, the returned list may contain only those holds that are accessible through this session. In effective mode, holds are returned that are currently effective. In any effective mode, effective holds and those currently expired are returned.
Return	`osid.hold.HoldList`		a list of `Holds`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.