1 tony  1.1 // ===================================================================
  2           // Title:       System Help 2.8
  3           // Filename:    System28_Help.mof
  4           // Version:     2.8
  5           // Release:     Preliminary
  6           // Date:        08/18/2003
  7           // ===================================================================
  8           // Copyright 1998-2003 Distributed Management Task Force, Inc. (DMTF).
  9           // All rights reserved.
 10           // DMTF is a not-for-profit association of industry members dedicated
 11           // to promoting enterprise and systems management and interoperability.
 12           // DMTF specifications and documents may be reproduced for uses
 13           // consistent with this purpose by members and non-members,
 14           // provided that correct attribution is given. 225
 15           // As DMTF specifications may be revised from time to time,
 16           // the particular version and release date should always be noted.
 17           // 
 18           // Implementation of certain elements of this standard or proposed
 19           // standard may be subject to third party patent rights, including
 20           // provisional patent rights (herein "patent rights"). DMTF makes
 21           // no representations to users of the standard as to the existence
 22 tony  1.1 // of such rights, and is not responsible to recognize, disclose, or
 23           // identify any or all such third party patent right, owners or
 24           // claimants, nor for any incomplete or inaccurate identification or
 25           // disclosure of such rights, owners or claimants. DMTF shall have no
 26           // liability to any party, in any manner or circumstance, under any
 27           // legal theory whatsoever, for failure to recognize, disclose, or
 28           // identify any such third party patent rights, or for such party's
 29           // reliance on the standard or incorporation thereof in its product,
 30           // protocols or testing procedures. DMTF shall have no liability to
 31           // any party implementing such standard, whether such implementation
 32           // is foreseeable or not, nor to any patent owner or claimant, and shall
 33           // have no liability or responsibility for costs or losses incurred if
 34           // a standard is withdrawn or modified after publication, and shall be
 35           // indemnified and held harmless by any party implementing the
 36           // standard from any and all claims of infringement by a patent owner
 37           // for such implementations.
 38           // 
 39           // For information about patents held by third-parties which have
 40           // notified the DMTF that, in their opinion, such patent may relate to
 41           // or impact implementations of DMTF standards, visit
 42           // http://www.dmtf.org/about/policies/disclosures.php.
 43 tony  1.1 // ===================================================================
 44           // Description: The Core Model defines basic management concepts.
 45           //              This file defines the concepts for a Help Service
 46           // 
 47           //              The object classes below are listed in an order that
 48           //              avoids forward references. Required objects, defined
 49           //              by other working groups, are omitted.
 50           // ==================================================================
 51           // Change Log for v2.8 Preliminary
 52           // CR1092  - Move HelpService to new Core28_Help from
 53           //           System28_Diagnostics
 54           // ==================================================================
 55           
 56           #pragma locale ("en_US")
 57           // ==================================================================
 58           //    HelpService
 59           // ==================================================================
 60              [Experimental, Version ( "2.7.1000" ), Description (
 61                  "HelpService provides the ability for a managed element to "
 62                  "describe and provide access to its Help information. Support "
 63                  "for various delivery mechanisms and data formats can be "
 64 tony  1.1        "specified so that the most suitable data representation can be "
 65                  "chosen. In adddition, a request can be made to launch a "
 66                  "\"Help\" program, if available.")]
 67           class CIM_HelpService : CIM_Service {
 68           
 69                 [Description (
 70                     "Defines the delivery methods supported by this help "
 71                     "service./n \"File Contents\" indicates that the contents of "
 72                     "the Help file is returned by the GetHelp method. \n"
 73                     "\"File Pointer\" indicates that a fully specified path to "
 74                     "the Help file is returned by the GetHelp method. \n"
 75                     "\"Associated File\" indicates that associations to "
 76                     "CIM_LogicalFile instance(s) is available. \n"
 77                     "\"URL\" indicates that a URL to a website is returned by "
 78                     "the GetHelp method. \n"
 79                     "\"Program\" indicates that a Help program is launched (on "
 80                     "the local system) by the GetHelp method."), 
 81                  ValueMap { "1", "2", "3", "4", "5", "6" }, 
 82                  Values { "Other", "File Contents", "File Pointer",
 83                     "Associated File", "URL", "Program" }, 
 84                  ModelCorrespondence { 
 85 tony  1.1           "CIM_HelpService.OtherDeliveryOptionDescription",
 86                     "CIM_HelpServiceAvailableToFile" }]
 87              uint16 DeliveryOptions[];
 88           
 89                 [Description (
 90                     "Describes the nature of the delivery method when "
 91                     "DeliveryOptions = \"Other\" is specified."), 
 92                  ModelCorrespondence { "CIM_HelpService.DeliveryOptions" }]
 93              string OtherDeliveryOptionDescription;
 94           
 95                 [Description (
 96                     "List of all of the document names/ids that are available "
 97                     "via this help service and NOT exposed by the "
 98                     "HelpServiceAvailableToFile association."), 
 99                  ArrayType ( "Indexed" ), 
100                  ModelCorrespondence { "CIM_HelpService.DocumentDescriptions",
101                     "CIM_HelpService.DocumentFormats" }]
102              string DocumentsAvailable[];
103           
104                 [Description (
105                     "List of descriptions for the corresponding documents."), 
106 tony  1.1        ArrayType ( "Indexed" ), 
107                  ModelCorrespondence { "CIM_HelpService.DocumentsAvailable",
108                     "CIM_HelpService.DocumentFormats" }]
109              string DocumentDescriptions[];
110           
111                 [Description (
112                     "List of document formats for the corresponding documents."), 
113                  ValueMap { "0", "1", "2", "3", "4", "5", "6" }, 
114                  Values { "Unknown", "Other", "XML", "HTML", "Binary",
115                     "Executable", ".hlp" }, ArrayType ( "Indexed" ), 
116                  ModelCorrespondence { 
117                     "CIM_HelpService.OtherDocumentFormatDescription",
118                     "CIM_HelpService.DocumentDescriptions",
119                     "CIM_HelpService.DocumentsAvailable" }]
120              uint16 DocumentFormat[];
121           
122                 [Description (
123                     "Describes the format of the document when DocumentFormat= "
124                     "\"Other\" is specified."), 
125                  ModelCorrespondence { "CIM_HelpService.DocumentFormat" }]
126              string OtherDocumentFormatDescription;
127 tony  1.1 
128                 [Description (
129                     "The GetHelp method produces, as an OUT parameter, a string "
130                     "containing document information as specified by the input "
131                     "parameters. The input parameters are expected to be valid "
132                     "sets of values from the corresponding indexed properties of "
133                     "this class."), 
134                  ValueMap { "0", "1", "2", "3", "4", "5", "..", "0x1000",
135                     "0x1001", "0x1002..0x7FFF", "0x8000..0xFFFF" }, 
136                  Values { "Document returned with no error", "Not Supported",
137                     "Unspecified Error", "Timeout", "Failed",
138                     "Invalid Parameter", "DMTF Reserved", "Busy",
139                     "Requested Document not found", "Method Reserved",
140                     "Vendor Reserved" }]
141              uint32 GetHelp(
142                 
143                    [IN, Description (
144                        "The name/id of the requested document or the reference "
145                        "to the associated document."), 
146                     ModelCorrespondence { "CIM_HelpService.DocumentsAvailable",
147                        "CIM_HelpServiceAvailableToFile.UserOfService" }]
148 tony  1.1       string RequestedDocument,
149                 
150                    [IN, OUT, Description (
151                        "The requested document format is passed in. The actual "
152                        "document format is returned."), 
153                     ValueMap { "0", "1", "2", "3", "4", "5", "6" }, 
154                     Values { "Don't Care", "Other", "XML", "HTML", "Binary",
155                        "Executable", ".hlp" }, 
156                     ModelCorrespondence { "CIM_HelpService.DocumentFormat" }]
157                 uint16 Format,
158                 
159                    [IN, Description (
160                        "The requested delivery mechanism."), 
161                     ValueMap { "1", "2", "3", "5", "6" }, 
162                     Values { "Other", "File Contents", "File Pointer", "URL",
163                        "Program" }, 
164                     ModelCorrespondence { "CIM_HelpService.DeliveryOptions" }]
165                 uint16 RequestedDelivery,
166                 
167                    [IN ( false ), OUT, Description (
168                        "If RequestedDelivery = \n"
169 tony  1.1              "File Contents, then the string contains the contents. \n"
170                        "File Pointer, then the string contains a pointer to the "
171                        "file. \n"
172                        "File Reference, then the string contains a REF to a "
173                        "CIM_LogicalFile instance. \n"
174                        "URL, then then the string contains a URL to the help "
175                        "site. \n"
176                        "Program, then the string is empty; the program was "
177                        "launched.")]
178                 string DocumentInfo ); 
179           };
180           
181           
182           // ==================================================================
183           // HelpServiceAvailableToFile
184           // ==================================================================
185              [Association, Experimental, Version ( "2.7.1000" ), Description (
186                  "CIM_HelpServiceAvailableToFile indicates that the service is "
187                  "available for accessing the help file.")]
188           class CIM_HelpServiceAvailableToFile : CIM_ServiceAvailableToElement {
189           
190 tony  1.1       [Override ( "ServiceProvided" ), Description (
191                     "The Service that is available.")]
192              CIM_HelpService REF ServiceProvided;
193           
194                 [Override ( "UserOfService" ), Description (
195                     "The file that make use of this Service.")]
196              CIM_LogicalFile REF UserOfService;
197           
198                 [Description (
199                     "Document format for the associated file."), 
200                  ValueMap { "0", "1", "2", "3", "4", "5", "6" }, 
201                  Values { "Unknown", "Other", "XML", "HTML", "Binary",
202                     "Executable", ".hlp" }, 
203                  ModelCorrespondence { 
204                     "CIM_HelpServiceAvailableToFile.OtherDocumentFormatDescription" 
205                     }]
206              uint16 DocumentFormat;
207           
208                 [Description (
209                     "Describes the format of the file when DocumentFormat= "
210                     "\"Other\" is specified."), 
211 tony  1.1        ModelCorrespondence { 
212                     "CIM_HelpServiceAvailableToFile.DocumentFormat" }]
213              string OtherDocumentFormatDescription;
214           };
215           
216           
217           // ===================================================================
218           // end of file
219           // ===================================================================