1 karl  1.1.2.2 // Copyright (c) 2005 DMTF.  All rights reserved.
  2               // <change cr="SysDevCR00722.000" type ="change">Update of
  3               // descriptions based on Tech Edit review.</
  4               // <change cr="ArchCR00066.004" type="add">Add UmlPackagePath
  5               // qualifier values to CIM Schema.</change>
  6               // <change cr="CIMCoreCR00867" type="add">Update class
  7               // description.</change>
  8               // ==================================================================
  9               //  CIM_Service
 10               // ==================================================================
 11                  [Abstract, Version ( "2.14.0" ), 
 12                   UMLPackagePath ( "CIM::Core::Service" ), 
 13                   Description ( 
 14                      "A Service is a LogicalElement that represents the availability "
 15                      "of functionality that can be managed. This functionality may "
 16                      "be provided by a seperately modeled entity such as a "
 17                      "LogicalDevice or a SoftwareFeature, or both. The modeled "
 18                      "Service typically provides only functionality required for "
 19                      "management of itself or the elements it affects." )]
 20               class CIM_Service : CIM_EnabledLogicalElement {
 21               
 22 karl  1.1.2.2       [Key, Description ( 
 23                         "The CreationClassName of the scoping System." ), 
 24                      MaxLen ( 256 ), 
 25                      Propagated ( "CIM_System.CreationClassName" )]
 26                  string SystemCreationClassName;
 27               
 28                     [Key, Description ( "The Name of the scoping System." ), 
 29                      MaxLen ( 256 ), 
 30                      Propagated ( "CIM_System.Name" )]
 31                  string SystemName;
 32               
 33                     [Key, Description ( 
 34                         "CreationClassName indicates the name of the class or the "
 35                         "subclass that is used in the creation of an instance. "
 36                         "When used with the other key properties of this class, "
 37                         "this property allows all instances of this class and its "
 38                         "subclasses to be uniquely identified." ), 
 39                      MaxLen ( 256 )]
 40                  string CreationClassName;
 41               
 42                     [Key, Override ( "Name" ), 
 43 karl  1.1.2.2        Description ( 
 44                         "The Name property uniquely identifies the Service and "
 45                         "provides an indication of the functionality that is "
 46                         "managed. This functionality is described in more detail "
 47                         "in the Description property of the object." ), 
 48                      MaxLen ( 256 )]
 49                  string Name;
 50               
 51                     [Write, Description ( 
 52                         "The name of the primary owner for the service, if one is "
 53                         "defined. The primary owner is the initial support "
 54                         "contact for the Service." ), 
 55                      MaxLen ( 64 ), 
 56                      MappingStrings { "MIF.DMTF|General Information|001.3" }]
 57                  string PrimaryOwnerName;
 58               
 59                     [Write, Description ( 
 60                         "A string that provides information on how the primary "
 61                         "owner of the Service can be reached (for example, phone "
 62                         "number, e-mail address, and so on)." ), 
 63                      MaxLen ( 256 ), 
 64 karl  1.1.2.2        MappingStrings { "MIF.DMTF|General Information|001.4" }]
 65                  string PrimaryOwnerContact;
 66               
 67                     [Deprecated { "CIM_Service.EnabledDefault" }, 
 68                      Description ( 
 69                         "Note: The use of this element is deprecated in lieu of "
 70                         "the EnabledDefault property that is inherited from "
 71                         "EnabledLogicalElement. The EnabledLogicalElement "
 72                         "addresses the same semantics. The change to a uint16 "
 73                         "data type was discussed when CIM V2.0 was defined. "
 74                         "However, existing V1.0 implementations used the string "
 75                         "property. To remain compatible with those "
 76                         "implementations, StartMode was grandfathered into the "
 77                         "schema. Use of the deprecated qualifier allows the "
 78                         "maintenance of the existing property but also permits an "
 79                         "improved, clarified definition using EnabledDefault. \n"
 80                         "Deprecated description: StartMode is a string value that "
 81                         "indicates whether the Service is automatically started "
 82                         "by a System, an Operating System, and so on, or is "
 83                         "started only upon request." ), 
 84                      ValueMap { "Automatic", "Manual" }, 
 85 karl  1.1.2.2        MaxLen ( 10 )]
 86                  string StartMode;
 87               
 88                     [Description ( 
 89                         "Started is a Boolean that indicates whether the Service "
 90                         "has been started (TRUE), or stopped (FALSE)." )]
 91                  boolean Started;
 92               
 93               
 94                     [Description ( 
 95                         "The StartService method places the Service in the "
 96                         "started state. Note that the function of this method "
 97                         "overlaps with the RequestedState property. "
 98                         "RequestedState was added to the model to maintain a "
 99                         "record (such as a persisted value) of the last state "
100                         "request. Invoking the StartService method should set the "
101                         "RequestedState property appropriately. The method "
102                         "returns an integer value of 0 if the Service was "
103                         "successfully started, 1 if the request is not supported, "
104                         "and any other number to indicate an error. In a "
105                         "subclass, the set of possible return codes could be "
106 karl  1.1.2.2           "specified using a ValueMap qualifier on the method. The "
107                         "strings to which the ValueMap contents are translated "
108                         "can also be specified in the subclass as a Values array "
109                         "qualifier. \n"
110                         "\n"
111                         "Note: The semantics of this method overlap with the "
112                         "RequestStateChange method that is inherited from "
113                         "EnabledLogicalElement. This method is maintained because "
114                         "it has been widely implemented, and its simple \"start\" "
115                         "semantics are convenient to use." )]
116                  uint32 StartService(
117               );
118               
119                     [Description ( 
120                         "The StopService method places the Service in the stopped "
121                         "state. Note that the function of this method overlaps "
122                         "with the RequestedState property. RequestedState was "
123                         "added to the model to maintain a record (such as a "
124                         "persisted value) of the last state request. Invoking the "
125                         "StopService method should set the RequestedState "
126                         "property appropriately. The method returns an integer "
127 karl  1.1.2.2           "value of 0 if the Service was successfully stopped, 1 if "
128                         "the request is not supported, and any other number to "
129                         "indicate an error. In a subclass, the set of possible "
130                         "return codes could be specified using a ValueMap "
131                         "qualifier on the method. The strings to which the "
132                         "ValueMap contents are translated can also be specified "
133                         "in the subclass as a Values array qualifier. \n"
134                         "\n"
135                         "Note: The semantics of this method overlap with the "
136                         "RequestStateChange method that is inherited from "
137                         "EnabledLogicalElement. This method is maintained because "
138                         "it has been widely implemented, and its simple \"stop\" "
139                         "semantics are convenient to use." )]
140                  uint32 StopService(
141               );
142               
143               };