org.osid.resource

Interface Bin

All Superinterfaces:

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

public interface Bin
extends OsidCatalog

An inventory defines a collection of resources.

Method Summary

Methods

Modifier and Type	Method and Description
BinRecord	getBinRecord(Type binRecordType) Gets the bin record corresponding to the given Bin 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

getBinRecord

BinRecord getBinRecord(Type binRecordType)
                       throws OperationFailedException

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

Parameters:

binRecordType - the bin record type

Returns:

the bin record

Throws:

NullArgumentException - binRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(binRecordType) is false

Compliance:

mandatory - This method must be implemented.