OSID - osid.subscription.MySubscriptionSession Service Interface Definition

Interface	osid.subscription.MySubscriptionSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving subscriptions. This lookup session defines several views: 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.
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	canLookupMySubscriptions
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	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	getSubscriptionsForDispatch
Description	Gets a list of all subscriptions corresponding to a dispatch `Id` for the subscriber related to the current agent.
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	getSubscriptionsByDateForDispatch
Description	Gets a list of all subscriptions corresponding to a dispatch `Id` and date rang for the subscriber related to the current agent.e. Entries are returned with effective dates that fall between the requested dates inclusive.
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	getSubscriptions
Description	Gets all subscriptions for the subscriber related to the current agent.
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.