| | | | SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
|
|
mcs
|
Class RingingScheduleEntry
|
public class RingingScheduleEntry
RingingScheduleEntry defines when a particular RingingDeviceSet is applicable by defining the day interval, time interval and priority of the RingingDeviceSet. RingingScheduleEntries are provisionable and clonable.
Links:
Kernel Association Association Link
The ringingDeviceSet attribute describes the RingingDeviceSet that should be applied at the specified time interval and priority
Constraints:
- must be a valid RingingDeviceSet
Default:
- none
Clone:
- yes - deep. The cloned RingingScheduleEntry references the deep clone of the RingingDeviceSet.
Associates type:
association
Client cardinality:
0..*
Client navigability:
NOT NAVIGABLE
Client visibility:
private
Supplier cardinality:
1
Supplier navigability:
NAVIGABLE
Supplier visibility:
private
| Nested Class Summary |
public class |
Day |
| Field Summary |
Day |
FRIDAY |
Day |
MONDAY |
Day |
SATURDAY |
Day |
SUNDAY |
Day |
THURSDAY |
Day |
TUESDAY |
Day |
WEDNESDAY |
private Day |
|
private int |
|
private int |
|
private int |
|
|
|
private Day |
|
private int |
|
private int |
|
private Day fromDay
The fromDay attribute represents the start day for the day interval. Note: the day interval specifies the block of days for which the time interval should be applied. e.g. the day interval could be Monday to Wednesday. The time interval from 1pm to 2:30pm. As such, the RingingDeviceSet would be scheduled to apply from Monday to Wednesday but only between 1pm and 2:30pm each day
Constraints:
- "SUNDAY" | "MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY"
- NOTE: the type defined for RingingScheduleEntry.Day is an enumeration that assigns integer values to week day values. As such, the integer value assignment has been sync with the UNIX cron utility.
Default:
- "SUNDAY"
Clone:
- yes, verbatim
Multiplicity:
1
private int fromHour
The fromHour attribute indicates the start time hour from which the RingingDeviceSet applies for each of the days specified in the days interval. Note: the time interval specifies the block of hours for which the RingingDeviceSet should be applied on each day of the day interval. e.g. the day interval could be Monday to Wednesday. The time interval from 1pm to 2pm. As such, the RingingDeviceSet would be scheduled to apply from Monday to Wednesday but only between 1pm and 2pm each day
Constraints:
- 0 <= fromHour <= 23
- fromHour:fromMinute < toHour:toMinute
Default:
- 0
Clone:
- yes, verbatim
Multiplicity:
1
private int fromMinute
The fromMinute attribute indicates the start time minute from which the RingingDeviceSet applies for each of the days specified in the days interval.
Note: the time interval (HH:MM) specifies the block of hours for which the RingingDeviceSet should be applied on each day of the day interval. e.g. the day interval could be Monday to Wednesday. The time interval from 1pm to 2pm. As such, the RingingDeviceSet would be scheduled to apply from Monday to Wednesday but only between 1pm and 2pm each day
Constraints:
- 0 <= fromMinute <= 59
- fromHour:fromMinute < toHour:toMinute
Default:
- 0
Clone:
- yes, verbatim
Multiplicity:
1
private int priority
The priority attribute defines the priority of the RingingDeviceSet schedule in order to allow conflict resolution. For example, if a default RingingDeviceSet is scheduled from Monday to Sunday, and from Midnight to Midnight with a priority of 0. A Subscriber could override that on Mondays by adding an additional RingingScheduleEntry specifiying a RingingDeviceSet and priority of > 0.
Constraints:
- 0 <= priority <= 99
Default:
- 0
Clone:
- yes, verbatim
Multiplicity:
1
The ringingDeviceSet attribute describes the RingingDeviceSet that should be applied at the specified time interval and priority
Constraints:
- must be a valid RingingDeviceSet
Default:
- none
Clone:
- yes - deep. The cloned RingingScheduleEntry references the deep clone of the RingingDeviceSet.
Multiplicity:
1
private Day toDay
The toDay attribute specifies the end day for the day interval. Note: the day interval specifies the block of days for which the time interval should be applied. e.g. the day interval could be Monday to Wednesday. The time interval from 1pm to 2:30pm. As such, the RingingDeviceSet would be scheduled to apply from Monday to Wednesday but only between 1pm and 2:30pm each day
Constraints:
- "SUNDAY" | "MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY"
- NOTE: the type defined for RingingScheduleEntry.Day is an enumeration that assigns integer values to week day values. As such, the integer value assignment has been sync with the UNIX cron utility.
Default:
- "SATURDAY"
Clone:
- yes, verbatim
Multiplicity:
1
private int toHour
The toHour attribute specifies the end time hour after which the specified RingingDeviceSet is no longer applicable on the days defined by the day interval. Note: the time interval specifies the block of hours for which the RingingDeviceSet should be applied on each day of the day interval. e.g. the day interval could be Monday to Wednesday. The time interval from 1pm to 2pm. As such, the RingingDeviceSet would be scheduled to apply from Monday to Wednesday but only between 1pm and 2pm each day
Constraints:
- 0 <= toHour <= 23
- fromHour:fromMinute < toHour:toMinute
Default:
- 23
Clone:
- yes, verbatim
Multiplicity:
1
private int toMinute
The toMinute attribute specifies the end time minute after which the specified RingingDeviceSet is no longer applicable on the days defined by the day interval.
Note: the time interval specifies the block of hours for which the RingingDeviceSet should be applied on each day of the day interval. e.g. the day interval could be Monday to Wednesday. The time interval from 1:30pm to 2:30pm. As such, the RingingDeviceSet would be scheduled to apply from Monday to Wednesday but only between 1:30pm and 2:30pm each day
Constraints:
- 0 <= toMinute <= 59
- fromHour:fromMinute < toHour:toMinute
Default:
- 59
Clone:
- yes, verbatim
Multiplicity:
1
| | | | SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
|
|