OSID - osid.subscription.DispatchLookupSession Service Interface Definition

Interface	osid.subscription.DispatchLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Dispatch` objects. The `Dispatch` represents a collection of subscriptions. 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 publisher view: All subscription methods in this session operate, retrieve and pertain to dispatches defined explicitly in the current publisher. Using an isolated view is useful for managing dispatches with the `DispatchAdminSession.` federated publisher view: All subscription lookup methods in this session operate, retrieve and pertain to all dispatches defined in this publisher and any other publishers implicitly available in this publisher through publisher inheritence. active dispatch view: All dispatch lookup methods return active dispatches. any status dispatch view: Dispatches of any active or inactive status are returned from methods.
Method	getPublisherId
Description	Gets the `Publisher` `Id` associated with this session.
Return	`osid.id.Id`		the `Publisher Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getPublisher
Description	Gets the `Publisher` associated with this session.
Return	`osid.subscription.Publisher`		the publisher
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupDispatches
Description	Tests if this user can perform `Dispatch` 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	useComparativeDispatchView
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	usePlenaryDispatchView
Description	A complete view of the `Dispatch` 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	useFederatedPublisherView
Description	Federates the view for methods in this session. A federated view will include dispatches in publishers which are children of this publisher in the publisher hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedPublisherView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this publisher only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveDispatchView
Description	Only active dispatches are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusDispatchView
Description	All active and inactive dispatches are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getDispatch
Description	Gets the `Dispatch` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Dispatch` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Dispatch` and retained for compatibility. In active mode, dispatches are returned that are currently active. In any status mode, active and inactive dispatches are returned.
Parameters	`osid.id.Id`	`dispatchId`	`Id` of the `Dispatch`
Return	`osid.subscription.Dispatch`		the dispatch
Errors	NOT_FOUND		`dispatchId` not found
	NULL_ARGUMENT		`dispatchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getDispatchesByIds
Description	Gets a `DispatchList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the dispatches 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 `Dispatches` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, dispatches are returned that are currently active. In any status mode, active and inactive dispatches are returned.
Parameters	`osid.id.IdList`	`dispatchIds`	the list of `Ids` to retrieve
Return	`osid.subscription.DispatchList`		the returned `Dispatch` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`dispatchIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchesByGenusType
Description	Gets a `DispatchList` corresponding to the given dispatch genus `Type` which does not include dispatches of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known dispatches or an error results. Otherwise, the returned list may contain only those dispatches that are accessible through this session. In active mode, dispatches are returned that are currently active. In any status mode, active and inactive dispatches are returned.
Parameters	`osid.type.Type`	`dispatchGenusType`	a dispatch genus type
Return	`osid.subscription.DispatchList`		the returned `Dispatch` list
Errors	NULL_ARGUMENT		`dispatchGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchesByParentGenusType
Description	Gets a `DispatchList` corresponding to the given dispatch genus `Type` and include any additional dispatches with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known dispatches or an error results. Otherwise, the returned list may contain only those dispatches that are accessible through this session. In active mode, dispatches are returned that are currently active. In any status mode, active and inactive dispatches are returned.
Parameters	`osid.type.Type`	`dispatchGenusType`	a dispatch genus type
Return	`osid.subscription.DispatchList`		the returned `Dispatch` list
Errors	NULL_ARGUMENT		`dispatchGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchesByRecordType
Description	Gets a `DispatchList` containing the given dispatch record `Type.` In plenary mode, the returned list contains all known dispatches or an error results. Otherwise, the returned list may contain only those dispatches that are accessible through this session. In active mode, dispatches are returned that are currently active. In any status mode, active and inactive dispatches are returned.
Parameters	`osid.type.Type`	`dispatchRecordType`	a dispatch record type
Return	`osid.subscription.DispatchList`		the returned `Dispatch` list
Errors	NULL_ARGUMENT		`dispatchRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchesByProvider
Description	Gets a `DispatchList` for the given provider. In plenary mode, the returned list contains all known dispatches or an error results. Otherwise, the returned list may contain only those dispatches that are accessible through this session. In active mode, dispatches are returned that are currently active. In any status mode, active and inactive dispatches are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.subscription.DispatchList`		the returned `Dispatch` 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	getDispatches
Description	Gets all `Dispatches.` In plenary mode, the returned list contains all known dispatches or an error results. Otherwise, the returned list may contain only those dispatches that are accessible through this session. In active mode, dispatches are returned that are currently active. In any status mode, active and inactive dispatches are returned.
Return	`osid.subscription.DispatchList`		a list of `Dispatches`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.