org.osid.personnel

Interface Realm

All Superinterfaces:

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

public interface Realm
extends OsidCatalog

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

Method Summary

Methods

Modifier and Type	Method and Description
RealmRecord	getRealmRecord(Type realmRecordType) Gets the record corresponding to the given Realm 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

getRealmRecord

RealmRecord getRealmRecord(Type realmRecordType)
                           throws OperationFailedException

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

Parameters:

realmRecordType - the type of realm record to retrieve

Returns:

the realm record

Throws:

NullArgumentException - realmRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(realmRecordType) is false

Compliance:

mandatory - This method must be implemented.