OSID Logo
OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.Subscription
Implementsosid.OsidRelationship
Description

A Subscription relates a subscriber to a Dispatch and also contains the subscriber's Address to use as the means of contact in this context.

MethodgetDispatchId
Description

Gets the Id of the dispatch.

Returnosid.id.Idthe dispatch Id
CompliancemandatoryThis method must be implemented.
MethodgetDispatch
Description

Gets the dispatch.

Returnosid.subscription.Dispatchthe dispatch Id
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetSubscriberId
Description

Gets the Id of the subscriber.

Returnosid.id.Idthe subscriber Id
CompliancemandatoryThis method must be implemented.
MethodgetSubscriber
Description

Gets the subscriber.

Returnosid.resource.Resourcethe subscriber
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAddressId
Description

Gets the Id of the subscriber's address.

Returnosid.id.Idthe address Id
CompliancemandatoryThis method must be implemented.
MethodgetAddress
Description

Gets the subscriber's address.

Returnosid.contact.Addressthe subscriber's address.
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionRecord
Description

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

Parametersosid.type.TypesubscriptionRecordTypethe type of subscription record to retrieve
Returnosid.subscription.records.SubscriptionRecordthe subscription record
ErrorsNULL_ARGUMENT subscriptionRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(subscriptionRecordType) is false
CompliancemandatoryThis method must be implemented.