OSID - osid.subscription.SubscriptionLookupSession Service Interface Definition

Interface	osid.subscription.SubscriptionLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving subscriptions. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated publisher view: All subscription methods in this session operate, retrieve and pertain to subscriptions defined explicitly in the current publisher. Using an isolated view is useful for managing subscriptions with the `SubscriptionAdminSession.` federated publisher view: All subscription lookup methods in this session operate, retrieve and pertain to all subscriptions defined in this publisher and any other publishers implicitly available in this publisher through publisher inheritence. effective subscription view: All subscription lookup methods return subscriptions where the current date falls in between the effective dates inclusive. any effective subscription view: Subscriptions of any effective date are returned from methods. The methods `useFederatedPublisherView()` and `useIsolatedPublisherView()` behave as a radio group and one should be selected before invoking any lookup 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	canLookupSubscriptions
Description	Tests if this user can lookup subscriptions. 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 these operations.
Return	`boolean`		`false` if subscription lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeSubscriptionView
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	usePlenarySubscriptionView
Description	A complete view of the `Subscription` 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 entries 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	useEffectiveSubscriptionView
Description	Only subscriptions whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveSubscriptionView
Description	All subscriptions of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getSubscription
Description	Gets the `Subscription` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Subscription` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Subscription` and retained for compatibility. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned.
Parameters	`osid.id.Id`	`subscriptionId`	the `Id` of the `Subscription` to retrieve
Return	`osid.subscription.Subscription`		the returned `Subscription`
Errors	NOT_FOUND		no `Subscription` found with the given `Id`
	NULL_ARGUMENT		`subscriptionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionsByIds
Description	Gets a `SubscriptionList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the entries 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 entries may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned.
Parameters	`osid.id.IdList`	`subscriptionIds`	the list of `Ids` to retrieve
Return	`osid.subscription.SubscriptionList`		the returned `Subscription list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`subscriptionIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionsByGenusType
Description	Gets a `SubscriptionList` corresponding to the given subscription genus `Type` which does not include subscriptions of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known subscriptions or an error results. Otherwise, the returned list may contain only those subscriptions that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned.
Parameters	`osid.type.Type`	`subscriptionGenusType`	a subscription genus type
Return	`osid.subscription.SubscriptionList`		the returned `Subscription` list
Errors	NULL_ARGUMENT		`subscriptionGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionsByParentGenusType
Description	Gets a `SubscriptionList` corresponding to the given subscription genus `Type` and include any additional subscriptions with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known subscriptions or an error results. Otherwise, the returned list may contain only those subscriptions that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned.
Parameters	`osid.type.Type`	`subscriptionGenusType`	a subscription genus type
Return	`osid.subscription.SubscriptionList`		the returned `Subscriptions` list
Errors	NULL_ARGUMENT		`subscriptionGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionsByRecordType
Description	Gets a `SubscriptionList` containing the given subscription record `Type.` In plenary mode, the returned list contains all known subscriptions or an error results. Otherwise, the returned list may contain only those subscriptions that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned.
Parameters	`osid.type.Type`	`subscriptionRecordType`	a subscription record type
Return	`osid.subscription.SubscriptionList`		the returned `Subscriptions` list
Errors	NULL_ARGUMENT		`subscriptionRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionsOnDate
Description	Gets a `SubscriptionList` effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known subscriptions or an error results. Otherwise, the returned list may contain only those subscriptions that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
Parameters	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.subscription.SubscriptionList`		the returned `Subscriptions` 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	getSubscriptionsByGenusTypeOnDate
Description	Gets a `SubscriptionList` of a subscription 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 subscriptions or an error results. Otherwise, the returned list may contain only those subscriptions that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned.
Parameters	`osid.type.Type`	`subscriptionGenusType`	a subscription genus type
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.subscription.SubscriptionList`		the returned `Subscriptions` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`subscriptionGenusType, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionsForSubscriber
Description	Gets a list of subscriptions corresponding to a subscriber `Id.` In plenary mode, the returned list contains all known subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource
Return	`osid.subscription.SubscriptionList`		the returned `SubscriptionList`
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionsForSubscriberOnDate
Description	Gets a list of all subscriptions corresponding to a subscriber `Id` 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 subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.subscription.SubscriptionList`		the returned `SubscriptionList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	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	getSubscriptionsByGenusTypeForSubscriber
Description	Gets a list of subscriptions of the given genus type corresponding to a subscriber `Id.` In plenary mode, the returned list contains all known subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource
Parameters	`osid.type.Type`	`subscriptionGenusType`	a subscription genus type
Return	`osid.subscription.SubscriptionList`		the returned `SubscriptionList`
Errors	NULL_ARGUMENT		`resourceId` or `subscriptionGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionsByGenusTypeForSubscriberOnDate
Description	Gets a list of all subscriptions of the given genus type corresponding to a subscriber `Id` 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 subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.type.Type`	`subscriptionGenusType`	a subscription genus type
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.subscription.SubscriptionList`		the returned `SubscriptionList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`resourceId, subscriptionGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionsForDispatch
Description	Gets a list of all subscriptions corresponding to a dispatch `Id.` In plenary mode, the returned list contains all known subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned.
Parameters	`osid.id.Id`	`dispatchId`	the `Id` of the dispatch
Return	`osid.subscription.SubscriptionList`		the returned `SubscriptionList`
Errors	NULL_ARGUMENT		`dispatchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionsForDispatchOnDate
Description	Gets a list of all subscriptions corresponding to a dispatch `Id` 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 subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned.
Parameters	`osid.id.Id`	`dispatchId`	a dispatch `Id`
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.subscription.SubscriptionList`		the returned `SubscriptionList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`dispatchId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionsByGenusTypeForDispatch
Description	Gets a list of all subscriptions of the given genus type corresponding to a dispatch `Id.` In plenary mode, the returned list contains all known subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned.
Parameters	`osid.id.Id`	`dispatchId`	the `Id` of the dispatch
Parameters	`osid.type.Type`	`subscriptionGenusType`	a subscription genus type
Return	`osid.subscription.SubscriptionList`		the returned `SubscriptionList`
Errors	NULL_ARGUMENT		`dispatchId` or `subscriptionGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionsByGenusTypeForDispatchOnDate
Description	Gets a list of all subscriptions of the given genus type corresponding to a dispatch `Id` 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 subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned.
Parameters	`osid.id.Id`	`dispatchId`	a dispatch `Id`
	`osid.type.Type`	`subscriptionGenusType`	a subscription genus type
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.subscription.SubscriptionList`		the returned `SubscriptionList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`dispatchId, subscriptionGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionsForSubscriberAndDispatch
Description	Gets a list of all subscriptions corresponding to a susbcriber and dispatch `Id.` In plenary mode, the returned list contains all known subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource
Parameters	`osid.id.Id`	`dispatchId`	the `Id` of the dispatch
Return	`osid.subscription.SubscriptionList`		the returned `SubscriptionList`
Errors	NULL_ARGUMENT		`resourceId` or `dispatchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionsForSubscriberAndDispatchOnDate
Description	Gets a list of all subscriptions corresponding to a subscriber and dispatch `Id` 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 subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource
	`osid.id.Id`	`dispatchId`	a dispatch `Id`
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.subscription.SubscriptionList`		the returned `SubscriptionList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`resourceId, dispatchI, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionsByGenusTypeForSubscriberAndDispatch
Description	Gets a list of all subscriptions of the given genus type corresponding to a susbcriber and dispatch `Id.` In plenary mode, the returned list contains all known subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource
	`osid.id.Id`	`dispatchId`	the `Id` of the dispatch
	`osid.type.Type`	`subscriptionGenusType`	a subscription genus type
Return	`osid.subscription.SubscriptionList`		the returned `SubscriptionList`
Errors	NULL_ARGUMENT		`resourceId, dispatchId` or `subscriptionGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionsByGenusTypeForSubscriberAndDispatchOnDate
Description	Gets a list of all subscriptions of the given genus type corresponding to a subscriber and dispatch `Id` 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 subscriptions or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource
	`osid.id.Id`	`dispatchId`	a dispatch `Id`
	`osid.type.Type`	`subscriptionGenusType`	a subscription genus type
	`osid.calendaring.DateTime`	`from`	from date
	`osid.calendaring.DateTime`	`to`	to date
Return	`osid.subscription.SubscriptionList`		the returned `SubscriptionList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`resourceId, dispatch, subscriptionGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptions
Description	Gets all subscriptions. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, subscriptions are returned that are currently effective. In any effective mode, effective subscriptions and those currently expired are returned.
Return	`osid.subscription.SubscriptionList`		a list of subscriptions
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.