org.osid.profile

Interface Profile

All Superinterfaces:

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

public interface Profile
extends OsidCatalog

A profile defines a collection of profile entries and items.

Method Summary

Methods

Modifier and Type	Method and Description
ProfileRecord	getProfileRecord(Type profileRecordType) Gets the profile record corresponding to the given Profile 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

getProfileRecord

ProfileRecord getProfileRecord(Type profileRecordType)
                               throws OperationFailedException

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

Parameters:

profileRecordType - a profile record type

Returns:

the profile record

Throws:

NullArgumentException - profileRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(profileRecordType) is false

Compliance:

mandatory - This method must be implemented.