org.osid.subscription

Interface Publisher

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface Publisher
extends OsidCatalog

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

Method Summary

Methods

Modifier and Type	Method and Description
PublisherRecord	getPublisherRecord(Type publisherRecordType) Gets the publisher record corresponding to the given Publisher record Type.

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.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getPublisherRecord

PublisherRecord getPublisherRecord(Type publisherRecordType)
                                   throws OperationFailedException

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

Parameters:

publisherRecordType - the type of publisher record to retrieve

Returns:

the publisher record

Throws:

NullArgumentException - publisherRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(publisherRecordType) is false

Compliance:

mandatory - This method must be implemented.