org.osid.mapping

Interface Map

All Superinterfaces:

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

public interface Map
extends OsidCatalog

A Map represents a collection of locations and paths.

Method Summary

Methods

Modifier and Type	Method and Description
MapRecord	getMapRecord(Type mapRecordType) Gets the map record corresponding to the given Map 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

getMapRecord

MapRecord getMapRecord(Type mapRecordType)
                       throws OperationFailedException

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

Parameters:

mapRecordType - the type of map record to retrieve

Returns:

the map record

Throws:

NullArgumentException - mapRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(mapRecordType) is false

Compliance:

mandatory - This method must be implemented.