Smartswitch
Operations | List of all members
Smartswitch::Telephony::Forwarding::Timetable Interface Reference

This interface enables to set the range of time during which the ForwardingRule should be active during the week. More...

defined in <Timetable.ice>

interface Timetable extends Smartswitch::Destroyable { ... }

Inheritance diagram for Smartswitch::Telephony::Forwarding::Timetable:
Inheritance graph
[legend]
Collaboration diagram for Smartswitch::Telephony::Forwarding::Timetable:
Collaboration graph
[legend]

Operations

TimeOfDay getFrom (DayOfWeek dayOfWeek)
 Obtain the TimeOfDay of a given DayOfWeek at which the ForwardingRule activates. More...
 
TimeOfDay getTo (DayOfWeek dayOfWeek)
 Obtain the TimeOfDay of a given DayOfWeek at which the ForwardingRule deactivates. More...
 
void setFrom (DayOfWeek dayOfWeek, TimeOfDay timeOfDay) throws ArgumentException
 Set the TimeOfDay for a given DayOfWeek at which to activate the ForwardingRule. More...
 
void setTo (DayOfWeek dayOfWeek, TimeOfDay timeOfDay) throws ArgumentException
 Set the TimeOfDay for a given DayOfWeek at which to deactivate the ForwardingRule. More...
 
- Operations inherited from Smartswitch::Destroyable
void destroy ()
 Destroy the proxy entity at the Smartswitch side. More...
 

Detailed Description

This interface enables to set the range of time during which the ForwardingRule should be active during the week.

The Timetable may look like this (the example of forwarding timetable in non-working hours):

DayOfWeek TimeOfDay
Monday 1800
Tuesday 1800
Wednesday 1800
Thursday 1800
Friday 1800
Saturday 0059
Sunday 0059

Operation Documentation

◆ getFrom()

TimeOfDay getFrom ( DayOfWeek  dayOfWeek)

Obtain the TimeOfDay of a given DayOfWeek at which the ForwardingRule activates.

Parameters
dayOfWeekThe DayOfWeek at which the ForwardingRule activates.
Returns
The TimeOfDay at which the ForwardingRule activates.

◆ getTo()

TimeOfDay getTo ( DayOfWeek  dayOfWeek)

Obtain the TimeOfDay of a given DayOfWeek at which the ForwardingRule deactivates.

Parameters
dayOfWeekThe DayOfWeek at which the ForwardingRule deactivates.
Returns
The TimeOfDay at which the ForwardingRule deactivates.

◆ setFrom()

void setFrom ( DayOfWeek  dayOfWeek,
TimeOfDay  timeOfDay 
) throws ArgumentException

Set the TimeOfDay for a given DayOfWeek at which to activate the ForwardingRule.

Parameters
dayOfWeekThe DayOfWeek at which the ForwardingRule activates.
timeOfDayThe TimeOfDay at which the ForwardingRule activates.
See also
getFrom()

◆ setTo()

void setTo ( DayOfWeek  dayOfWeek,
TimeOfDay  timeOfDay 
) throws ArgumentException

Set the TimeOfDay for a given DayOfWeek at which to deactivate the ForwardingRule.

Parameters
dayOfWeekThe DayOfWeek at which the ForwardingRule deactivates.
timeOfDayThe TimeOfDay at which the ForwardingRule deactivates.
See also
getTo()

The documentation for this interface was generated from the following file: