WorkingHours (JOpt Java Core 7.5.0-rc1 API)

java.lang.Object
- com.dna.jopt.member.unit.hours.AbstractDutyHours
- - com.dna.jopt.member.unit.hours.WorkingHours

All Implemented Interfaces:

IDutyHours, IWorkingHours, Serializable, Comparable<IDutyHours>
```
public class WorkingHours
extends AbstractDutyHours
implements IWorkingHours
```
This class describes the hours a IResource is allowed to work. If a Resource is working outside of its WorkingHours a Violation will be thrown.

Since:

03/09/2019

Version:

19/09/2019

Author:

DNA

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface com.dna.jopt.member.unit.hours.IDutyHours
  IDutyHours.DutyHoursFlavour

Constructor Summary

Constructors
Constructor and Description
`WorkingHours(GregorianCalendar hoursBegin, GregorianCalendar hoursEnd)` Deprecated. please use `WorkingHours(ZonedDateTime, ZonedDateTime)` instead
`WorkingHours(Instant hoursBegin, Instant hoursEnd)` Deprecated. please use `WorkingHours(ZonedDateTime, ZonedDateTime)` instead
`WorkingHours(Instant hoursBegin, Instant hoursEnd, Duration maxWorkingTime, javax.measure.Quantity<javax.measure.quantity.Length> maxDistance)` Deprecated. please use `WorkingHours(ZonedDateTime, ZonedDateTime)` instead. The
`WorkingHours(Instant hoursBegin, Instant hoursEnd, Optional<Duration> maxWorkingTime, Optional<javax.measure.Quantity<javax.measure.quantity.Length>> maxDistance)` Deprecated. please use `WorkingHours(ZonedDateTime, ZonedDateTime)` instead. The
`WorkingHours(Instant hoursBegin, Instant hoursEnd, ZoneId zoneId)` The constructor for `WorkingHours` using `Instants`.
`WorkingHours(Instant hoursBegin, Instant hoursEnd, ZoneId zoneId, Optional<Duration> maxWorkingTime, Optional<javax.measure.Quantity<javax.measure.quantity.Length>> maxDistance)`
`WorkingHours(LocalDateTime hoursBegin, LocalDateTime hoursEnd)` Deprecated. please use `WorkingHours(ZonedDateTime, ZonedDateTime)` instead
`WorkingHours(long hoursBeginMillis, long hoursEndMillis)` Deprecated. please use `WorkingHours(ZonedDateTime, ZonedDateTime)` instead
`WorkingHours(long hoursBeginMillis, long hoursEndMillis, ZoneId zoneId)` The constructor for `WorkingHours` using milliseconds since 01.01.1970.
`WorkingHours(com.google.common.collect.Range<Instant> interval)` Deprecated. please use `WorkingHours(ZonedDateTime, ZonedDateTime)` instead
`WorkingHours(com.google.common.collect.Range<Instant> interval, Duration maxWorkingTime, javax.measure.Quantity<javax.measure.quantity.Length> maxDistance)` Deprecated. please use `WorkingHours(ZonedDateTime, ZonedDateTime)` instead. The
`WorkingHours(TimeWindow window)`
`WorkingHours(ZonedDateTime hoursBegin, Duration maxTime)`
`WorkingHours(ZonedDateTime hoursBegin, ZonedDateTime hoursEnd)` The constructor for `WorkingHours` using `AbstractDutyHours(ZonedDateTime, ZonedDateTime)`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`addConnectionHook(ReducedNodeEdgeConnectorItem item)`
`void`	`addConstraint(IMultiWorkingHoursLevelConstraint constraint)`
`void`	`addConstraint(IWorkingHoursLevelConstraint constraint)` Adds a `Constraint` to the `WorkingHours` so only `Resources` with that specific `Qualification` will be able to serve the `Nodes` to which those `WorkingHours` are applied.
`void`	`addNodeColorCapacity(NodeColorCapacityItem item)` Adds a certain `INodeColor` to the `Resource`.
`void`	`addQualification(IQualification qualification)` Adds a `IQualification` to the `IWorkingHours`, which means that by adding a `IConstraint` to the `INode`, they are limited to which `Nodes` they can give service.
`IWorkingHours`	`copy()` Returns a copy of `WorkingHours(this.getBegin(), this.getEnd(), this.getZoneId())` and invokes `takeOverProperties(com.dna.jopt.member.unit.hours.IWorkingHours, com.dna.jopt.member.unit.hours.IWorkingHours)` to also copy the properties.
`Optional<NodeColorCapacityItem>`	`getColorCapacityItemByColorCode(int colorCode)` Gets the `NodeColorCapacityItem` which limit the amount of `Color` coded `Nodes` a `Resource` can give service to.
`Optional<ReducedNodeEdgeConnectorItem>`	`getConnectionHook(String toId)`
`Optional<Map<String,ReducedNodeEdgeConnectorItem>>`	`getConnectionHooks()`
`List<IWorkingHoursLevelConstraint>`	`getConstraints()` Gets the `Constraints` set on the `IResource`.
`IDutyHours.DutyHoursFlavour`	`getFlavour()` Gets the `IDutyHours.DutyHoursFlavour.WOH_FLAVOUR`, the default value is `enum constant ordinal: 0`.
`boolean`	`getIsAvailableForStay()` Gets if the `Resource` is allowed to do an `overnight stay`.
`Optional<Long>`	`getLocalFlexTimeMillis()` Gets the `localFlexTime` in milliseconds.
`Optional<Long>`	`getLocalMaxFreePostWorkDrivingTerminationTimeMillis()` Gets the `freePostWorkDrivingTerminationTime` in milliseconds.
`Optional<Long>`	`getLocalMaxPillarAfterHoursTime()` Gets the `localMaxPillarAfterHoursTime` of `IPillarNode` in milliseconds.
`Optional<Long>`	`getLocalMaxRouteStartReductionTimeMillis()` Gets the `localMaxRouteStartReductionTime` in milliseconds.
`Optional<Long>`	`getLocalMaxRouteStartReductionTimeMillisPillar()` Gets the `localMaxRouteStartReductionTime` for `IPillarNode` in milliseconds.
`Optional<Duration>`	`getLocalStayOutCycle()` Gets the `Duration` of the potential local `stayout cycle`.
`Optional<LocalDate>`	`getLocalStayOutCycleStart()` Gets the start of the local `stayout cycle`.
`double`	`getMaxDistanceKm()` Gets the `maxDistance`, which is the maximal distance in km a `Resource` is allowed to travel without a `IViolation` per day.
`double`	`getMaxHours()` Gets maximum number of hours a `Resource` is allowed to work per day in `hours`.
`List<IMultiWorkingHoursLevelConstraint>`	`getMultiConstraints()`
`Map<Integer,NodeColorCapacityItem>`	`getNodeColorCapacityMap()` Gets the a `Map` of the `NodeColorCapacity`.
`Set<Integer>`	`getPresentColorCodes()` Gets the `INodeColor` that are in use.
`Map<Class<? extends IQualification>,IQualification>`	`getQualifications()` Gets the `IQualification` of the `IWorkingHours`.
`Optional<IResourceDepot>`	`getResourceDepot()`
`Optional<Long>`	`getRouteStartShiftMillisHook()`
`boolean`	`hasHook()`
`boolean`	`isClosedRoute()` Checks if the route is closed or not, the default value is `false`.
`Optional<Boolean>`	`isLocalOnlyApplyFreePostWorkDrivingOnOvertime()`
`Optional<Boolean>`	`isLocalReductionTimeIncludedInWorkingTime()` Checks whether the `localMaxRouteStartReductionTime` is included in the `WorkingHours`.
`Optional<Boolean>`	`isLocalReductionTimeOnlyUsedForDriving()` Checks whether the potentially set `localMaxRouteStartReductionTime` can only be used for driving, not for working.
`Optional<Boolean>`	`isLocalReductionTimeOnlyUsedForDrivingPillar()` Checks whether the potentially set `localMaxRouteStartReductionTime` for `IPillarNode` can only be used for driving, not for working.
`boolean`	`isNodeColorCodingInUse()` Checks if any `INodeColor` has been set through the use of a `NodeColorCapacityItem`.
`boolean`	`setConnectionHooks(Map<String,ReducedNodeEdgeConnectorItem> map)`
`void`	`setIsAvailableForStay(boolean isAvailableForStay)` Sets if the `Resource` is allowed for an `overnight stay` instead of returning to the starting location.
`void`	`setIsClosedRoute(boolean isClosedRoute)` Sets the `Route` to a `closed Route`.
`boolean`	`setLocalFlexTime(Duration idleTimeReductionTime)` Sets the amount of time a `Resource` can be expected to start working later and stay longer at work if needed.
`boolean`	`setLocalMaxFreePostWorkDrivingTerminationTime(Duration postTimeReductionTime)` Sets the amount of time the `Resource` can be expected to drive home to its starting location in its free time.
`boolean`	`setLocalMaxFreePostWorkDrivingTerminationTime(Duration postTimeReductionTime, boolean onlyApplyOnOvertime)` Sets the local max free post work driving termination time.
`boolean`	`setLocalMaxPillarAfterHoursTime(Duration maxPillarEndOverTime)` Sets the amount of time after `WorkingHours` within which a `IPillarNode` can be set.
`boolean`	`setLocalMaxRouteStartReductionTime(Duration maxRouteStartReductionTime, boolean isOnlyUsedForDriving)` Sets the maximum time which the `Resource` can be expected to drive to the first `Node` in its private time.
`boolean`	`setLocalMaxRouteStartReductionTimePillar(Duration maxRouteStartReductionTime, boolean isOnlyUsedForDriving)` Sets the `localMaxRouteStartReductionTime` for `IPillarNode`.
`void`	`setLocalReductionTimeIsIncludedInWorkingTime(boolean isIncludedInTotalWorkingTime)` Sets whether the `localMaxRouteStartReductionTime` is included in the `WorkingHours`.
`void`	`setLocalStayOutCycleDefinition(Duration cycle, LocalDate cycleStart)` Sets the `Duration` of the cycle within which the maximum number of `overnight stays` are allowed and within which the minimum `recovery time` (`WorkingHours` without `overnight stays`) has to be observed.
`void`	`setMaxDistance(javax.measure.Quantity<javax.measure.quantity.Length> maxDistance)` Sets the maximal distance that a `Resource` is allowed to travel per day, cannot be null.
`void`	`setMaxHours(Duration maxWorkingTime)` Deprecated.
`void`	`setMaxWorkingTime(Duration maxWorkingTime)` Sets the maximum number of hours a `Resource` is allowed to work per day.
`void`	`setResourceDepot(IResourceDepot depot)`
`boolean`	`setStartTimeHook(Duration routeStartTimeHookDuration)`
`static IWorkingHours`	`takeOverProperties(IWorkingHours src, IWorkingHours target)`
`static IWorkingHours`	`takeOverProperties(IWorkingHours src, IWorkingHours target, boolean doStartUpdate)`

Methods inherited from class com.dna.jopt.member.unit.hours.AbstractDutyHours
compareTo, getTimeWindow, isPrefferedHour, setIsPrefferedHour, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.dna.jopt.member.unit.hours.IDutyHours
getTimeWindow, isPrefferedHour, setIsPrefferedHour

Methods inherited from interface java.lang.Comparable
compareTo

- Constructor Detail
  - WorkingHours
```
public WorkingHours(ZonedDateTime hoursBegin,
                    ZonedDateTime hoursEnd)
```
    The constructor for WorkingHours using AbstractDutyHours(ZonedDateTime, ZonedDateTime). The WorkingHours define in which timeframe a IResource is able to service INode. Internally the time eventually is handled as seconds since the epoch 1970-01-01T00:00:00Z. The time zone is derived from the ZonedDateTime. Both times need to be in the same time zone.
    Implementation example:
```
 List<IWorkingHours> workingHours = new ArrayList<IWorkingHours>();
     ZoneId zoneId = ZoneId.of("Europe/Berlin");
     workingHours.add(
         new WorkingHours(
             ZonedDateTime.of(2020, MAY.getValue(), 6, 8, 0, 0, 0, zoneId),
             ZonedDateTime.of(2020, MAY.getValue(), 6, 17, 0, 0, 0, zoneId)));
 
```
    Parameters:
    
    hoursBegin - the zonedDateTime when the resource is allowed to begin work
    
    hoursEnd - the zonedDateTime when the resource is supposed to stop working
  - WorkingHours
```
public WorkingHours(ZonedDateTime hoursBegin,
                    Duration maxTime)
```
  - WorkingHours
```
public WorkingHours(TimeWindow window)
```
  - WorkingHours
```
public WorkingHours(Instant hoursBegin,
                    Instant hoursEnd,
                    ZoneId zoneId)
```
    The constructor for WorkingHours using Instants. The WorkingHours define in which timeframe a CapacityResource is able to service INode.
    
    Parameters:
    
    hoursBegin - the zonedDateTime when the resource is allowed to begin work
    
    hoursEnd - the zonedDateTime when the resource is supposed to stop working
    
    zoneId - the zoneId ID of the time zone of the beginning and ending times
  - WorkingHours
```
public WorkingHours(long hoursBeginMillis,
                    long hoursEndMillis,
                    ZoneId zoneId)
```
    The constructor for WorkingHours using milliseconds since 01.01.1970. The WorkingHours define in which timeframe a CapacityResource is able to service INode.
    Using WorkingHours(ZonedDateTime, ZonedDateTime) is preferred.
    
    Parameters:
    
    hoursBeginMillis - the long milliseconds since 1970-01-01T00:00:00Z when the resource is allowed to begin work
    
    hoursEndMillis - the long milliseconds since 1970-01-01T00:00:00Z when the resource is supposed to stop working
    
    zoneId - the zoneId ID of the time zone of the beginning and ending times
  - WorkingHours
```
public WorkingHours(Instant hoursBegin,
                    Instant hoursEnd,
                    ZoneId zoneId,
                    Optional<Duration> maxWorkingTime,
                    Optional<javax.measure.Quantity<javax.measure.quantity.Length>> maxDistance)
```
    Parameters:
    
    hoursBegin - the instant when the resource is allowed to work
    
    hoursEnd - the instant when the resource is supposed to stop working
    
    zoneId - the zoneID of the resource starting location
    
    maxWorkingTime - the optional of the duration of the maximal working time
    
    maxDistance - the optional of the quantity of the maximal distance the resource is allowed to travel
  - WorkingHours
```
@Deprecated
public WorkingHours(GregorianCalendar hoursBegin,
                                GregorianCalendar hoursEnd)
```
    Deprecated. please use WorkingHours(ZonedDateTime, ZonedDateTime) instead
    
    Deprecated constructor
    
    Parameters:
    
    hoursBegin - the gregorianCalendar when the resource is allowed to begin work
    
    hoursEnd - the gregorianCalendar when the resource is supposed to stop working
  - WorkingHours
```
@Deprecated
public WorkingHours(LocalDateTime hoursBegin,
                                LocalDateTime hoursEnd)
```
    Deprecated. please use WorkingHours(ZonedDateTime, ZonedDateTime) instead
    
    Deprecated constructor
    
    Parameters:
    
    hoursBegin - the localDateTime when the resource is allowed to begin work
    
    hoursEnd - the localDateTime when the resource is supposed to stop working
  - WorkingHours
```
@Deprecated
public WorkingHours(Instant hoursBegin,
                                Instant hoursEnd)
```
    Deprecated. please use WorkingHours(ZonedDateTime, ZonedDateTime) instead
    
    Deprecated constructor
    
    Parameters:
    
    hoursBegin - the instant when the resource is allowed to begin work
    
    hoursEnd - the instant when the resource is supposed to stop working
  - WorkingHours
```
@Deprecated
public WorkingHours(com.google.common.collect.Range<Instant> interval)
```
    Deprecated. please use WorkingHours(ZonedDateTime, ZonedDateTime) instead
    
    Deprecated constructor
    
    Parameters:
    
    interval - the range instant when the resource is supposed to start and stop working
  - WorkingHours
```
@Deprecated
public WorkingHours(long hoursBeginMillis,
                                long hoursEndMillis)
```
    Deprecated. please use WorkingHours(ZonedDateTime, ZonedDateTime) instead
    
    Deprecated constructor
    
    Parameters:
    
    hoursBeginMillis - the long seconds since 01.01.1970 when the resource is allowed to begin work
    
    hoursEndMillis - the long seconds since 01.01.1970 when the resource is supposed to stop working
  - WorkingHours
```
@Deprecated
public WorkingHours(Instant hoursBegin,
                                Instant hoursEnd,
                                Duration maxWorkingTime,
                                javax.measure.Quantity<javax.measure.quantity.Length> maxDistance)
```
    Deprecated. please use WorkingHours(ZonedDateTime, ZonedDateTime) instead. The
    
    Deprecated constructor
    
    Parameters:
    
    hoursBegin - the instant when the resource is allowed to begin work
    
    hoursEnd - instant when the resource is supposed to stop working
    
    maxWorkingTime - the duration of the maximal working time per day
    
    maxDistance - the quantity length maximal distance the resource should travel per day
  - WorkingHours
```
@Deprecated
public WorkingHours(Instant hoursBegin,
                                Instant hoursEnd,
                                Optional<Duration> maxWorkingTime,
                                Optional<javax.measure.Quantity<javax.measure.quantity.Length>> maxDistance)
```
    Deprecated. please use WorkingHours(ZonedDateTime, ZonedDateTime) instead. The
    
    Deprecated constructor
    
    Parameters:
    
    hoursBegin - the instant when the resource is allowed to begin work
    
    hoursEnd - instant when the resource is supposed to stop working
    
    maxWorkingTime - the optional duration of the maximal working time per day
    
    maxDistance - the optional quantity length maximal distance the resource should travel per day
  - WorkingHours
```
@Deprecated
public WorkingHours(com.google.common.collect.Range<Instant> interval,
                                Duration maxWorkingTime,
                                javax.measure.Quantity<javax.measure.quantity.Length> maxDistance)
```
    Deprecated. please use WorkingHours(ZonedDateTime, ZonedDateTime) instead. The
    
    Deprecated constructor
    
    Parameters:
    
    interval - the range instant when the resource is allowed to work
    
    maxWorkingTime - duration of the maximal working time per day
    
    maxDistance - quantity length maximal distance the resource should travel per day
- Method Detail
  - copy
```
public IWorkingHours copy()
```
    Description copied from interface: IWorkingHours
    
    Returns a copy of WorkingHours(this.getBegin(), this.getEnd(), this.getZoneId()) and invokes takeOverProperties(com.dna.jopt.member.unit.hours.IWorkingHours, com.dna.jopt.member.unit.hours.IWorkingHours) to also copy the properties.
    
    Specified by:
    
    copy in interface IDutyHours
    
    Specified by:
    
    copy in interface IWorkingHours
    
    Returns:
    
    a copy of the WorkingHours
  - takeOverProperties
```
public static IWorkingHours takeOverProperties(IWorkingHours src,
                                               IWorkingHours target)
```
  - takeOverProperties
```
public static IWorkingHours takeOverProperties(IWorkingHours src,
                                               IWorkingHours target,
                                               boolean doStartUpdate)
```
  - setIsAvailableForStay
```
public void setIsAvailableForStay(boolean isAvailableForStay)
```
    Description copied from interface: IWorkingHours
    
    Sets if the Resource is allowed for an overnight stay instead of returning to the starting location. The Node also needs INode.setIsStayNode(boolean) set to true so this function can be used.
    
    Specified by:
    
    setIsAvailableForStay in interface IWorkingHours
    
    Parameters:
    
    isAvailableForStay - boolean, the default value is true.
  - getIsAvailableForStay
```
public boolean getIsAvailableForStay()
```
    Description copied from interface: IWorkingHours
    
    Gets if the Resource is allowed to do an overnight stay. The Node also needs INode.setIsStayNode(boolean) set to true so this function can be used.
    This method is specific for the set WorkingHours and can therefore be specific for certain days in the week (no overnight stays on Fridays.
    
    Specified by:
    
    getIsAvailableForStay in interface IWorkingHours
    
    Returns:
    
    boolean, the default value is true.
  - getFlavour
```
public IDutyHours.DutyHoursFlavour getFlavour()
```
    Description copied from interface: IDutyHours
    
    Gets the IDutyHours.DutyHoursFlavour.WOH_FLAVOUR, the default value is enum constant ordinal: 0.
    
    Specified by:
    
    getFlavour in interface IDutyHours
    
    Returns:
    
    the enum constant ordinal
  - setMaxWorkingTime
```
public void setMaxWorkingTime(Duration maxWorkingTime)
```
    Description copied from interface: IWorkingHours
    
    Sets the maximum number of hours a Resource is allowed to work per day.
    
    Specified by:
    
    setMaxWorkingTime in interface IWorkingHours
    
    Parameters:
    
    maxWorkingTime - the maximal working time
  - setMaxHours
```
@Deprecated
public void setMaxHours(Duration maxWorkingTime)
```
    Deprecated.
    
    Description copied from interface: IWorkingHours
    
    Decrecated method
    Sets the maxHours a Resource is allowed to work per day.
    
    Specified by:
    
    setMaxHours in interface IWorkingHours
    
    Parameters:
    
    maxWorkingTime - the double to be set for maxHours
  - getMaxHours
```
public double getMaxHours()
```
    Description copied from interface: IWorkingHours
    
    Gets maximum number of hours a Resource is allowed to work per day in hours. By default it is not usable and the value is -1.
    
    Specified by:
    
    getMaxHours in interface IWorkingHours
    
    Returns:
    
    the double maxHours.
  - setMaxDistance
```
public void setMaxDistance(javax.measure.Quantity<javax.measure.quantity.Length> maxDistance)
```
    Description copied from interface: IWorkingHours
    
    Sets the maximal distance that a Resource is allowed to travel per day, cannot be null.
    
    Specified by:
    
    setMaxDistance in interface IWorkingHours
    
    Parameters:
    
    maxDistance - the quantity, will be casted to kilometre
  - getMaxDistanceKm
```
public double getMaxDistanceKm()
```
    Description copied from interface: IWorkingHours
    
    Gets the maxDistance, which is the maximal distance in km a Resource is allowed to travel without a IViolation per day.
    
    Specified by:
    
    getMaxDistanceKm in interface IWorkingHours
    
    Returns:
    
    double maxDistance in km. By default it is not usable and the value is -1.
  - setIsClosedRoute
```
public void setIsClosedRoute(boolean isClosedRoute)
```
    Description copied from interface: IWorkingHours
    
    Sets the Route to a closed Route. A closed Route is a Route where the Resource is going to its home afterwards. An open Route is a Route where the Resource is simply staying at the last Node if OverNightStay also has been activated or where the Resource has to travel home outside of the WorkingHours. The default value is true.
    
    Specified by:
    
    setIsClosedRoute in interface IWorkingHours
    
    Parameters:
    
    isClosedRoute - the boolean if the Route is a closed Route
    
    See Also:
    
    IBasicResource.hasAlternateDestination()
  - isClosedRoute
```
public boolean isClosedRoute()
```
    Description copied from interface: IWorkingHours
    
    Checks if the route is closed or not, the default value is false. A closed Route is a Route where the Resource is going to its home afterwards. An open Route is a Route where the Resource is simply staying at the last Node if OverNightStay also has been activated or where the Resource has to travel home outside of the WorkingHours. The default value is true.
    
    Specified by:
    
    isClosedRoute in interface IWorkingHours
    
    Returns:
    
    the boolean isClosedRoute
    
    See Also:
    
    IBasicResource.hasAlternateDestination()
  - setLocalStayOutCycleDefinition
```
public void setLocalStayOutCycleDefinition(Duration cycle,
                                           LocalDate cycleStart)
```
    Description copied from interface: IWorkingHours
    
    Sets the Duration of the cycle within which the maximum number of overnight stays are allowed and within which the minimum recovery time (WorkingHours without overnight stays) has to be observed. The recovery time is set in IResource.setStayOutCycleDefinition(Duration, LocalDate).
    Without setting the cycle the maximal number of overnight stays will not be refreshed and count for the full duration of the WorkingHours. The cycle can be applied to the local Resource which means it will stay the same for this Resource throughout the Optimization. If like here set locally it is only valid for this WorkingHours and the cycle can change depending on the dates or time in the week. It can for example be set that no overnight stays are allowed on Fridays.
    
    Specified by:
    
    setLocalStayOutCycleDefinition in interface IWorkingHours
    
    Parameters:
    
    cycle - duration of the cycle
    
    cycleStart - the localDate of the cycle start
  - getLocalStayOutCycle
```
public Optional<Duration> getLocalStayOutCycle()
```
    Description copied from interface: IWorkingHours
    
    Gets the Duration of the potential local stayout cycle.
    For more information please see IWorkingHours.setLocalStayOutCycleDefinition(Duration, LocalDate).
    
    Specified by:
    
    getLocalStayOutCycle in interface IWorkingHours
    
    Returns:
    
    the duration of the local stayOutCycle
  - getLocalStayOutCycleStart
```
public Optional<LocalDate> getLocalStayOutCycleStart()
```
    Description copied from interface: IWorkingHours
    
    Gets the start of the local stayout cycle.
    For more information please see IWorkingHours.setLocalStayOutCycleDefinition(Duration, LocalDate).
    
    Specified by:
    
    getLocalStayOutCycleStart in interface IWorkingHours
    
    Returns:
    
    the date of the localStayCycleStart
  - setLocalReductionTimeIsIncludedInWorkingTime
```
public void setLocalReductionTimeIsIncludedInWorkingTime(boolean isIncludedInTotalWorkingTime)
```
    Description copied from interface: IWorkingHours
    
    Sets whether the localMaxRouteStartReductionTime is included in the WorkingHours. The default value is false. If false and IWorkingHours.setLocalMaxRouteStartReductionTime(Duration, boolean) is set to true the driving time to the first Node has to be done in the Resources private time
    For more information please see IWorkingHours.setLocalMaxRouteStartReductionTime(Duration, boolean).
    
    Specified by:
    
    setLocalReductionTimeIsIncludedInWorkingTime in interface IWorkingHours
    
    Parameters:
    
    isIncludedInTotalWorkingTime - the boolean whether reduction time is included in the WorkingHours
  - setLocalMaxRouteStartReductionTime
```
public boolean setLocalMaxRouteStartReductionTime(Duration maxRouteStartReductionTime,
                                                  boolean isOnlyUsedForDriving)
```
    Description copied from interface: IWorkingHours
    
    Sets the maximum time which the Resource can be expected to drive to the first Node in its private time.
    If the OpeningHours of a Node and the WorkingHours of a Resource start at 8 the driving time is an hour and the Resource's localMaxRouteStartReductionTime is 30 Minutes the Resource will start driving towards the Node at 7.30 (outside of its WorkingHours) and arrive there at 8.30.
    The Boolean defines whether the localMaxRouteStartReductionTime can only be used for driving or not and is usually set to true. The Resource can not work in the localMaxRouteStartReductionTime in that case.
    If like here set locally the localMaxRouteStartReductionTime is only valid for these specific WorkingHours.
    
    Specified by:
    
    setLocalMaxRouteStartReductionTime in interface IWorkingHours
    
    Parameters:
    
    maxRouteStartReductionTime - the duration of the maxRouteStartReductionTime
    
    isOnlyUsedForDriving - the boolean whether the time can only be used for driving
    
    Returns:
    
    false if reductionTime is null or negative
  - setLocalMaxRouteStartReductionTimePillar
```
public boolean setLocalMaxRouteStartReductionTimePillar(Duration maxRouteStartReductionTime,
                                                        boolean isOnlyUsedForDriving)
```
    Description copied from interface: IWorkingHours
    
    Sets the localMaxRouteStartReductionTime for IPillarNode. Overwrites the set localMaxRouteStartReductionTime and sets the new value for Pillars. If no localMaxRouteStartReductionTime has been set, sets the new value for Pillars only.
    For more information please see IWorkingHours.setLocalMaxRouteStartReductionTime(Duration, boolean).
    
    Specified by:
    
    setLocalMaxRouteStartReductionTimePillar in interface IWorkingHours
    
    Parameters:
    
    maxRouteStartReductionTime - the duration of the localMaxStartReductionTimePillar
    
    isOnlyUsedForDriving - the boolean whether it is only used for driving
    
    Returns:
    
    false if reductionTime is null or negative
  - isLocalReductionTimeOnlyUsedForDriving
```
public Optional<Boolean> isLocalReductionTimeOnlyUsedForDriving()
```
    Description copied from interface: IWorkingHours
    
    Checks whether the potentially set localMaxRouteStartReductionTime can only be used for driving, not for working. Per default this is set to true.
    For more information please see IWorkingHours.setLocalMaxRouteStartReductionTime(Duration, boolean)
    
    Specified by:
    
    isLocalReductionTimeOnlyUsedForDriving in interface IWorkingHours
    
    Returns:
    
    the checked status or an empty Optional if no localMaxRouteStartReductionTime has been set
  - isLocalReductionTimeOnlyUsedForDrivingPillar
```
public Optional<Boolean> isLocalReductionTimeOnlyUsedForDrivingPillar()
```
    Description copied from interface: IWorkingHours
    
    Checks whether the potentially set localMaxRouteStartReductionTime for IPillarNode can only be used for driving, not for working. Per default this is set to true.
    For more information please see IWorkingHours.setLocalMaxRouteStartReductionTime(Duration, boolean) and IWorkingHours.setLocalMaxRouteStartReductionTimePillar(Duration, boolean).
    
    Specified by:
    
    isLocalReductionTimeOnlyUsedForDrivingPillar in interface IWorkingHours
    
    Returns:
    
    the checked status or an empty Optional if no localMaxRouteStartReductionTime has been set
  - isLocalReductionTimeIncludedInWorkingTime
```
public Optional<Boolean> isLocalReductionTimeIncludedInWorkingTime()
```
    Description copied from interface: IWorkingHours
    
    Checks whether the localMaxRouteStartReductionTime is included in the WorkingHours. The default value is false. If false and IWorkingHours.setLocalMaxRouteStartReductionTime(Duration, boolean) is set to true the driving time to the first Node has to be done in the Resources private time
    For more information please see IWorkingHours.setLocalMaxRouteStartReductionTime(Duration, boolean).
    
    Specified by:
    
    isLocalReductionTimeIncludedInWorkingTime in interface IWorkingHours
    
    Returns:
    
    the status of an empty Optional if no localMaxRouteStartReductionTime has been set
  - getLocalMaxRouteStartReductionTimeMillis
```
public Optional<Long> getLocalMaxRouteStartReductionTimeMillis()
```
    Description copied from interface: IWorkingHours
    
    Gets the localMaxRouteStartReductionTime in milliseconds.
    For more information please see IWorkingHours.setLocalMaxRouteStartReductionTime(Duration, boolean).
    
    Specified by:
    
    getLocalMaxRouteStartReductionTimeMillis in interface IWorkingHours
    
    Returns:
    
    the status or an empty optional if no localMaxRouteStartReductionTime has been set
  - getLocalMaxRouteStartReductionTimeMillisPillar
```
public Optional<Long> getLocalMaxRouteStartReductionTimeMillisPillar()
```
    Description copied from interface: IWorkingHours
    
    Gets the localMaxRouteStartReductionTime for IPillarNode in milliseconds.
    For more information please see IWorkingHours.setLocalMaxRouteStartReductionTimePillar(Duration, boolean) and IWorkingHours.setLocalMaxRouteStartReductionTime(Duration, boolean).
    
    Specified by:
    
    getLocalMaxRouteStartReductionTimeMillisPillar in interface IWorkingHours
    
    Returns:
    
    the status or an empty optional if no localMaxRouteStartReductionTime has been set
  - setLocalFlexTime
```
public boolean setLocalFlexTime(Duration idleTimeReductionTime)
```
    Description copied from interface: IWorkingHours
    
    Sets the amount of time a Resource can be expected to start working later and stay longer at work if needed.
    If the first Node is at 11, the Resources WorkingHours started at 8 and the localFlexTime is set to 3 hours, the Resource starts working at 11 and has to stay 3 hours longer at work than usual. If the localFlexTime in the above example is set to 2 hours, the Resource will be idle from 10-11 but it is considered working time.
    
    Specified by:
    
    setLocalFlexTime in interface IWorkingHours
    
    Parameters:
    
    idleTimeReductionTime - the duration of the idle time reduction time
    
    Returns:
    
    true if the setting was accepted
  - getLocalFlexTimeMillis
```
public Optional<Long> getLocalFlexTimeMillis()
```
    Description copied from interface: IWorkingHours
    
    Gets the localFlexTime in milliseconds.
    For more information please see IWorkingHours.setLocalFlexTime(Duration).
    
    Specified by:
    
    getLocalFlexTimeMillis in interface IWorkingHours
    
    Returns:
    
    the long local flex time in milliseconds, an empty Optional if no localFlexTime has been set
  - setStartTimeHook
```
public boolean setStartTimeHook(Duration routeStartTimeHookDuration)
```
    Specified by:
    
    setStartTimeHook in interface IWorkingHours
  - getRouteStartShiftMillisHook
```
public Optional<Long> getRouteStartShiftMillisHook()
```
    Specified by:
    
    getRouteStartShiftMillisHook in interface IWorkingHours
  - addConnectionHook
```
public boolean addConnectionHook(ReducedNodeEdgeConnectorItem item)
```
    Specified by:
    
    addConnectionHook in interface IWorkingHours
  - setConnectionHooks
```
public boolean setConnectionHooks(Map<String,ReducedNodeEdgeConnectorItem> map)
```
    Specified by:
    
    setConnectionHooks in interface IWorkingHours
  - getConnectionHook
```
public Optional<ReducedNodeEdgeConnectorItem> getConnectionHook(String toId)
```
    Specified by:
    
    getConnectionHook in interface IWorkingHours
  - getConnectionHooks
```
public Optional<Map<String,ReducedNodeEdgeConnectorItem>> getConnectionHooks()
```
    Specified by:
    
    getConnectionHooks in interface IWorkingHours
  - hasHook
```
public boolean hasHook()
```
    Specified by:
    
    hasHook in interface IWorkingHours
  - setLocalMaxFreePostWorkDrivingTerminationTime
```
public boolean setLocalMaxFreePostWorkDrivingTerminationTime(Duration postTimeReductionTime)
```
    Description copied from interface: IWorkingHours
    
    Sets the amount of time the Resource can be expected to drive home to its starting location in its free time.
    If returning from the last Node to the starting location takes 1 hour and the freePostWorkDrivingTerminationTime is set to 40 minutes, those 40 minutes of the drive home are considered private time.
    This method sets the local free post work driving termination time locally. Therefore different times can be set for different WorkingHours. If the time should be valid for all the WorkingHours of a Resource please use IResource.setMaxFreePostWorkDrivingTerminationTime(Duration).
    
    Specified by:
    
    setLocalMaxFreePostWorkDrivingTerminationTime in interface IWorkingHours
    
    Parameters:
    
    postTimeReductionTime - the duration free time that needs to be used to drive home
    
    Returns:
    
    true if the setting was accepted
  - setLocalMaxFreePostWorkDrivingTerminationTime
```
public boolean setLocalMaxFreePostWorkDrivingTerminationTime(Duration postTimeReductionTime,
                                                             boolean onlyApplyOnOvertime)
```
    Description copied from interface: IWorkingHours
    
    Sets the local max free post work driving termination time. If onlyApplyOnOvertime is true, the post driving time is only utilized if the route shows overtime. Moreover, the maximal utilized time is the overtime itself (or, if lower, the postWorkingHourTimeReductionTime).
    
    Specified by:
    
    setLocalMaxFreePostWorkDrivingTerminationTime in interface IWorkingHours
    
    Parameters:
    
    postTimeReductionTime - the post time reduction time
    
    onlyApplyOnOvertime - the only apply on overtime
    
    Returns:
    
    true, if successful
  - getLocalMaxFreePostWorkDrivingTerminationTimeMillis
```
public Optional<Long> getLocalMaxFreePostWorkDrivingTerminationTimeMillis()
```
    Description copied from interface: IWorkingHours
    
    Gets the freePostWorkDrivingTerminationTime in milliseconds.
    For more information please see IWorkingHours.setLocalMaxFreePostWorkDrivingTerminationTime(Duration).
    
    Specified by:
    
    getLocalMaxFreePostWorkDrivingTerminationTimeMillis in interface IWorkingHours
    
    Returns:
    
    the value or an empty Optional if no freePostWorkDrivingTerminationTime has been set
  - isLocalOnlyApplyFreePostWorkDrivingOnOvertime
```
public Optional<Boolean> isLocalOnlyApplyFreePostWorkDrivingOnOvertime()
```
    Specified by:
    
    isLocalOnlyApplyFreePostWorkDrivingOnOvertime in interface IWorkingHours
  - setLocalMaxPillarAfterHoursTime
```
public boolean setLocalMaxPillarAfterHoursTime(Duration maxPillarEndOverTime)
```
    Description copied from interface: IWorkingHours
    
    Sets the amount of time after WorkingHours within which a IPillarNode can be set. The Resources have to visit this Pillar even tough it is outside of WorkingHours.
    This method in only valid for a specific set of WorkingHours. If you want to set the same time for all the WorkingHours of a Pillar please use IResource.setMaxPillarAfterHoursTime(Duration)
    
    Specified by:
    
    setLocalMaxPillarAfterHoursTime in interface IWorkingHours
    
    Parameters:
    
    maxPillarEndOverTime - the duration after WorkingHours within which a Pillar still has to be given service
    
    Returns:
    
    true if the setting was accepted
  - getLocalMaxPillarAfterHoursTime
```
public Optional<Long> getLocalMaxPillarAfterHoursTime()
```
    Description copied from interface: IWorkingHours
    
    Gets the localMaxPillarAfterHoursTime of IPillarNode in milliseconds.
    For more information please see IWorkingHours.setLocalMaxPillarAfterHoursTime(Duration).
    
    Specified by:
    
    getLocalMaxPillarAfterHoursTime in interface IWorkingHours
    
    Returns:
    
    the long localMaxPillarAfterHoursTime
  - addConstraint
```
public void addConstraint(IWorkingHoursLevelConstraint constraint)
```
    Description copied from interface: IWorkingHours
    
    Adds a Constraint to the WorkingHours so only Resources with that specific Qualification will be able to serve the Nodes to which those WorkingHours are applied.
    For examples see UKPostCodeQualification and UKPostCodeConstraint
    
    Specified by:
    
    addConstraint in interface IWorkingHours
    
    Parameters:
    
    constraint - the iWorkingHoursLevelConstraint to add to the workingHours
  - addConstraint
```
public void addConstraint(IMultiWorkingHoursLevelConstraint constraint)
```
    Specified by:
    
    addConstraint in interface IWorkingHours
  - getConstraints
```
public List<IWorkingHoursLevelConstraint> getConstraints()
```
    Description copied from interface: IWorkingHours
    
    Gets the Constraints set on the IResource. The Resource can only work on Nodes within within the range of its Constraint.
    An example of its implementation is UKPostCodeConstraint.
    
    Specified by:
    
    getConstraints in interface IWorkingHours
    
    Returns:
    
    the workingHours constraints
  - getMultiConstraints
```
public List<IMultiWorkingHoursLevelConstraint> getMultiConstraints()
```
    Specified by:
    
    getMultiConstraints in interface IWorkingHours
  - isNodeColorCodingInUse
```
public boolean isNodeColorCodingInUse()
```
    Description copied from interface: IWorkingHours
    
    Checks if any INodeColor has been set through the use of a NodeColorCapacityItem.
    
    Specified by:
    
    isNodeColorCodingInUse in interface IWorkingHours
    
    Returns:
    
    true if this is the case
  - addNodeColorCapacity
```
public void addNodeColorCapacity(NodeColorCapacityItem item)
```
    Description copied from interface: IWorkingHours
    Adds a certain INodeColor to the Resource. This way can be made sure that Nodes with a certain Color are not overrepresented and can be used for white space generation.
    Implementation example:
```
 double preventivePercent = 0.2;
     double contractorPercent = 0.5;
     double breakfixPercent = 0.7;

     workingHours.forEach(wh -> {
       wh.addNodeColorCapacity(new NodeColorCapacityItem(NodeColors.PREVENTIVE,preventivePercent));
       wh.addNodeColorCapacity(new NodeColorCapacityItem(NodeColors.BREAKFIX,breakfixPercent));
       wh.addNodeColorCapacity(new NodeColorCapacityItem(NodeColors.CONTRACTOR,contractorPercent));
       }
 
```
    Specified by:
    
    addNodeColorCapacity in interface IWorkingHours
    
    Parameters:
    
    item - the nodeColorCapacityItem
    
    See Also:
    
    NodeColorCapacityItem
  - getNodeColorCapacityMap
```
public Map<Integer,NodeColorCapacityItem> getNodeColorCapacityMap()
```
    Description copied from interface: IWorkingHours
    
    Gets the a Map of the NodeColorCapacity. For more information please see INodeColor and NodeColorCapacityItem.
    
    Specified by:
    
    getNodeColorCapacityMap in interface IWorkingHours
    
    Returns:
    
    the map of colorCapacity
  - getPresentColorCodes
```
public Set<Integer> getPresentColorCodes()
```
    Description copied from interface: IWorkingHours
    
    Gets the INodeColor that are in use.
    
    Specified by:
    
    getPresentColorCodes in interface IWorkingHours
    
    Returns:
    
    the Color codes
    
    See Also:
    
    NodeColorCapacityItem
  - getColorCapacityItemByColorCode
```
public Optional<NodeColorCapacityItem> getColorCapacityItemByColorCode(int colorCode)
```
    Description copied from interface: IWorkingHours
    
    Gets the NodeColorCapacityItem which limit the amount of Color coded Nodes a Resource can give service to. This way can be made sure that Nodes with a certain Color are not overrepresented and can be used for white space generation.
    
    Specified by:
    
    getColorCapacityItemByColorCode in interface IWorkingHours
    
    Parameters:
    
    colorCode - the int code of the color
    
    Returns:
    
    the NodeColorCapacityItem or an empty Optional if no colorCapaciy has been set.
    
    See Also:
    
    INodeColor
  - addQualification
```
public void addQualification(IQualification qualification)
```
    Description copied from interface: IWorkingHours
    
    Adds a IQualification to the IWorkingHours, which means that by adding a IConstraint to the INode, they are limited to which Nodes they can give service.
    
    Specified by:
    
    addQualification in interface IWorkingHours
    
    Parameters:
    
    qualification - the IQualification that is to be added
  - getQualifications
```
public Map<Class<? extends IQualification>,IQualification> getQualifications()
```
    Description copied from interface: IWorkingHours
    
    Gets the IQualification of the IWorkingHours.
    
    Specified by:
    
    getQualifications in interface IWorkingHours
    
    Returns:
    
    the node qualifications
    
    See Also:
    
    IWorkingHours.addQualification(IQualification)
  - setResourceDepot
```
public void setResourceDepot(IResourceDepot depot)
```
    Specified by:
    
    setResourceDepot in interface IWorkingHours
  - getResourceDepot
```
public Optional<IResourceDepot> getResourceDepot()
```
    Specified by:
    
    getResourceDepot in interface IWorkingHours

Class WorkingHours

Nested Class Summary

Nested classes/interfaces inherited from interface com.dna.jopt.member.unit.hours.IDutyHours

Constructor Summary

Method Summary

Methods inherited from class com.dna.jopt.member.unit.hours.AbstractDutyHours

Methods inherited from class java.lang.Object

Methods inherited from interface com.dna.jopt.member.unit.hours.IDutyHours

Methods inherited from interface java.lang.Comparable

Constructor Detail

WorkingHours

WorkingHours

WorkingHours

WorkingHours

WorkingHours

WorkingHours

WorkingHours

WorkingHours

WorkingHours

WorkingHours

WorkingHours

WorkingHours

WorkingHours

WorkingHours

Method Detail

copy

takeOverProperties

takeOverProperties

setIsAvailableForStay

getIsAvailableForStay

getFlavour

setMaxWorkingTime

setMaxHours

getMaxHours

setMaxDistance

getMaxDistanceKm

setIsClosedRoute

isClosedRoute

setLocalStayOutCycleDefinition

getLocalStayOutCycle

getLocalStayOutCycleStart

setLocalReductionTimeIsIncludedInWorkingTime

setLocalMaxRouteStartReductionTime

setLocalMaxRouteStartReductionTimePillar

isLocalReductionTimeOnlyUsedForDriving

isLocalReductionTimeOnlyUsedForDrivingPillar

isLocalReductionTimeIncludedInWorkingTime

getLocalMaxRouteStartReductionTimeMillis

getLocalMaxRouteStartReductionTimeMillisPillar

setLocalFlexTime

getLocalFlexTimeMillis

setStartTimeHook

getRouteStartShiftMillisHook

addConnectionHook

setConnectionHooks

getConnectionHook

getConnectionHooks

hasHook

setLocalMaxFreePostWorkDrivingTerminationTime

setLocalMaxFreePostWorkDrivingTerminationTime

getLocalMaxFreePostWorkDrivingTerminationTimeMillis

isLocalOnlyApplyFreePostWorkDrivingOnOvertime

setLocalMaxPillarAfterHoursTime

getLocalMaxPillarAfterHoursTime

addConstraint

addConstraint

getConstraints

getMultiConstraints

isNodeColorCodingInUse

addNodeColorCapacity

getNodeColorCapacityMap

getPresentColorCodes

getColorCapacityItemByColorCode

addQualification

getQualifications

setResourceDepot

getResourceDepot