org.osid.profile

Interface ProfileItem

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface ProfileItem
extends OsidObject

A ProfileItem represents an item in a profile. Like all OSID objects, a ProfileItem is identified by its Id and any persisted references should use the Id.

Method Summary

Methods

Modifier and Type	Method and Description
ProfileItemRecord	getProfileItemRecord(Type profileItemRecordType) Gets the profile item record corresponding to the given ProfileItem 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

getProfileItemRecord

ProfileItemRecord getProfileItemRecord(Type profileItemRecordType)
                                       throws OperationFailedException

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

Parameters:

profileItemRecordType - the type of the record to retrieve

Returns:

the profile item record

Throws:

NullArgumentException - profileItemRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(profileItemRecordType) is false

Compliance:

mandatory - This method must be implemented.