org.osid.hold

Interface Oubliette

All Superinterfaces:

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

public interface Oubliette
extends OsidCatalog

A Oubliette represents a collection of blocks.

Method Summary

Methods

Modifier and Type	Method and Description
OublietteRecord	getOublietteRecord(Type oublietteRecordType) Gets the oubliette record corresponding to the given Oubliette 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

getOublietteRecord

OublietteRecord getOublietteRecord(Type oublietteRecordType)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

oublietteRecordType - the type of oubliette record to retrieve

Returns:

the oubliette record

Throws:

NullArgumentException - oublietteRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(oublietteRecordType) is false

Compliance:

mandatory - This method must be implemented.