Interface Intersection

All Superinterfaces:

Aggregateable, Browsable, Extensible, Identifiable, OsidObject

public interface Intersection
extends OsidObject, Aggregateable

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

Method Summary

Modifier and Type	Method	Description
Coordinate	getCoordinate()	Gets a single corrdinate to represent the intersection.
IntersectionRecord	getIntersectionRecord(Type intersectionRecordType)	Gets the intersection record corresponding to the given Intersection record Type .
IdList	getPathIds()	Gets the intersecting path Ids .
PathList	getPaths()	Gets the intersecting paths.
boolean	isFork()	Tests if this intersection is a fork or exit.
boolean	isRotary()	Tests if this intersection is a rotary.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Modifier and Type	Method	Description
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type .

Method Details

getCoordinate

Coordinate getCoordinate()

Gets a single corrdinate to represent the intersection.

Returns:

the coordinate

Compliance:

mandatory - This method must be implemented.

getPathIds

IdList getPathIds()

Gets the intersecting path Ids .

Returns:

the path Ids

Compliance:

mandatory - This method must be implemented.

getPaths

PathList getPaths()
           throws OperationFailedException

Gets the intersecting paths.

Returns:

the paths

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

isRotary

boolean isRotary()

Tests if this intersection is a rotary.

Returns:

true if this intersection is a rotary, false otherwise

Compliance:

mandatory - This method must be implemented.

isFork

boolean isFork()

Tests if this intersection is a fork or exit.

Returns:

true if this intersection is a fork, false otherwise

Compliance:

mandatory - This method must be implemented.

getIntersectionRecord

IntersectionRecord getIntersectionRecord(Type intersectionRecordType)
                                  throws OperationFailedException

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 .

Parameters:

intersectionRecordType - the type of intersection record to retrieve

Returns:

the intersection record

Throws:

NullArgumentException - intersectionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(intersectionRecordType) is false

Compliance:

mandatory - This method must be implemented.