PolicyConditionTimePeriod

Header Image
Project:
PolicyConditionTimePeriod : Public <<TMF_BusinessEntity>> Business Entity
Created: 1/10/2022 12:03:25 PM
Modified: 1/16/2025 11:02:08 AM
Project:
Advanced:
This is a concrete class that provides the capability of enabling or disabling a PolicyCondition according to a pre-determined time schedule. This enables this class to effectively enable or disable evaluation of the entire condition clause. The simplest way to do this is to specify a value for the TimePeriod class attribute; this may of course be modified by other class attributes as necessary.<br/>
  • Attributes
  • Associations To
  • Tagged Values
  • Advanced
  • Other Links
Attribute Scope Type
dayOfMonthMask Public String
Notes: This is a string attribute that refines the definition of the valid time period that is defined by the timePeriod attribute. This is done by explicitly specifying the days of the month when the policy is valid.<br/><br/>These attributes work together, with the timePeriod attribute used to specify the overall time period during which the PolicyRule might be valid, and the dayOfMonthMask attribute used to pick out the specific days of the month within that time period when the PolicyRule is valid.<br/><br/>This property is formatted as a fixed string of 64 bits. The first 31 bits correspond to the days of the month counting from the beginning, followed by 31 more bits identifying the days of the month counting from the end, followed by 2 bits that are always set to '0'.<br/><br/>For each day, the value '1' indicates that the policy is valid for that day, and the value '0' indicates that it is not valid. The value X'80 00 00 01 00 00 00 00', for example, indicates that a PolicyRule is valid on the first and last days of the month.<br/><br/>For months with fewer than 31 days, the digits corresponding to days that the months do not have (counting in both directions) are ignored.<br/><br/>The encoding of the 62 significant bits in the octet string matches that used for the schedDay object in the DISMAN-SCHEDULE-MIB.<br/><br/>If this attribute is not specified, then the PolicyRule is treated as valid for all days in the months specified by the timePeriod attribute.<br/>
dayOfWeekMask Public String
Notes: This is a string attribute that refines the definition of the valid time period that is defined by the timePeriod attribute. This is done by explicitly specifying the days of the week when the PolicyRule is valid. These attributes work together, with the timePeriod attribute used to specify the overall time period when the policy might be valid, and the DayOfWeekMask used to pick out the specific days of the week in that time period when the PolicyRule is valid.<br/><br/><br/><br/>This property is formatted as a fixed length string of 8 bits. The first 7 bits identify the 7 days of the week, beginning with Sunday and ending with Saturday, followed by 1 bit that is always set to '0'. For each day of the week, the value '1' indicates that the PolicyRule is valid for that day, and the value '0' indicates that it is not valid.<br/><br/><br/><br/>If this attribute is not specified, then the PolicyRule is treated as valid for all 7 days in the weeks specified by the timePeriod attribute.<br/><br/><br/><br/>Notes: Not present in the ITU specs. The CIM defines a similar attribute called DayOfWeekMask.<br/>
isLocalTime Public Boolean
Notes: This is a Boolean attribute that, if TRUE, signifies that the times represented in the timePeriod attribute and in the various Mask attributes represent local times. If the value of this attribute is FALSE, then this means that the times represented in the timePeriod attribute and in the various Mask attributes represent UTC times.<br/><br/><br/><br/>There is no provision for mixing of local times and UTC times: the value of this attribute applies to all of the other time-related attributes.<br/><br/><br/><br/>Notes: Not present in the ITU specs. The CIM defines a similar attribute called LocalOrUtcTime.<br/>
monthOfYearMask Public String
Notes: The monthOfYearMask attribute is a string that refines the definition of the valid time period that is defined by the timePeriod attribute. This is done by explicitly specifying the months when the policy is valid. Thus, the timePeriod attribute is used to specify the overall time period during which the policy might be valid, and the monthOfYearMask attribute is used to pick out the specific months within that time period when the PolicyRule is valid. This attribute consists of a fixed string of 16 bits. The first 12 bits correspond to the 12 months of the year, beginning with January and ending with December. The last 4 bits are always set to "0". For each month, the value "1" indicates that the policy is valid for that month, and the value "0" indicates that it is not valid.<br/><br/><br/><br/>If this attribute is not specified, then the PolicyRule is treated as valid for all twelve months.<br/><br/><br/><br/>Notes: Not present in the ITU specs. The CIM defines a similar attribute called MonthOfYearMask.<br/>
timeOfDayMask Public String
Notes: This is a string attribute that refines the definition of the valid time period that is defined by the timePeriod attribute. This is done by explicitly specifying a range of times in a day the PolicyRule is valid for. These attributes work together, with the timePeriod attribute used to specify the overall time period that the PolicyRule is valid for, and the timeOfDayMask attribute used to pick out which range of time periods in a given day of that time period the PolicyRule is valid for.<br/><br/>This attribute is formatted in the style of RFC 2445: a time string beginning with the character 'T', followed by the solidus character ('/'), followed by a second time string. The first time indicates the beginning of the range, while the second time indicates the end. Times are expressed as substrings of the form "Thhmmss".<br/><br/>The second substring always identifies a later time than the first substring. To allow for ranges that span midnight, however, the value of the second string may be smaller than the value of the first substring. Thus, "T080000/T210000" identifies the range from 0800 until 2100, while "T210000/T080000" identifies the range from 2100 until 0800 of the following day.<br/><br/>When a range spans midnight, it by definition includes parts of two<br/>successive days. When one of these days is also selected by either the monthOfYearMask, dayOfMonthMask, and/or dayOfWeekMask, but the other day is not, then the policy is active only during the portion of the range that falls on the selected day. For example, if the range extends from 2100 until 0800, and the day of week mask selects Monday and Tuesday, then the policy is active during the following three intervals:<br/><br/> From midnight Sunday until 0800 Monday;<br/> From 2100 Monday until 0800 Tuesday;<br/> From 2100 Tuesday until 23:59:59 Tuesday.<br/><br/>If this attribute is not specified, then the PolicyRule is treated as valid for the entire day, for all days specified by the timePeriod attribute.<br/>
timePeriod Public String
Notes: This is a string attribute that defines an overall range of calendar dates and times over which a PolicyRule is valid. As such, this is the most basic way to use date and/or time to enable or disable a given PolicyRule.<br/><br/>Date/times are expressed as substrings of the form:<br/><br/>"yyyymmddThhmmss".<br/><br/><br/><br/><br/><br/>This attribute is based on time as defined in RFC 2445. This calls for a string to represent a starting date and time, in which the character 'T' indicates the beginning of the time portion, followed by the solidus character ('/'), followed by a similar string representing an end date and time. The first date indicates the beginning of the range, while the second date indicates the end. The second date and time must be later than the first.<br/><br/><br/><br/><br/><br/>For example:<br/><br/><br/><br/> 20000101T080000/20000131T120000<br/><br/><br/><br/>is interpreted as:<br/><br/> January 1, 2000, 0800 through January 31, 2000, noon<br/><br/><br/><br/>There are also two special cases in which one of the date/time strings is replaced with a special string defined in RFC 2445. <br/><br/><br/><br/> - If the first date/time is replaced with the string "THISANDPRIOR", then the property indicates that a policy rule is valid, from now until the date/time that appears after the '/'.<br/><br/><br/><br/> - If the second date/time is replaced with the string "THISANDFUTURE", then the property indicates that a policy rule becomes valid on the date/time that appears before the '/', and remains valid from that point on.<br/><br/><br/><br/>Notes: Not present in the ITU specs. The CIM defines a similar attribute called TimePeriod.<br/>
Element Source Role Target Role
«TMF_ABE» Policy Variable ABE
ABE «TMF_ABEIsComposedByEntity»
Name:  
 
Name:  
 
Details:
 
Tag Value
IsCoreEntity False
Details:
Values: true,false
Default: False
rsa_guid _3E3F0EC000E93E04FB7901BF
Details:  
Property Value
isActive: 0
isFinalSpecialization: 0
Object Type Connection Direction Notes
«TMF_BusinessEntity» VariableStandard Business Entity Generalization To