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