OSID Logo
OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.MySubscriptionSession
Implementsosid.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.
MethodgetPublisherId
Description

Gets the Publisher Id associated with this session.

Returnosid.id.Idthe Publisher Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetPublisher
Description

Gets the Publisher associated with this session.

Returnosid.subscription.Publisherthe publisher
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupMySubscriptions
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.

Returnboolean false if subscription lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseEffectiveSubscriptionView
Description

Only subscriptions whose effective dates are current are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyEffectiveSubscriptionView
Description

All subscriptions of any effective dates are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetSubscriptionsForDispatch
Description

Gets a list of all subscriptions corresponding to a dispatch Id for the subscriber related to the current agent.

Parametersosid.id.IddispatchIdthe Id of the dispatch
Returnosid.subscription.SubscriptionListthe returned SubscriptionList
ErrorsNULL_ARGUMENT dispatchId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionsByDateForDispatch
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.

Parametersosid.id.IddispatchIda dispatch Id
osid.calendaring.DateTimefromfrom date
osid.calendaring.DateTimetoto date
Returnosid.subscription.SubscriptionListthe returned SubscriptionList
ErrorsINVALID_ARGUMENT to is less than from
NULL_ARGUMENT dispatchId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptions
Description

Gets all subscriptions for the subscriber related to the current agent.

Returnosid.subscription.SubscriptionLista list of subscriptions
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.