OSID Logo
OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.Dispatch
Implementsosid.OsidGovernator
Description

A Dispatch represents a collection of subscriptions. Like all OSID objects, a Dispatch is identified by its Id and any persisted references should use the Id.

MethodgetAddressGenusTypes
Description

Gets the list of address genus types accepted by this dispatch.

Returnosid.type.TypeLista list of address genus types
CompliancemandatoryThis method must be implemented.
MethodgetDispatchRecord
Description

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

Parametersosid.type.TypedispatchRecordTypethe type of dispatch record to retrieve
Returnosid.subscription.records.DispatchRecordthe dispatch record
ErrorsNULL_ARGUMENT dispatchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(dispatchRecordType) is false
CompliancemandatoryThis method must be implemented.