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.\n"
81 ""),
82 ValueMap {"1", "2", "3", "4", "5", "6"},
83 Values {"Other", "File Contents", "File Pointer",
84 "Associated File", "URL", "Program"},
85 tony 1.1 ModelCorrespondence {
86 "CIM_HelpService.OtherDeliveryOptionDescription",
87 "CIM_HelpServiceAvailableToFile"} ]
88 uint16 DeliveryOptions[];
89
90 [Description (
91 "Describes the nature of the delivery method when "
92 "DeliveryOptions = \"Other\" is specified."),
93 ModelCorrespondence {"CIM_HelpService.DeliveryOptions"} ]
94 string OtherDeliveryOptionDescription;
95
96 [Description (
97 "List of all of the document names/ids that are available "
98 "via this help service and NOT exposed by the "
99 "HelpServiceAvailableToFile association."),
100 ArrayType ("Indexed"),
101 ModelCorrespondence {"CIM_HelpService.DocumentDescriptions",
102 "CIM_HelpService.DocumentFormats"} ]
103 string DocumentsAvailable[];
104
105 [Description (
106 tony 1.1 "List of descriptions for the corresponding documents."),
107 ArrayType ("Indexed"),
108 ModelCorrespondence {"CIM_HelpService.DocumentsAvailable",
109 "CIM_HelpService.DocumentFormats"} ]
110 string DocumentDescriptions[];
111
112 [Description (
113 "List of document formats for the corresponding documents."),
114 ValueMap {"0", "1", "2", "3", "4", "5", "6"},
115 Values {"Unknown", "Other", "XML", "HTML", "Binary",
116 "Executable", ".hlp"},
117 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 tony 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("The name/id of the requested document or "
146 "the reference to the associated document."),
147 ModelCorrespondence {"CIM_HelpService.DocumentsAvailable",
148 tony 1.1 "CIM_HelpServiceAvailableToFile.UserOfService"}]
149 string RequestedDocument,
150
151 [IN, OUT, Description("The requested document format is passed "
152 "in. The actual 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("The requested delivery mechanism."),
160 ValueMap {"1", "2", "3", "5", "6"},
161 Values {"Other", "File Contents", "File Pointer",
162 "URL", "Program"},
163 ModelCorrespondence {"CIM_HelpService.DeliveryOptions"}]
164 uint16 RequestedDelivery,
165
166 [OUT, IN(false), Description(
167 "If RequestedDelivery =\n"
168 " File Contents, then the string contains the contents.\n"
169 tony 1.1 " File Pointer, then the string contains a pointer to the "
170 "file.\n"
171 " File Reference, then the string contains a REF to a "
172 "CIM_LogicalFile instance.\n"
173 " URL, then then the string contains a URL to the help "
174 "site.\n"
175 " Program, then the string is empty; the program was "
176 "launched.")]
177 string DocumentInfo
178 );
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 uint16 DocumentFormat;
206
207 [Description (
208 "Describes the format of the file when DocumentFormat= "
209 "\"Other\" is specified."),
210 ModelCorrespondence {
211 tony 1.1 "CIM_HelpServiceAvailableToFile.DocumentFormat"} ]
212 string OtherDocumentFormatDescription;
213 };
214
215
216 // ===================================================================
217 // end of file
218 // ===================================================================
|
Return to
System28_Help.mof
CVS log
Up to [Pegasus] / pegasus / Schemas / CIMPrelim28