OSID Logo
OSID Specifications
mapping route package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.route.RouteForm
Implementsosid.OsidRelationshipForm
osid.OsidAggregateableForm
Description

This is the form for creating and updating Routes. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the RouteAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints. Some data may be automatically derived from the route segments.

MethodgetRouteFormRecord
Description

Gets the RouteFormRecord corresponding to the given route record Type.

Parametersosid.type.TyperouteRecordTypea route record type
Returnosid.mapping.route.records.RouteFormRecordthe route form record
ErrorsNULL_ARGUMENT routeRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(routeRecordType) is false
CompliancemandatoryThis method must be implemented.