Objects::EventStatus

Header Image
Project:
EventStatus : Public Class
Created: 3/3/2010 9:15:31 AM
Modified: 1/31/2013 9:31:06 AM
Project:
Advanced:
Current status information relevant to a specific object. The Status object is used to indicate the current status of an Event. Devices can read the containing resource (e.g. TextMessage) to get the most up to date status of the event.  Devices can also subscribe to a specific resource instance to get updates when any of its attributes change, including the Status object. <br/>
  • Attributes
  • Associations From
  • Advanced
Attribute Scope Type
currentStatus Public UInt8
Notes: Field representing the current status type. <br/><br/>0 = Scheduled<br/>This status indicates that the event has been scheduled and the event has not yet started.  The server SHALL set the event to this status when the event is first scheduled and persist until the event has become active or has been cancelled.  For events with a start time less than or equal to the current time, this status SHALL never be indicated, the event SHALL start with a status of “Active”. <br/><br/>1 = Active<br/>This status indicates that the event is currently active, even if the event is known to be overlapped. The server SHALL set the event to this status when the event reaches its earliest Effective Start Time.<br/><br/>2 = Cancelled <br/>When events are cancelled, the Status.dateTime attribute SHALL be set to the time the cancellation occurred, which cannot be in the future.  The server is responsible for maintaining the cancelled event in its collection for the duration of the original event, or until the server has run out of space and needs to store a new event. Client devices SHALL be aware of Cancelled events, determine if the Cancelled event applies to them, and cancel the event immediately if applicable.<br/><br/>3 = Cancelled with Randomization <br/>The server is responsible for maintaining the cancelled event in its collection for the duration of the Effective Scheduled Period. Client devices SHALL be aware of Cancelled with Randomization events, determine if the Cancelled event applies to them, and cancel the event immediately, using the larger of (absolute value of randomizeStart) and (absolute value of randomizeDuration) as the end randomization, in seconds. This Status.type SHALL NOT be used with "regular" Events, only with specializations of RandomizableEvent.<br/><br/>4 = Superseded (DEPRECATED)<br/>SHALL NOT be used by servers, but clients should note that it may be used by servers compliant with previous revisions of IEEE 2030.5.<br/><br/>5 = Completed<br/>This status indicates that the event has completed. The server SHALL set the event to this status after the event's maximum Effective Scheduled Period if the event has not been cancelled and is still present on the server. Note that this status value was not present in revisions prior to IEEE 2030.5-2023.<br/><br/>All other values reserved.<br/>
dateTime Public TimeType
Notes: The dateTime attribute will provide a timestamp of when the current status was defined. dateTime SHALL be set to the time at which the status change occurred, not a time in the future or past. <br/>
potentiallySuperseded Public boolean
Notes: DEPRECATED<br/>SHALL be set to true.<br/>
potentiallySupersededTime Public TimeType
Notes: DEPRECATED<br/>SHALL NOT be included by servers, but clients should note that it may be included by servers compliant with previous revisions of IEEE 2030.5.<br/>
reason Public String192
Notes: The Reason attribute allows a Service provider to provide a textual explanation of the status. <br/>
Element Source Role Target Role
Event
Class  
Name:  
 
Name:  
 
Details:
 
Property Value
isFinalSpecialization: 0