org.osid.mapping.path

Interface Path

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface Path
extends OsidObject

A Path represents a navigable path or road. The Path is the interface to relate a navigable route to a physical path.

Method Summary

Methods

Modifier and Type	Method and Description
PathRecord	getPathRecord(Type pathRecordType) Gets the path record corresponding to the given Path 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

getPathRecord

PathRecord getPathRecord(Type pathRecordType)
                         throws OperationFailedException

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

Parameters:

pathRecordType - the type of path record to retrieve

Returns:

the path record

Throws:

NullArgumentException - pathRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(pathRecordType) is false

Compliance:

mandatory - This method must be implemented.