Interface RouteSegmentForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable
public interface RouteSegmentForm extends OsidObjectForm

This is the form for creating and updating RouteSegments . Like all OsidForms , various data elements may be set here for use in the create and update methods in the RouteSegmentAdminSession . 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.

  • Method Details

    • getStartingInstructionsMetadata

      Metadata getStartingInstructionsMetadata()
      Gets the metadata for the starting instructions.
      Returns:
      metadata for the starting instructions
      Compliance:
      mandatory - This method must be implemented.

    • setStartingInstructions

      void setStartingInstructions(String startingInstructions)
      Sets the starting instructions.
      Parameters:
      startingInstructions - the new starting instructions
      Throws:
      InvalidArgumentException - startingInstructions is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - startingInstructions is null
      Compliance:
      mandatory - This method must be implemented.

    • clearStartingInstructions

      void clearStartingInstructions()
      Clears the starting instructions.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getEndingInstructionsMetadata

      Metadata getEndingInstructionsMetadata()
      Gets the metadata for the ending instructions.
      Returns:
      metadata for the ending instructions
      Compliance:
      mandatory - This method must be implemented.

    • setEndingInstructions

      void setEndingInstructions(String endingInstructions)
      Sets the ending instructions.
      Parameters:
      endingInstructions - the new ending instructions
      Throws:
      InvalidArgumentException - endingInstructions is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - endingInstructions is null
      Compliance:
      mandatory - This method must be implemented.

    • clearEndingInstructions

      void clearEndingInstructions()
      Clears the ending instructions.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getDistanceMetadata

      Metadata getDistanceMetadata()
      Gets the metadata for the distance.
      Returns:
      metadata for the distance
      Compliance:
      mandatory - This method must be implemented.

    • setDistance

      void setDistance(Distance distance)
      Sets the distance for this segment.
      Parameters:
      distance - the new distance
      Throws:
      InvalidArgumentException - distance is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - distance is null
      Compliance:
      mandatory - This method must be implemented.

    • clearDistance

      void clearDistance()
      Clears the distance.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getETAMetadata

      Metadata getETAMetadata()
      Gets the metadata for the estimated travel time.
      Returns:
      metadata for the eta
      Compliance:
      mandatory - This method must be implemented.

    • setETA

      void setETA(Duration eta)
      Sets the estimated travel time for this segment.
      Parameters:
      eta - the new eta
      Throws:
      InvalidArgumentException - eta is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - eta is null
      Compliance:
      mandatory - This method must be implemented.

    • clearETA

      void clearETA()
      Clears the eta.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getPathMetadata

      Metadata getPathMetadata()
      Gets the metadata for the path.
      Returns:
      metadata for the path
      Compliance:
      mandatory - This method must be implemented.

    • setPath

      void setPath(Id pathId)
      Sets the path for this segment.
      Parameters:
      pathId - the new path
      Throws:
      InvalidArgumentException - pathId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - pathId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearPath

      void clearPath()
      Clears the path.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getRouteSegmentFormRecord

      RouteSegmentFormRecord getRouteSegmentFormRecord(Type routeSegmentRecordType) throws OperationFailedException
      Gets the RouteSegmentFormRecord corresponding to the given route segment record Type .
      Parameters:
      routeSegmentRecordType - a route segment record type
      Returns:
      the route segment form record
      Throws:
      NullArgumentException - routeSegmentRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(routeSegmentRecordType) is false
      Compliance:
      mandatory - This method must be implemented.