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

This session provides methods to apply SubscriptionEnablers to Subscriptions. A Subscription with multiple SubscriptionEnablers means any positive rule evaluation across the enablers result in an effective Subscription.

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.
MethodcanAssignSubscriptionEnablers
Description

Tests if this user can alter subscription enabler/subscription mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodassignSubscriptionEnablerToSubscription
Description

Adds an existing SubscriptionEnabler to a Subscription.

Parametersosid.id.IdsubscriptionEnablerIdthe Id of the SubscriptionEnabler
osid.id.IdsubscriptionIdthe Id of the Subscription
ErrorsALREADY_EXISTS subscriptionEnablerId is already applied to subscriptionId
NOT_FOUND subscriptionEnablerId or subscriptionId not found
NULL_ARGUMENT subscriptionEnablerId or subscriptionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignSubscriptionEnablerFromSubscription
Description

Removes a SubscriptionEnabler from a Subscription.

Parametersosid.id.IdsubscriptionEnablerIdthe Id of the SubscriptionEnabler
osid.id.IdsubscriptionIdthe Id of the Subscription
ErrorsNOT_FOUND subscriptionEnablerId or subscriptionId not found or subscriptionEnablerId not applied to subscriptionId
NULL_ARGUMENT subscriptionEnablerId or subscriptionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceSubscriptionEnablers
Description

Tests if this user can order SubscriptionEnablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returnboolean false if SubscriptionEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveSubscriptionEnablerAhead
Description

Reorders subscription enablers for a subscription by moving the specified subscription enabler in front of a reference subscription enabler.

Parametersosid.id.IdsubscriptionEnablerIdthe Id of a SubscriptionEnabler
osid.id.IdsubscriptionIdthe Id of a Subscription
osid.id.IdreferenceIdthe reference subscription enabler Id
ErrorsNOT_FOUND subscriptionEnablerId, subscriptionId, or referenceId not found or, subscriptionEnabelrId or referenceId not related to subscriptionId
NULL_ARGUMENT subscriptionEnablerId, subscriptionId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveSubscriptionEnablerBehind
Description

Reorders subscription enablers for a subscription by moving the specified subscription enabler behind a reference subscription enabler.

Parametersosid.id.IdsubscriptionEnablerIdthe Id of a SubscriptionEnabler
osid.id.IdsubscriptionIdthe Id of a Subscription
osid.id.IdreferenceIdthe reference subscription enabler Id
ErrorsNOT_FOUND subscriptionEnablerId, subscriptionId, or referenceId not found or, subscriptionEnabelrId or referenceId not related to subscriptionId
NULL_ARGUMENT subscriptionEnablerId, subscriptionId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderSubscriptionEnablers
Description

Reorders a set of subscription enablers for a subscription.

Parametersosid.id.Id[]subscriptionEnablerIdsthe Ids for a set of SubscriptionEnablers
osid.id.IdsubscriptionIdthe Id of a Subscription
ErrorsNOT_FOUND subscriptionId not found or, an subscriptionEnabelrId not related to subscriptionId
NULL_ARGUMENT subscriptionEnablerIds or subscriptionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.