Oubliette

All Superinterfaces:: Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface Oubliette extends OsidCatalog

An Oubliette represents a collection of blocks.

Like all OsidObjects, Oubliette is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Method Summary

Modifier and Type

Method

Description

OublietteRecord

getOublietteRecord(Type oublietteRecordType)

Gets the oubliette record corresponding to the given Oubliette record Type.

Methods inherited from interface Browsable
getProperties, getPropertiesByRecordType

Methods inherited from interface Extensible
getRecordTypes, hasRecordType

Methods inherited from interface Identifiable
getId, isCurrent

Methods inherited from interface OsidObject
getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Details
- getOublietteRecord
  
  OublietteRecord getOublietteRecord(Type oublietteRecordType) throws OperationFailedException
  
  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
  
  UnsupportedException - hasRecordType(oublietteRecordType) is false
  
  Compliance:
  mandatory - This method must be implemented.