OSID Logo
OSID Specifications
subscription package
Version 3.1.0
Interfaceosid.subscription.Dispatch
Implementsosid.OsidGovernator
Used Byosid.subscription.DispatchAdminSession
osid.subscription.DispatchList
osid.subscription.DispatchLookupSession
osid.subscription.Subscription
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.

MethodgetEditorIds
Description

Gets the Ids of the editors.

Returnosid.id.IdList the editor Ids
Compliancemandatory This method must be implemented.
MethodgetEditors
Description

Gets the editors.

Returnosid.resource.ResourceList the editors
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAddressGenusTypes
Description

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

Returnosid.type.TypeList a list of address genus types
Compliancemandatory This 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.TypedispatchRecordType the type of dispatch record to retrieve
Returnosid.subscription.records.DispatchRecord the dispatch record
ErrorsNULL_ARGUMENT dispatchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(dispatchRecordType) is false
Compliancemandatory This method must be implemented.