com.dna.jopt.member.unit.hours

Interface IDutyHours

All Superinterfaces:

Comparable<IDutyHours>, Serializable

All Known Subinterfaces:

IOpeningHours, IWorkingHours

All Known Implementing Classes:

AbstractDutyHours, OpeningHours, WorkingHours

public interface IDutyHours
extends Serializable, Comparable<IDutyHours>

This interface defines the methods to set the work schedules IOpeningHours and IWorkingHoursfor all the different INode and IResource.

While both above mentioned Interfaces extend this Interface, IWorkingHours is used for IResource and IOpeningHours is used for INode.

Since:

28/09/2018

Version:

04/10/2019

Author:

DNA

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IDutyHours.DutyHoursFlavour This enables to clearly distinguish between several instances of IDutyHours, since WorkingHours and OpeningHours have their own flavour.

Method Summary

Modifier and Type	Method and Description
IDutyHours	copy() Returns the hours as WorkingHours(this.getBegin(), this.getEnd(), this.getZoneId()) or OpeningHours(this.getBegin(), this.getEnd(), this.getZoneId()).
IDutyHours.DutyHoursFlavour	getFlavour() Gets the IDutyHours.DutyHoursFlavour.WOH_FLAVOUR, the default value is enum constant ordinal: 0.
TimeWindow	getTimeWindow() Gets the time window.
boolean	isPrefferedHour() Checks if it is a preffered hour.
void	setIsPrefferedHour(boolean isPreffered) Sets the checks if is preffered hour.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getFlavour

IDutyHours.DutyHoursFlavour getFlavour()

Gets the IDutyHours.DutyHoursFlavour.WOH_FLAVOUR, the default value is enum constant ordinal: 0.

Returns:

the enum constant ordinal

copy

IDutyHours copy()

Returns the hours as WorkingHours(this.getBegin(), this.getEnd(), this.getZoneId()) or OpeningHours(this.getBegin(), this.getEnd(), this.getZoneId()). Further, properties are copied.

Returns:

a copy of the Workinghours or the Openinghours

setIsPrefferedHour

void setIsPrefferedHour(boolean isPreffered)

Sets the checks if is preffered hour.

Parameters:

isPreffered - the new checks if is prefferd hour

isPrefferedHour

boolean isPrefferedHour()

Checks if it is a preffered hour.

Returns:

true, if it is a preffered hour

getTimeWindow

TimeWindow getTimeWindow()

Gets the time window.

Returns:

the time window