RoutedTrip (PLANitAllJavaOnly 0.4.0 API)

All Superinterfaces:

Comparable<IdAble>, ExternalIdAble, IdAble, ManagedId

All Known Subinterfaces:

RoutedTripFrequency, RoutedTripSchedule

All Known Implementing Classes:

RoutedTripFrequencyImpl, RoutedTripImpl, RoutedTripScheduleImpl
```
public interface RoutedTrip
extends ExternalIdAble, ManagedId
```
Base interface for routed trips. Derived interfaces and classes are to be used to define what type of routed trip, e.g., a routed trip with a schedule or frequency. However, despite different types of routed trips they all fall under the same base class and share a unique id across, hence the existence of this interface with its id class.

Author:

markr

Field Summary

Fields
Modifier and Type Field Description

static Class<RoutedTrip> ROUTED_TRIP_ID_CLASS
id class for generating ids

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`RoutedTrip`	`deepClone()`	An id entity should always support a deep copy, i.e., all "owned" members will be deep copied when a clone of this instance is created via this call.
`default Class<? extends RoutedTrip>`	`getIdClass()`	Each managed id class is expected to generate its ids based on its class signature.
`Set<ServiceNode>`	`getUsedServiceNodes()`	Get all used service nodes along the trip
`RoutedTrip`	`shallowClone()`	Create a shallow copy of this entity

Methods inherited from interface org.goplanit.utils.id.ExternalIdAble
appendExternalId, appendExternalId, getExternalId, getIdsAsString, getSplitExternalId, getSplitExternalId, getXmlId, hasExternalId, hasXmlId, setExternalId, setXmlId, setXmlId

Methods inherited from interface org.goplanit.utils.id.IdAble
compareTo, getId, idEquals, idHashCode

Methods inherited from interface org.goplanit.utils.id.ManagedId
recreateManagedIds, resetChildManagedIdEntities

- Field Detail
  - ROUTED_TRIP_ID_CLASS
```
static final Class<RoutedTrip> ROUTED_TRIP_ID_CLASS
```
    id class for generating ids
- Method Detail
  - getIdClass
```
default Class<? extends RoutedTrip> getIdClass()
```
    Each managed id class is expected to generate its ids based on its class signature. To be able to generate the correct id the class used for id generation is to be provided via this method call.
    
    Specified by:
    
    getIdClass in interface ManagedId
    
    Returns:
    
    idClass to use for generating ids for instances of this idable derived class
  - getUsedServiceNodes
```
Set<ServiceNode> getUsedServiceNodes()
```
    Get all used service nodes along the trip
    
    Returns:
    
    used service nodes
  - shallowClone
```
RoutedTrip shallowClone()
```
    Create a shallow copy of this entity
    
    Specified by:
    
    shallowClone in interface IdAble
    
    Returns:
    
    shallow copy of entity
  - deepClone
```
RoutedTrip deepClone()
```
    An id entity should always support a deep copy, i.e., all "owned" members will be deep copied when a clone of this instance is created via this call. To be used with caution if not called by managed id container related code
    
    Specified by:
    
    deepClone in interface IdAble
    
    Returns:
    
    deep copy of entity