OSID Logo
OSID Specifications
mapping path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.Intersection
Implementsosid.OsidObject
osid.Aggregateable
Description

An intersection represents a crossing of paths where one can travel from one path to another.

MethodgetCoordinate
Description

Gets a single corrdinate to represent the intersection.

Returnosid.mapping.Coordinatethe coordinate
CompliancemandatoryThis method must be implemented.
MethodgetPathIds
Description

Gets the intersecting path Ids.

Returnosid.id.IdListthe path Ids
CompliancemandatoryThis method must be implemented.
MethodgetPaths
Description

Gets the intersecting paths.

Returnosid.mapping.path.PathListthe paths
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodisRotary
Description

Tests if this intersection is a rotary.

Returnboolean true if this intersection is a rotary, false otherwise
CompliancemandatoryThis method must be implemented.
MethodisFork
Description

Tests if this intersection is a fork or exit.

Returnboolean true if this intersection is a fork, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetIntersectionRecord
Description

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

Parametersosid.type.TypeintersectionRecordTypethe type of intersection record to retrieve
Returnosid.mapping.path.records.IntersectionRecordthe intersection record
ErrorsNULL_ARGUMENT intersectionRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(intersectionRecordType) is false
CompliancemandatoryThis method must be implemented.