OSID Logo
OSID Specifications
subscription rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.rules.SubscriptionEnablerLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving SubscriptionEnablers.

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 enabler methods in this session operate, retrieve and pertain to subscription enablers defined explicitly in the current publisher. Using an isolated view is useful for managing SubscriptionEnablers with the SubscriptionEnablerAdminSession.
  • federated publisher view: All subscription enabler methods in this session operate, retrieve and pertain to all subscription enablers defined in this publisher and any other subscription enablers implicitly available in this publisher through publisher inheritence.
  • active subscription enabler view: All subscription enabler lookup methods return active subscription enablers.
  • any status subscription enabler view: Subscription enablers of any active or inactive status 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.
MethodcanLookupSubscriptionEnablers
Description

Tests if this user can perform SubscriptionEnablers 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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeSubscriptionEnablerView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenarySubscriptionEnablerView
Description

A complete view of the SubscriptionEnabler 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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedPublisherView
Description

Federates the view for methods in this session. A federated view will include subscription enablers in publishers which are children of this publisher in the publisher hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedPublisherView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this publisher only.

CompliancemandatoryThis method is must be implemented.
MethoduseActiveSubscriptionEnablerView
Description

Only active subscription enablers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusSubscriptionEnablerView
Description

All active and inactive subscription enablers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetSubscriptionEnabler
Description

Gets the SubscriptionEnabler specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned SubscriptionEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a SubscriptionEnabler and retained for compatibility.

In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.

Parametersosid.id.IdsubscriptionEnablerId Id of the SubscriptionEnabler
Returnosid.subscription.rules.SubscriptionEnablerthe subscription enabler
ErrorsNOT_FOUND subscriptionEnablerId not found
NULL_ARGUMENT subscriptionEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetSubscriptionEnablersByIds
Description

Gets a SubscriptionEnablerList corresponding to the given IdList.

In plenary mode, the returned list contains all of the subscription enablers 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 SubscriptionEnablers may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.

Parametersosid.id.IdListsubscriptionEnablerIdsthe list of Ids to retrieve
Returnosid.subscription.rules.SubscriptionEnablerListthe returned SubscriptionEnabler list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT subscriptionEnablerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionEnablersByGenusType
Description

Gets a SubscriptionEnablerList corresponding to the given subscription enabler genus Type which does not include subscription enablers of genus types derived from the specified Type.

In plenary mode, the returned list contains all known subscription enablers or an error results. Otherwise, the returned list may contain only those subscription enablers that are accessible through this session.

In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.

Parametersosid.type.TypesubscriptionEnablerGenusTypea subscription enabler genus type
Returnosid.subscription.rules.SubscriptionEnablerListthe returned SubscriptionEnabler list
ErrorsNULL_ARGUMENT subscriptionEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionEnablersByParentGenusType
Description

Gets a SubscriptionEnablerList corresponding to the given subscription enabler genus Type and include any additional subscription enablers with genus types derived from the specified Type.

In plenary mode, the returned list contains all known subscription enablers or an error results. Otherwise, the returned list may contain only those subscription enablers that are accessible through this session.

In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.

Parametersosid.type.TypesubscriptionEnablerGenusTypea subscription enabler genus type
Returnosid.subscription.rules.SubscriptionEnablerListthe returned SubscriptionEnabler list
ErrorsNULL_ARGUMENT subscriptionEnablerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionEnablersByRecordType
Description

Gets a SubscriptionEnablerList containing the given subscription enabler record Type.

In plenary mode, the returned list contains all known subscription enablers or an error results. Otherwise, the returned list may contain only those subscription enablers that are accessible through this session.

In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.

Parametersosid.type.TypesubscriptionEnablerRecordTypea subscription enabler record type
Returnosid.subscription.rules.SubscriptionEnablerListthe returned SubscriptionEnabler list
ErrorsNULL_ARGUMENT subscriptionEnablerRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionEnablersOnDate
Description

Gets a SubscriptionEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent.

In plenary mode, the returned list contains all known subscription enablers or an error results. Otherwise, the returned list may contain only those subscription enablers that are accessible through this session.

In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.

Parametersosid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.subscription.rules.SubscriptionEnablerListthe returned SubscriptionEnabler list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionEnablersOnDateWithAgent
Description

Gets a SubscriptionEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent.

In plenary mode, the returned list contains all known subscription enablers or an error results. Otherwise, the returned list may contain only those subscription enablers that are accessible through this session.

In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.

Parametersosid.id.IdagentIdan agent Id
osid.calendaring.DateTimefroma start date
osid.calendaring.DateTimetoan end date
Returnosid.subscription.rules.SubscriptionEnablerListthe returned SubscriptionEnabler list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT agentId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionEnablers
Description

Gets all SubscriptionEnablers.

In plenary mode, the returned list contains all known subscription enablers or an error results. Otherwise, the returned list may contain only those subscription enablers that are accessible through this session.

In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.

Returnosid.subscription.rules.SubscriptionEnablerListthe returned SubscriptionEnabler list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.