OSID - osid.mapping.route.RouteSegmentForm Service Interface Definition

Interface	osid.mapping.route.RouteSegmentForm
Implements	`osid.OsidObjectForm`
Description	A route segment represents a portion of a route.
Method	getStartingInstructionsMetadata
Description	Gets the metadata for the starting instructions.
Return	`osid.Metadata`		metadata for the starting instructions
Compliance	`mandatory`		This method must be implemented.
Method	setStartingInstructions
Description	Sets the starting instructions.
Parameters	`string`	`startingInstructions`	the new starting instructions
Errors	INVALID_ARGUMENT		`startingInstructions` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`startingInstructions` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearStartingInstructions
Description	Clears the starting instructions.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getEndingInstructionsMetadata
Description	Gets the metadata for the ending instructions.
Return	`osid.Metadata`		metadata for the ending instructions
Compliance	`mandatory`		This method must be implemented.
Method	setEndingInstructions
Description	Sets the ending instructions.
Parameters	`string`	`endingInstructions`	the new ending instructions
Errors	INVALID_ARGUMENT		`endingInstructions` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`endingInstructions` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEndingInstructions
Description	Clears the ending instructions.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDistanceMetadata
Description	Gets the metadata for the distance.
Return	`osid.Metadata`		metadata for the distance
Compliance	`mandatory`		This method must be implemented.
Method	setDistance
Description	Sets the distance for this segment.
Parameters	`osid.mapping.Distance`	`distance`	the new distance
Errors	INVALID_ARGUMENT		`distance` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`distance` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDistance
Description	Clears the distance.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getETAMetadata
Description	Gets the metadata for the estimated travel time.
Return	`osid.Metadata`		metadata for the eta
Compliance	`mandatory`		This method must be implemented.
Method	setETA
Description	Sets the estimated travel time for this segment.
Parameters	`osid.calendaring.Duration`	`eta`	the new eta
Errors	INVALID_ARGUMENT		`eta` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`eta` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearETA
Description	Clears the eta.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getPathMetadata
Description	Gets the metadata for the path.
Return	`osid.Metadata`		metadata for the path
Compliance	`mandatory`		This method must be implemented.
Method	setPath
Description	Sets the path for this segment.
Parameters	`osid.id.Id`	`pathId`	the new path
Errors	INVALID_ARGUMENT		`pathId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`pathId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPath
Description	Clears the path.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRouteSegmentFormRecord
Description	Gets the `RouteSegmentFormRecord` corresponding to the given route segment record `Type.`
Parameters	`osid.type.Type`	`routeSegmentRecordType`	a route segment record type
Return	`osid.mapping.route.records.RouteSegmentFormRecord`		the route segment form record
Errors	NULL_ARGUMENT		`routeSegmentRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(routeSegmentRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.