org.osid.subscription.rules

Interface SubscriptionEnabler

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidEnabler, OsidObject, OsidRule, Temporal

public interface SubscriptionEnabler
extends OsidEnabler

A SubscriptionEnabler describes the rules for making Subscriptions effective.

Method Summary

Methods

Modifier and Type	Method and Description
SubscriptionEnablerRecord	getSubscriptionEnablerRecord(Type subscriptionEnablerRecordType) Gets the subscription enabler record corresponding to the given SubscriptionEnabler record Type.

Methods inherited from interface org.osid.OsidEnabler

getCyclicEvent, getCyclicEventId, getDemographic, getDemographicId, getEvent, getEventId, getSchedule, getScheduleId, isEffectiveByCyclicEvent, isEffectiveByEvent, isEffectiveBySchedule, isEffectiveForDemographic

Methods inherited from interface org.osid.OsidRule

getRule, getRuleId, hasRule

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Operable

isActive, isDisabled, isEnabled, isOperational

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getSubscriptionEnablerRecord

SubscriptionEnablerRecord getSubscriptionEnablerRecord(Type subscriptionEnablerRecordType)
                                                       throws OperationFailedException

Gets the subscription enabler record corresponding to the given SubscriptionEnabler record Type. This method is used to retrieve an object implementing the requested record. The subscriptionEnablerRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(subscriptionEnablerRecordType) is true .

Parameters:

subscriptionEnablerRecordType - the type of subscription enabler record to retrieve

Returns:

the subscription enabler record

Throws:

NullArgumentException - subscriptionEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(subscriptionEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.