org.osid.authentication

Interface Agency

All Superinterfaces:

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

public interface Agency
extends OsidCatalog

An agency defines a collection of agents.

Method Summary

Methods

Modifier and Type	Method and Description
AgencyRecord	getAgencyRecord(Type agencyRecordType) Gets the agency record corresponding to the given Agency 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

getAgencyRecord

AgencyRecord getAgencyRecord(Type agencyRecordType)
                             throws OperationFailedException

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

Parameters:

agencyRecordType - an agency record type

Returns:

the agency record

Throws:

NullArgumentException - agencyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(agencyRecordType) is false

Compliance:

mandatory - This method must be implemented.