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.
Modifier and Type | Method and Description |
---|---|
PathRecord |
getPathRecord(Type pathRecordType)
Gets the path record corresponding to the given
Path
record Type. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
PathRecord getPathRecord(Type pathRecordType) throws OperationFailedException
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
.pathRecordType
- the type of path record to retrieveNullArgumentException
- pathRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(pathRecordType)
is false
mandatory
- This method must be implemented.