org.osid.provisioning

Interface Distributor

All Superinterfaces:

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

public interface Distributor
extends OsidCatalog

A Distributor represents a collection of reservoirs.

Method Summary

Methods

Modifier and Type	Method and Description
DistributorRecord	getDistributorRecord(Type distributorRecordType) Gets the distributor record corresponding to the given Distributor 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

getDistributorRecord

DistributorRecord getDistributorRecord(Type distributorRecordType)
                                       throws OperationFailedException

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

Parameters:

distributorRecordType - the type of distributor record to retrieve

Returns:

the distributor record

Throws:

NullArgumentException - distributorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(distributorRecordType) is false

Compliance:

mandatory - This method must be implemented.