Package org.goplanit.service.routed

Interface RoutedService

All Superinterfaces:

Cloneable, Comparable<IdAble>, ExternalIdAble, IdAble, ManagedId

All Known Implementing Classes:

RoutedServiceImpl

public interface RoutedService
extends ManagedId, ExternalIdAble

Interface to reflect a routed service. A routed service reflects a route on a service network comprising of one or more legs. A leg comprises one or more physical links on an underlying physical network.

Author:

markr

Field Summary

Fields

Modifier and Type	Field	Description
static Class<RoutedService>	ROUTED_SERVICE_ID_CLASS	id class for generating ids

Method Summary

Modifier and Type	Method	Description
RoutedService	clone()	Create a shallow copy of this entity
default Class<RoutedService>	getIdClass()	Each managed id class is expected to generate its ids based on its class signature.
String	getName()	Name of the service, can be a number.
String	getNameDescription()	Description of the name of the service, usually a short elaboration in addition to the name (number), for example for a bus the name could be 370 and the nameDescription "Balmain to Coogee"
String	getServiceDescription()	Description of the service, longer (if at all) and contextual not meant for end user in reality
RoutedServiceTripInfo	getTripInfo()	Access to the trips available for this service
void	setName(String name)	Name of the service, can be a number.
void	setNameDescription(String nameDescription)	Description of the name of the service, usually a short elaboration in addition to the name (number), for example for a bus the name could be 370 and the nameDescription "Balmain to Coogee"
void	setServiceDescription(String serviceDescription)	Description of the service, longer (if at all) and contextual not meant for end user in reality

Methods inherited from interface org.goplanit.utils.id.ExternalIdAble

getExternalId, getXmlId, hasExternalId, hasXmlId, setExternalId, 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_SERVICE_ID_CLASS

static final Class<RoutedService> ROUTED_SERVICE_ID_CLASS

id class for generating ids

Method Detail

getIdClass

default Class<RoutedService> 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

clone

RoutedService clone()

Create a shallow copy of this entity

Specified by:

clone in interface IdAble

Returns:

shallow copy of entity

getName

String getName()

Name of the service, can be a number. Shortest visual (user) identifier for the service

Returns:

name

setName

void setName(String name)

Name of the service, can be a number. Shortest visual (user) identifier for the service

Parameters:

name - to use

getNameDescription

String getNameDescription()

Description of the name of the service, usually a short elaboration in addition to the name (number), for example for a bus the name could be 370 and the nameDescription "Balmain to Coogee"

Returns:

nameDescription

setNameDescription

void setNameDescription(String nameDescription)

Description of the name of the service, usually a short elaboration in addition to the name (number), for example for a bus the name could be 370 and the nameDescription "Balmain to Coogee"

Parameters:

nameDescription - to use

getServiceDescription

String getServiceDescription()

Description of the service, longer (if at all) and contextual not meant for end user in reality

Returns:

serviceDescription

setServiceDescription

void setServiceDescription(String serviceDescription)

Description of the service, longer (if at all) and contextual not meant for end user in reality

Parameters:

serviceDescription - to use

getTripInfo

RoutedServiceTripInfo getTripInfo()

Access to the trips available for this service

Returns:

known routed service trips