This interface allows to configure a timetable for a Task. More...

defined in <TaskTimetable.ice>

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

Inheritance diagram for Smartswitch::Telephony::CallGeneration::TaskTimetable:

Collaboration diagram for Smartswitch::Telephony::CallGeneration::TaskTimetable:

Operations
idempotent string	getDayOfMonth () throws AccessException
	Gets the day of a month at which to activate the Task. More...

idempotent string	getDayOfWeek () throws AccessException
	Gets the day of a week at which to activate the Task. More...

idempotent int	getExecutionLimit () throws AccessException
	Gets how long the Task should run during each activation. More...

idempotent string	getHour () throws AccessException
	Gets the hour of a day at which to activate the Task. More...

idempotent string	getMinute () throws AccessException
	Gets the minute of a hour at which to activate the Task. More...

idempotent string	getMonth () throws AccessException
	Gets the month of a year at which to activate the Task. More...

idempotent void	setDayOfMonth (string dom) throws AccessException, ArgumentException
	Sets the day of a month at which to activate the Task. More...

idempotent void	setDayOfWeek (string dow) throws AccessException, ArgumentException
	Sets the day of a week at which to activate the Task. More...

idempotent void	setExecutionLimit (int limit) throws AccessException
	Sets how long the Task should run during each activation. More...

idempotent void	setHour (string hour) throws AccessException, ArgumentException
	Sets the hour of a day at which to activate the Task. More...

idempotent void	setMinute (string minute) throws AccessException, ArgumentException
	Sets the minute of a hour at which to activate the Task. More...

idempotent void	setMonth (string month) throws AccessException, ArgumentException
	Sets the month of a year at which to activate the Task. More...

Operations inherited from Smartswitch::Destroyable
void	destroy ()
	Destroy the proxy entity at the Smartswitch side. More...

Detailed Description

This interface allows to configure a timetable for a Task.

The timetable defines:

at which time the Task will be periodically launched
the execution limit of a Task, i.e. how long the Task should be active during each launch

Operation Documentation

◆ getDayOfMonth()

idempotent string getDayOfMonth ( ) throws AccessException

Gets the day of a month at which to activate the Task.

Returns

cron-formatted time string. For example:

minute	result
10	matches 10th day of month
10-20	matches day from 10 to 20
*/2	matches each 2nd day
*	matches each day

◆ getDayOfWeek()

idempotent string getDayOfWeek ( ) throws AccessException

Gets the day of a week at which to activate the Task.

Returns

cron-formatted time string. For example:

minute	result
0	matches 0th day of week (Sunday)
1	matches 1st day of week (Monday)
1-3	matches day from 1 to 3 (Monday to Wednesday)
*/2	matches each 2nd day
*	matches each day

◆ getExecutionLimit()

idempotent int getExecutionLimit ( ) throws AccessException

Gets how long the Task should run during each activation.

Returns: Limit in seconds.
0 means unlimited.Empty array if unlimited.

◆ getHour()

idempotent string getHour ( ) throws AccessException

Gets the hour of a day at which to activate the Task.

Returns

cron-formatted time string. For example:

minute	result
10	matches 10th hour
10-20	matches hour from 10 to 20
*/2	matches each 2nd hour
*	matches each hour

◆ getMinute()

idempotent string getMinute ( ) throws AccessException

Gets the minute of a hour at which to activate the Task.

Returns

cron-formatted time string. For example:

minute	result
10	matches 10th minute
10-20	matches minute from 10 to 20
*/10	matches each 10th minute
*	matches each minute

◆ getMonth()

idempotent string getMonth ( ) throws AccessException

Gets the month of a year at which to activate the Task.

Returns

cron-formatted time string. For example:

minute	result
1	matches 1st month (January)
1-3	match months 1-3 (January - March)
*/2	matches each 2nd month
*	matches each month

◆ setDayOfMonth()

idempotent void setDayOfMonth ( string dom ) throws AccessException, ArgumentException

Sets the day of a month at which to activate the Task.

Parameters

dom

cron-formatted time string. For example:

minute	result
10	matches 10th day of month
10-20	matches day from 10 to 20
*/2	matches each 2nd day
*	matches each day

◆ setDayOfWeek()

idempotent void setDayOfWeek ( string dow ) throws AccessException, ArgumentException

Sets the day of a week at which to activate the Task.

Parameters

dow

cron-formatted time string. For example:

minute	result
0	matches 0th day of week (Sunday)
1	matches 1st day of week (Monday)
1-3	matches day from 1 to 3 (Monday to Wednesday)
*/2	matches each 2nd day
*	matches each day

◆ setExecutionLimit()

idempotent void setExecutionLimit ( int limit ) throws AccessException

Sets how long the Task should run during each activation.

Parameters

limit Limit in seconds.
0 means unlimited.

◆ setHour()

idempotent void setHour ( string hour ) throws AccessException, ArgumentException

Sets the hour of a day at which to activate the Task.

Parameters

hour

cron-formatted time string. For example:

minute	result
10	matches 10th hour
10-20	matches hour from 10 to 20
*/2	matches each 2nd hour
*	matches each hour

◆ setMinute()

idempotent void setMinute ( string minute ) throws AccessException, ArgumentException

Sets the minute of a hour at which to activate the Task.

Parameters

minute

cron-formatted specification. For example:

minute	result
10	matches 10th minute
10-20	matches minute from 10 to 20
*/10	matches each 10th minute
*	matches each minute

◆ setMonth()

idempotent void setMonth ( string month ) throws AccessException, ArgumentException

Sets the month of a year at which to activate the Task.

Parameters

month

cron-formatted time string. For example:

minute	result
1	matches 1st month (January)
1-3	match months 1-3 (January - March)
*/2	matches each 2nd month
*	to match each month

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

/usr/ports/net/smartswitch/work/smartswitch-9.1.60971/ice/Telephony/CallGeneration/TaskTimetable.ice

Operations

Detailed Description

Operation Documentation

◆ getDayOfMonth()

◆ getDayOfWeek()

◆ getExecutionLimit()

◆ getHour()

◆ getMinute()

◆ getMonth()

◆ setDayOfMonth()

◆ setDayOfWeek()

◆ setExecutionLimit()

◆ setHour()

◆ setMinute()

◆ setMonth()