SUMMARY: NESTED | FIELD | | METHOD
DETAIL: FIELD | METHOD

Class IPS_AlarmClockOccurrence

CIM_ManagedElement
   extended by IPS_AlarmClockOccurrence


class IPS_AlarmClockOccurrence
 extends CIM_ManagedElement


General Information:
IPS_AlarmClockOccurrence represents a single 
alarm clock setting. An instance of this class is created by calling 
AMT_AlarmClockService.AddAlarm method. 


Qualifiers:
-------------
Version=8.0.0









  
  

    Supported Fields 
      Summary

  

     string 
      
    ElementName 
A 
      user-friendly name for the object . . .

  

     string 
      
    InstanceID Key  
The instance key, set by the caller of 
      AMT_AlarmClockService.AddAlarm.

  

     datetime 
      
    StartTime 
The next 
      time when the alarm is scheduled to be set.

  

     datetime 
      
    Interval 
The interval 
      between occurrences of the alarm (0 if the alarm is scheduled to run 
      once).

  

     boolean 
      
    DeleteOnCompletion 
      
if set to TRUE, the instance will be deleted by the FW when the 
      alarm is completed . . .




  
  

    Methods Summary

  

     
    Put(Instance) 
Changes 
      properties of the selected instance

  

     
    Get(Instance) 
Gets the 
      representation of the instance

  

     
    Delete() 
Deletes an 
      instance

  

     
    Pull(EnumerationContext, 
      MaxElements) 
Pulls instances of this class, following an 
      Enumerate operation

  

     
    Enumerate() 
      
Enumerates the instances of this class

  

     
    Release(EnumerationContext) 
      
Releases an enumeration context




  
  

    Field 
Detail


ElementName 
public string ElementName



  
General Information:
A user-friendly name for the object. This 
  property allows each instance to define a user-friendly name in addition to 
  its key properties, identity data, and description information. 
Note that 
  the Name property of ManagedSystemElement is also defined as a user-friendly 
  name. But, it is often subclassed to be a Key. It is not reasonable that the 
  same property can convey both identity and a user-friendly name, without 
  inconsistencies. Where Name exists and is not a Key (such as for instances of 
  LogicalDevice), the same information can be present in both the Name and 
  ElementName properties. Note that if there is an associated instance of 
  CIM_EnabledLogicalElementCapabilities, restrictions on this properties may 
  exist as defined in ElementNameMask and MaxElementNameLen properties defined 
  in that 
class.

Qualifiers:
-------------
MaxLen=256


  

  





InstanceID Key 
public string InstanceID



  
General Information:
The instance key, set by the caller of 
  AMT_AlarmClockService.AddAlarm.

Product Specific 
  Usage:
InstanceID is determined by the user. Its maximum length is 32 
  characters.

Qualifiers:
-------------
key
MaxLen=32


  

  





StartTime 
public datetime StartTime



  
General Information:
The next time when the alarm is scheduled 
  to be set.

  

  





Interval 
public datetime Interval



  
General Information:
The interval between occurrences of the 
  alarm (0 if the alarm is scheduled to run once).

  

  





DeleteOnCompletion 
public boolean DeleteOnCompletion



  
General Information:
if set to TRUE, the instance will be 
  deleted by the FW when the alarm is completed. Otherwise, the SW can delete 
  the instance using the Delete() method.

  

  






  
  

    Method 
Detail


Put
public  Put([IN]IPS_AlarmClockOccurrence Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_REMOTE_CONTROL_REALM, 
  ADMIN_SECURITY_LOCAL_SYSTEM_REALM

General 
  Information:
Changes properties of the selected 
  instance

Product Specific Usage:
The following properties 
  must be included in any representation of IPS_AlarmClockOccurrence: 
  

InstanceID 






Get
public  Get([OUT]IPS_AlarmClockOccurrence Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_REMOTE_CONTROL_REALM, ADMIN_SECURITY_LOCAL_SYSTEM_REALM, 
  ADMIN_SECURITY_GENERAL_INFO_REALM

General Information:
Gets 
  the representation of the instance





Delete
public  Delete()



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_REMOTE_CONTROL_REALM, 
  ADMIN_SECURITY_LOCAL_SYSTEM_REALM

General 
  Information:
Deletes an instance





Pull
public  Pull([IN]String EnumerationContext, [IN]String MaxElements)



  
Permission Information:
All users permitted to use method, only 
  instances to whom the user has permissions will be returned

General 
  Information:
Pulls instances of this class, following an Enumerate 
  operation





Enumerate
public  Enumerate()



  
Permission Information:
All users permitted to use 
  method

General Information:
Enumerates the instances of this 
  class





Release
public  Release([IN]String EnumerationContext)



  
Permission Information:
All users permitted to use 
  method

General Information:
Releases an enumeration 
  context






  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

    
      
Copyright © 2006-2022, Intel 
      Corporation. All rights 
reserved.