org.osid.authorization

Interface Qualifier

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidObject

public interface Qualifier
extends OsidObject, Federateable

A Qualifier represents an authenticatable identity. Like all OSID objects, a Qualifier is identified by its Id and any persisted references should use the Id.

Method Summary

Methods

Modifier and Type	Method and Description
QualifierRecord	getQualifierRecord(Type qualifierRecordType) Gets the qualifier record corresponding to the given Qualifier 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

Method Detail

getQualifierRecord

QualifierRecord getQualifierRecord(Type qualifierRecordType)
                                   throws OperationFailedException

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

Parameters:

qualifierRecordType - the type of the record to retrieve

Returns:

the qualifier record

Throws:

NullArgumentException - qualifierRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(qualifierRecordType) is false

Compliance:

mandatory - This method must be implemented.